ALIYUN::GPDB::ElasticDBInstance - 资源编排

ALIYUN::GPDB::ElasticDBInstance类型用于创建存储弹性模式的AnalyticDB for PostgreSQL实例。

语法

   {
  "Type": "ALIYUN::GPDB::ElasticDBInstance",
  "Properties": {    
    "EngineVersion": String,   
    "InstanceSpec": String,
    "ZoneId": String,
    "VSwitchId": String,
    "SegNodeNum": Integer,
    "SegStorageType": String,
    "StorageSize": Integer,
    "MasterNodeNum": Integer,
    "EncryptionType": String,
    "EncryptionKey": String,
    "VPCId": String,
    "SecurityIPList": String,
    "DBInstanceDescription": String,
    "PrivateIpAddress": String,
    "ZoneId": String,
    "Period": Integer, 
    "PayType": String,
    "DBInstanceCategory": String,
    "DBInstanceMode": String,
    "PeriodUnit": String,
    "Tags": List  
  }
}

属性

属性名称	类型	是否必填	允许更新	描述	约束
EngineVersion	String	是	否	引擎版本。	取值示例： 6.0：6.0标准版。 6.0x：6.0向量增强版。
InstanceSpec	String	是	否	实例规格。	取值： 2C16G。 4C32G。 16C128G。
ZoneId	String	是	否	可用区ID。	取值示例：cn-hangzhou-h。关于可用区ID的更多信息，请参见DescribeRegions - 查看可选的地域和可用区。
VSwitchId	String	是	否	交换机ID。	取值示例：vsw-bp183p93qs667muql****。
SegNodeNum	Integer	是	否	节点数量。	取值范围：4~512。
SegStorageType	String	是	否	节点磁盘类型。	取值：cloud_essd。
StorageSize	Integer	是	否	节点存储容量。	取值范围：50~4000。单位：GB。说明每50 GB递增。
MasterNodeNum	Integer	否	否	主节点数量。	取值范围：1~2。
EncryptionType	String	否	否	加密类型。	取值： NULL（默认值）：不加密。 CloudDisk：云盘加密。开启云盘加密后您需要通过EncryptionKey参数指定密钥。说明开启云盘加密后无法关闭。
EncryptionKey	String	否	否	加密密钥ID。	当EncryptionType取值为CloudDisk时，必须指定同地域的加密密钥ID（EncryptionKey）。否则，该参数为空。
VPCId	String	否	否	专有网络ID。	取值示例：vpc-bp1m6fww66xbntjyc****。
SecurityIPList	String	否	是	IP地址白名单。	默认值：127.0.0.1。
DBInstanceDescription	String	否	是	实例描述。	取值示例：AnalyticDB for PostgreSQL实例。长度不超过256个字符。
PrivateIpAddress	String	否	否	私有IP地址。	无
ZoneId	String	否	否	可用区ID。	无
InstanceChargeType	String	否	否	计费类型。	取值： Postpaid：按量付费。 Prepaid：包年包月。
Period	Integer	否	否	购买资源的时长单位。	当InstanceChargeType为包年包月时，该参数有效。取值： Month，取值为1 ~ 9或12,24,36,48,60。默认值为1。 Year，取值范围为1 ~ 3。默认值为1。
DBInstanceCategory	String	否	否	实例系列。	取值： HighAvailability：高可用版。 Basic：基础版。说明创建存储弹性模式实例必须传入该参数。
DBInstanceMode	String	否	否	实例资源类型。	取值： StorageElastic：存储弹性模式。 Serverless：Serverless模式。 Classic：存储预留模式。
PeriodUnit	String	否	否	订阅周期的单位。	取值： Month（默认值）：月。 Year：年。
Tags	List	否	是	标签。	在创建实例期间最多支持添加20个标签。每个标签都有两个属性Key和Value。更多详情，参见Tags属性。

Tags语法

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

Tags属性

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

返回值

Fn::GetAtt

DBInstanceId：实例ID。
Port：端口。
OrderId：订单编号。
ConnectionString：连接地址。

示例

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ZoneId:
    Type: String
  VpcId:
    Type: String
    AssociationProperty: 'ALIYUN::ECS::VPC::VPCId'
  VSwitchId:
    Type: String
    AssociationProperty: 'ALIYUN::ECS::VSwitch::VSwitchId'
    AssociationPropertyMetadata:
      ZoneId: ZoneId
      VpcId: VpcId
Resources:
  DBInstance:
    Type: 'ALIYUN::GPDB::ElasticDBInstance'
    Properties:
      ZoneId:
        Ref: ZoneId
      VPCId:
        Ref: VpcId
      VSwitchId:
        Ref: VSwitchId
      EngineVersion: '6.0'
      InstanceSpec: 2C16G
      SegNodeNum: 8
      SegStorageType: cloud_essd
      StorageSize: 100
Outputs:
  OrderId:
    Value:
      'Fn::GetAtt':
        - DBInstance
        - OrderId
  ConnectionString:
    Value:
      'Fn::GetAtt':
        - DBInstance
        - ConnectionString
  DBInstanceId:
    Value:
      'Fn::GetAtt':
        - DBInstance
        - DBInstanceId
  Port:
    Value:
      'Fn::GetAtt':
        - DBInstance
        - Port

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ZoneId": {
      "Type": "String"
    },
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    },
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "ZoneId": "ZoneId",
        "VpcId": "VpcId"
      }
    }
  },
  "Resources": {
    "DBInstance": {
      "Type": "ALIYUN::GPDB::ElasticDBInstance",
      "Properties": {
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "VPCId": {
          "Ref": "VpcId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "EngineVersion": "6.0",
        "InstanceSpec": "2C16G",
        "SegNodeNum": 8,
        "SegStorageType": "cloud_essd",
        "StorageSize": 100
      }
    }
  },
  "Outputs": {
    "OrderId": {
      "Value": { "Fn::GetAtt": ["DBInstance", "OrderId"] }
    },
    "ConnectionString": {
      "Value": { "Fn::GetAtt": ["DBInstance", "ConnectionString"] }
    },
    "DBInstanceId": {
      "Value": { "Fn::GetAtt": ["DBInstance", "DBInstanceId"] }
    },
    "Port": {
      "Value": { "Fn::GetAtt": ["DBInstance", "Port"] }
    }
  }
}