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
  }
}

属性

属性名称类型必须允许更新描述约束
ZoneIdString可用区ID。
ResourceGroupIdString资源组ID。
DbInstanceNetworkTypeString数据库网络类型。取值:VPC。
VSwitchIdString交换机ID。
EcsSecurityGroupRelationsList绑定的安全组关系列表。更多信息,请参见EcsSecurityGroupRelations属性
DbInstanceStorageTypeString数据库存储类型。取值:
  • cloud_essd:ESSD云盘。
  • cloud_ssd:SSD云盘。
DbNodeStorageInteger实例的存储空间。
BackupSetIdString数据库备份集ID。
DbInstanceCategoryString数据库类别。取值:ha,高可用版。
SourceDbInstanceIdString源实例ID。
VpcIdString专有网络ID。
DBInstanceIPArrayList数据库白名单地址集。更多信息,请参见DBInstanceIPArray属性
DbVersionString数据库版本。取值:
  • 1.0
  • 1.0-OpenCypher
CreateTypeString创建方式。取值:
  • CreateDBInstance
  • CloneDBInstance
  • CreateReadDBInstance
PaymentTypeString付费模式。取值:
  • PostPaid:按量付费。
  • PrePaid:包年包月。
DbInstanceDescriptionString描述信息。
RestoreTypeString恢复类型。取值:backup。
DbNodeClassString数据库节点类型。
MaintainTimeString数据库实例维护时间。
TagsList自定义标签。更多信息,请参见Tags属性

EcsSecurityGroupRelations语法

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

EcsSecurityGroupRelations属性

属性名称类型必须允许更新描述约束
NetworkTypeString网络类型。
SecurityGroupIdString安全组ID。
RegionIdString地域ID。

DBInstanceIPArray语法

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

DBInstanceIPArray属性

属性名称类型必须允许更新描述约束
SecurityIpsStringIP白名单组成的集合。
DbInstanceIpArrayNameStringIP白名单分组名称。

Tags语法

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

Tags属性

属性名称类型必须允许更新描述约束
ValueString标签值。长度为1~128个字符,不能以aliyunacs:开头,不能包含http://或者https://
KeyString标签键。长度为1~128个字符,不能以aliyunacs:开头,不能包含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"
            ]
          }
        }
      }
    }