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

ALIYUN::GPDB::DBInstance类型用于创建存储预留模式的AnalyticDB for PostgreSQL实例。

语法

{
  "Type": "ALIYUN::GPDB::DBInstance",
  "Properties": {
    "EngineVersion": String,
    "ZoneId": String,
    "VSwitchId": String,   
    "DBInstanceClass": String,
    "DBInstanceGroupCount": Integer,
    "VPCId": String,
    "SecurityIPList": String,   
    "DBInstanceDescription": String,
    "PayType": String,
    "Period": Integer,
    "PeriodUnit": String,
    "Tags": List,
    "VectorConfigurationStatus": String
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
EngineVersion	String	是	否	引擎版本。	取值示例： 6.0：6.0标准版。 6.0x：6.0向量增强版。
ZoneId	String	是	否	可用区ID。	取值示例：cn-hangzhou-h。关于可用区ID的更多信息，请参见DescribeRegions。
VSwitchId	String	是	否	交换机ID。	取值示例：vsw-bp183p93qs667muql****。
DBInstanceClass	String	是	否	实例规格。	取值示例：gpdb.group.segsdx2。关于实例规格的更多信息，请参见实例规格表。
DBInstanceGroupCount	Integer	是	否	AnalyticDB for PostgreSQL计算组的数量。	取值示例：2。
VPCId	String	否	否	专有网络ID。	取值示例：vpc-bp1m6fww66xbntjyc****。
SecurityIPList	String	否	是	IP地址白名单。	默认值：127.0.0.1。
DBInstanceDescription	String	否	是	实例描述。	取值示例：AnalyticDB PostgreSQL DB Instance。长度不超过256个字符。
PayType	String	否	否	付费类型。	取值： Postpaid（默认值）：按量付费。 Prepaid：包年包月。
Period	Integer	否	否	购买资源的时长。	取值范围：当PeriodUnit取值为Month时：1~11。当PeriodUnit取值为Year时：1~3。
PeriodUnit	String	否	否	购买资源的时长单位。	取值： Month（默认值）：月。 Year：年。
Tags	List	否	是	用户自定义标签。	更多信息，请参见Tags属性。
VectorConfigurationStatus	String	否	否	是否开启向量引擎优化。	取值： enabled：开启向量引擎优化。 disabled（默认值）：不开启向量引擎优化。说明对于主流分析场景、数仓场景、实时数仓等场景，建议不开启向量引擎优化。对于使用向量分析引擎用于AIGC、向量检索等场景用户，建议开启向量引擎优化。

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::DBInstance'
    Properties:
      ZoneId:
        Ref: ZoneId
      VPCId:
        Ref: VpcId
      VSwitchId:
        Ref: VSwitchId
      DBInstanceGroupCount: 2
      EngineVersion: '6.0'
      DBInstanceClass: gpdb.group.segsdx2
      DBInstanceDescription: AnalyticDB PostgreSQL DB Instance
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::DBInstance",
      "Properties": {
        "ZoneId": {
          "Ref": "ZoneId"
        },
        "VPCId": {
          "Ref": "VpcId"
        },
        "VSwitchId": {
          "Ref": "VSwitchId"
        },
        "DBInstanceGroupCount": 2,
        "EngineVersion": "6.0",
        "DBInstanceClass": "gpdb.group.segsdx2",
        "DBInstanceDescription": "AnalyticDB PostgreSQL DB Instance"
      }
    }
  },
  "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"] }
    }
  }
}