ALIYUN::GraphDatabase::DbInstance - Resource Orchestration Service

ALIYUN::GraphDatabase::DbInstance is used to create a Graph Database (GDB) instance.

Syntax

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

Properties

Property	Type	Required	Editable	Description	Constraint
ZoneId	String	No	No	The zone ID of the instance.	None
ResourceGroupId	String	No	Yes	The ID of the resource group to which the instance belongs.	None
DbInstanceNetworkType	String	Yes	No	The network type of the database.	Set the value to VPC.
`VSwitchId`	String	No	No	The ID of the vSwitch to which you want to connect the instance.	None
EcsSecurityGroupRelations	List	No	No	The security groups.	For more information, see EcsSecurityGroupRelations properties.
DbInstanceStorageType	String	Yes	No	The storage type of the database.	Valid values: cloud_essd: enhanced SSD (ESSD) cloud_ssd: standard SSD
DbNodeStorage	Integer	Yes	Yes	The storage capacity of the instance.	None
BackupSetId	String	No	No	The ID of the database backup set.	None
DbInstanceCategory	String	Yes	No	The type of the database.	Set the value to ha. You can create only database instances of the High-availability Edition.
SourceDbInstanceId	String	No	No	The ID of the source instance.	None
VpcId	String	No	No	The ID of the virtual private cloud (VPC).	None
DBInstanceIPArray	List	No	Yes	The IP address whitelist of the database.	For more information, see DBInstanceIPArray properties.
DbVersion	String	Yes	No	The version of the database engine.	Valid values: 1.0 1.0-OpenCypher
CreateType	String	No	No	The method that you want to use to create the instance.	Valid values: CreateDBInstance CloneDBInstance CreateReadDBInstance
PaymentType	String	No	No	The billing method of the instance.	Valid values: PostPaid PrePaid
DbInstanceDescription	String	No	Yes	The description of the instance.	None
RestoreType	String	No	No	The restoration mode.	Set the value to backup.
DbNodeClass	String	Yes	Yes	The type of the database node.	None
MaintainTime	String	No	Yes	The maintenance window of the instance.	None
Tags	List	No	Yes	The custom tags.	For more information, see Tags properties.

EcsSecurityGroupRelations syntax

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

EcsSecurityGroupRelations properties

Property	Type	Required	Editable	Description	Constraint
NetworkType	String	No	No	The network type of the instance.	None
SecurityGroupId	String	Yes	Yes	The ID of the security group.	None
RegionId	String	No	No	The region ID of the instance.	None

null

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

DBInstanceIPArray properties

Property	Type	Required	Editable	Description	Constraint
SecurityIps	String	Yes	Yes	The IP address whitelists.	None
DbInstanceIpArrayName	String	No	No	The name of the IP address whitelist.	None

Tags syntax

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

Tags properties

Property	Type	Required	Editable	Description	Constraint
Value	String	No	No	The value of the tag.	The tag value must be 1 to 128 characters in length and cannot contain `http://` or `https://`. The tag value cannot start with `aliyun` or `acs:`.
Key	String	Yes	No	The key of the tag.	The tag key must be 1 to 128 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `aliyun` or `acs:`.

Return values

Fn::GetAtt

ResourceGroupId: the ID of the resource group.
DbInstanceNetworkType: the network type of the instance.
Port: the port that is used to access the instance.
DbInstanceType: the type of the instance.
DbInstanceStorageType: the storage type of the instance.
DbNodeStorage: the storage space of the database.
DbInstanceCategory: the edition of the instance.
DbVersion: the version of the database.
CurrentMinorVersion: the kernel version of the database.
PaymentType: the billing method of the instance.
PublicConnectionString: the prefix of the public endpoint that is used to access the instance.
DBInstanceId: the ID of the instance.
LockReason: the reason why the instance is locked.
DbNodeClass: the specifications of the node
MaintainTime: the maintenance window of the instance.
Tags: the tags that are added to the instance.
ZoneId: the zone ID of the instance.
VSwitchId: the vSwitch ID of the instance.
CreateTime: the time when the instance was created.
DbNodeCount: the number of nodes.
LatestMinorVersion: the latest kernel version that is supported by the instance.
Expired: the time when the instance expires.
EcsSecurityGroupRelations: the security groups.
LockMode: the lock mode of the instance.
DbInstanceMemory: the memory space of the instance.
ReadOnlyDbInstanceIds: the IDs of read-only instances.
VpcId: the VPC ID of the instance.
DBInstanceIPArray: the IP address whitelists.
DbInstanceDescription: the description of the instance.
DbInstanceCpu: the number of vCPUs of the instance.
ConnectionString: the endpoint that is used to connect to the database.
ExpireTime: the time when the database expires.
Port: the port that is used to connect to the database.

Examples

YAML format

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 format

{
  "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"
        ]
      }
    }
  }
}