ALIYUN::GPDB::DBInstance類型用于創建存儲預留模式的AnalyticDB for PostgreSQL實例。
關于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,
"StorageSize": Integer,
"EncryptionType": String,
"MasterNodeNum": Integer,
"DBInstanceMode": String,
"SegDiskPerformanceLevel": String,
"DBInstanceCategory": String,
"SegStorageType": String,
"EncryptionKey": String,
"CreateSampleData": Boolean,
"ServerlessMode": String,
"ServerlessResource": Integer,
"PrivateIpAddress": String,
"SegNodeNum": Integer,
"InstanceSpec": String,
"IdleTime": Integer,
"ProdType": String
}
}
屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
EngineVersion | String | 是 | 否 | 引擎版本。 | 取值示例:
|
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 | 否 | 否 | 付費類型。 | 取值:
|
Period | Integer | 否 | 否 | 購買資源的時長。 | 取值范圍:
|
PeriodUnit | String | 否 | 否 | 購買資源的時長單位。 | 取值:
|
Tags | List | 否 | 否 | 用戶自定義標簽。 | 更多信息,請參見Tags屬性。 |
VectorConfigurationStatus | String | 否 | 否 | 是否開啟向量引擎優化。 | 取值:
說明
|
StorageSize | Integer | 否 | 否 | 存儲空間大小。 | 單位GB,取值范圍為50~8000 。 |
EncryptionType | String | 否 | 否 | 加密類型。 | 取值:
說明 當前云盤加密開啟后無法關閉。 |
MasterNodeNum | Integer | 否 | 否 | Master節點數量。 | 取值為1~2。 說明 如果不填,則默認為1個Master節點。 |
DBInstanceMode | String | 否 | 否 | 實例資源類型。 | 取值:
|
SegDiskPerformanceLevel | String | 否 | 否 | ESSD云盤的性能級別。 | 取值:
說明 僅磁盤存儲類型為ESSD云盤時,該參數生效。 如果不填,則默認為PL1級別。 |
DBInstanceCategory | String | 否 | 否 | 實例系列。 | 取值:
說明 創建存儲彈性模式實例必須傳入該參數。 |
SegStorageType | String | 否 | 否 | 磁盤存儲類型。 | 目前僅支持ESSD云盤,取值為:cloud_essd。 說明 創建存儲彈性模式實例必須傳入該參數。 |
EncryptionKey | String | 否 | 否 | 密鑰ID。 | 如果參數EncryptionType的值為CloudDisk則需要通過該參數指定同地域內的加密密鑰ID,否則為空。 |
CreateSampleData | Boolean | 否 | 否 | 是否在實例創建完成后加載樣本數據集。 | 取值:
|
ServerlessMode | String | 否 | 否 | Serverless實例的模式。 | 取值:
說明 僅Serverless模式實例需傳入該參數。 |
ServerlessResource | Integer | 否 | 否 | 計算資源閾值。 | 取值范圍8~32,步長為8,單位為ACU。默認值為32。 說明 僅Serverless自動調度模式實例需傳入該參數。 |
PrivateIpAddress | String | 否 | 否 | 私有IP地址。 | 無 |
SegNodeNum | Integer | 否 | 否 | 計算節點個數。 | 取值:
說明 創建存儲彈性模式實例和Serverless模式實例必須傳入該參數。 |
InstanceSpec | String | 否 | 否 | 計算節點規格。 |
說明 創建存儲彈性模式實例和Serverless模式實例必須傳入該參數。 |
IdleTime | Integer | 否 | 否 | 空閑釋放等待時長。 | 即當無業務流量的時長達到指定時長后,實例轉為空閑狀態。單位為秒,最小值為60,默認值為600。 說明 僅Serverless自動調度模式實例需傳入該參數。 |
ProdType | String | 否 | 否 | 產品類型。 | 取值:
|
Tags語法
"Tags": [
{
"Value": String,
"Key": String
}
]
Tags屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Key | String | 是 | 否 | 標簽鍵。 | 長度為1~128個字符,不能以 |
Value | String | 否 | 否 | 標簽值。 | 長度為0~128個字符,不能以 |
返回值
Fn::GetAtt
DBInstanceId:實例ID。
Port:端口。
OrderId:訂單編號。
ConnectionString:連接地址。
示例
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
{
"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"] }
}
}
}