ALIYUN::GraphDatabase::DbInstance - 资源编排

ALIYUN::GraphDatabase::DbInstance类型用于创建图数据库GDB实例。

语法

{
  "Type": "ALIYUN::GraphDatabase::DbInstance",
  "Properties": {
    "ZoneId": String,
    "ResourceGroupId": String,
    "DbInstanceNetworkType": String,
    "VSwitchId": String,
    "EcsSecurityGroupRelations": List,
    "DbInstanceStorageType": String,
    "DbNodeStorage": Integer,
    "BackupSetId": String,
    "DbInstanceCategory": String,
    "SourceDbInstanceId": String,
    "VpcId": String,
    "DBInstanceIPArray": List,
    "DbVersion": String,
    "CreateType": String,
    "PaymentType": String,
    "DbInstanceDescription": String,
    "RestoreType": String,
    "DbNodeClass": String,
    "MaintainTime": String,
    "Tags": List
  }
}

属性


属性名称	类型	必须	允许更新	描述	约束
ZoneId	String	否	否	可用区ID。	无
ResourceGroupId	String	否	是	资源组ID。	无
DbInstanceNetworkType	String	是	否	数据库网络类型。	取值：VPC。
VSwitchId	String	否	否	交换机ID。	无
EcsSecurityGroupRelations	List	否	否	绑定的安全组关系列表。	更多信息，请参见EcsSecurityGroupRelations属性。
DbInstanceStorageType	String	是	否	数据库存储类型。	取值： cloud_essd：ESSD云盘。 cloud_ssd：SSD云盘。
DbNodeStorage	Integer	是	是	实例的存储空间。	无
BackupSetId	String	否	否	数据库备份集ID。	无
DbInstanceCategory	String	是	否	数据库类别。	取值：ha，高可用版。
SourceDbInstanceId	String	否	否	源实例ID。	无
VpcId	String	否	否	专有网络ID。	无
DBInstanceIPArray	List	否	是	数据库白名单地址集。	更多信息，请参见DBInstanceIPArray属性。
DbVersion	String	是	否	数据库版本。	取值： 1.0 1.0-OpenCypher
CreateType	String	否	否	创建方式。	取值： CreateDBInstance CloneDBInstance CreateReadDBInstance
PaymentType	String	否	否	付费模式。	取值： PostPaid：按量付费。 PrePaid：包年包月。
DbInstanceDescription	String	否	是	描述信息。	无
RestoreType	String	否	否	恢复类型。	取值：backup。
DbNodeClass	String	是	是	数据库节点类型。	无
MaintainTime	String	否	是	数据库实例维护时间。	无
Tags	List	否	是	自定义标签。	更多信息，请参见Tags属性。

EcsSecurityGroupRelations语法

"EcsSecurityGroupRelations": [
  {
    "NetworkType": String,
    "SecurityGroupId": String,
    "RegionId": String
  }
]

EcsSecurityGroupRelations属性


属性名称	类型	必须	允许更新	描述	约束
NetworkType	String	否	否	网络类型。	无
SecurityGroupId	String	是	是	安全组ID。	无
RegionId	String	否	否	地域ID。	无

DBInstanceIPArray语法

"DBInstanceIPArray": [
  {
    "SecurityIps": String,
    "DbInstanceIpArrayName": String
  }
]

DBInstanceIPArray属性


属性名称	类型	必须	允许更新	描述	约束
SecurityIps	String	是	是	IP白名单组成的集合。	无
DbInstanceIpArrayName	String	否	否	IP白名单分组名称。	无

Tags语法

"Tags": [
  {
    "Value": String,
    "Key": String
  }
]

Tags属性


属性名称	类型	必须	允许更新	描述	约束
Value	String	否	否	标签值。	长度为1~128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://` 。
Key	String	是	否	标签键。	长度为1~128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://` 。

返回值

Fn::GetAtt

ResourceGroupId：资源组ID。
DbInstanceNetworkType：数据库实例网络类型。
Port：应用访问端口。
DbInstanceType：数据库实例类型。
DbInstanceStorageType：数据库实例存储类型。
DbNodeStorage：数据库存储空间。
DbInstanceCategory：数据库实例系列。
DbVersion：数据库版本。
CurrentMinorVersion：数据库内核版本。
PaymentType：付费类型。
PublicConnectionString：实例的公共连接地址。
DbInstanceId：实例ID。
LockReason：资源被锁定的原因。
DbNodeClass：节点规格。
MaintainTime：实例的可维护时间。
Tags：实例绑定的标签。
ZoneId：实例所属的可用区ID。
VSwitchId：实例所属的交换机ID。
CreateTime：实例的创建时间。
DbNodeCount：节点数量。
LatestMinorVersion：实例支持的最新内核版本。
Expired：实例过期时间。
EcsSecurityGroupRelations：绑定的安全组关系列表。
LockMode：实例锁定状态。
DbInstanceMemory：实例的内存空间。
ReadOnlyDbInstanceIds：只读实例ID列表。
VpcId：实例绑定的专有网络ID。
DBInstanceIPArray：IP白名单列表。
DbInstanceDescription：数据库实例描述。
DbInstanceCpu：实例CPU数量。
ConnectionString：数据库连接地址。
ExpireTime：数据库过期时间。
PublicPort：数据库连接端口。

示例

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  ExtensionResource:
    Type: ALIYUN::GraphDatabase::DbInstance
    Properties:
      DbInstanceNetworkType: VPC
      DbInstanceStorageType: cloud_essd
      DbNodeStorage: 100
      DbInstanceCategory: ha
      DbVersion: '1.0'
      PaymentType: PostPaid
      DbNodeClass: gdb.r.2xlarge
Outputs:
  DbInstanceId:
    Description: The first ID of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - DbInstanceId

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::GraphDatabase::DbInstance",
      "Properties": {
        "DbInstanceNetworkType": "VPC",
        "DbInstanceStorageType": "cloud_essd",
        "DbNodeStorage": 100,
        "DbInstanceCategory": "ha",
        "DbVersion": "1.0",
        "PaymentType": "PostPaid",
        "DbNodeClass": "gdb.r.2xlarge"
      }
    }
  },
  "Outputs": {
    "DbInstanceId": {
      "Description": "The first ID of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "DbInstanceId"
        ]
      }
    }
  }
}