ALIYUN::GraphDatabase::DbInstance resource type - Resource Orchestration Service - Alibaba Cloud - Resource Orchestration Service

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.	None.
ResourceGroupId	String	No	Yes	The resource group ID.	None.
DbInstanceNetworkType	String	Yes	No	The network type of the instance.	Set the value to VPC.
VSwitchId	String	No	No	The vSwitch ID.	None.
EcsSecurityGroupRelations	List	No	No	The security groups to associate with the instance.	For more information, see EcsSecurityGroupRelations properties.
DbInstanceStorageType	String	Yes	No	The storage type of the instance.	Valid values: cloud_essd: Enterprise SSD (ESSD). cloud_ssd: standard SSD.
DbNodeStorage	Integer	Yes	Yes	The storage capacity of the instance.	None.
BackupSetId	String	No	No	The backup set ID.	None.
DbInstanceCategory	String	Yes	No	The instance edition.	Set the value to ha. A value of ha specifies Pro Edition.
SourceDbInstanceId	String	No	No	The source instance ID.	None.
VpcId	String	No	No	The virtual private cloud (VPC) ID.	None.
DBInstanceIPArray	List	No	Yes	The IP address whitelists of the instance.	For more information, see DBInstanceIPArray properties.
DbVersion	String	Yes	No	The engine version.	Valid values: 1.0 1.0-OpenCypher
CreateType	String	No	No	The method for creating the instance.	Valid values: CreateDBInstance CloneDBInstance CreateReadDBInstance
PaymentType	String	No	No	The billing method.	Valid values: PostPaid: pay-as-you-go. PrePaid: subscription.
DbInstanceDescription	String	No	Yes	The instance description.	None.
RestoreType	String	No	No	The restoration type.	Set the value to backup.
DbNodeClass	String	Yes	Yes	The node instance type.	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.	None.
SecurityGroupId	String	Yes	Yes	The security group ID.	None.
RegionId	String	No	No	The region ID.	None.

DBInstanceIPArray syntax

"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 tag value.	The value must be 1 to 128 characters in length, and cannot contain `http://` or `https://`. It cannot start with `aliyun` or `acs:`.
Key	String	Yes	No	The tag key.	The key must be 1 to 128 characters in length, and cannot contain `http://` or `https://`. It cannot start with `aliyun` or `acs:`.

Return values

Fn::GetAtt

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

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