全部產品
Search
文件中心

:ALIYUN::GPDB::ElasticDBInstance

更新時間:Jun 19, 2024

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個字元,不能以aliyunacs:開頭,不能包含http://https://

Value

String

標籤值。

長度為0~128個字元,不能以aliyunacs:開頭,不能包含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"] }
    }
  }
}