全部產品
Search
文件中心

:ALIYUN::GPDB::DBInstance

更新時間:Jun 19, 2024

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,
    "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

引擎版本。

取值樣本:

  • 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、向量檢索等情境使用者,建議開啟向量引擎最佳化。

StorageSize

Integer

儲存空間大小。

單位GB,取值範圍為50~8000 。

EncryptionType

String

加密類型。

取值:

  • NULL:不啟用加密(預設值)。

  • CloudDisk:開通雲端硬碟加密,並通過EncryptionKey參數指定密鑰。

說明

當前雲端硬碟加密開啟後無法關閉。

MasterNodeNum

Integer

Master節點數量。

取值為1~2。

說明

如果不填,則預設為1個Master節點。

DBInstanceMode

String

執行個體資源類型。

取值:

  • StorageElastic:儲存彈性模式。

  • Serverless:Serverless模式。

  • Classic:儲存預留模式。

SegDiskPerformanceLevel

String

ESSD雲端硬碟的效能層級。

取值:

  • pl0:PL0層級。

  • pl1:PL1層級。

  • pl2:PL2層級。

說明

僅磁碟儲存類型為ESSD雲端硬碟時,該參數生效。

如果不填,則預設為PL1層級。

DBInstanceCategory

String

執行個體系列。

取值:

  • HighAvailability:高可用版。

  • Basic:基礎版。

說明

建立儲存彈性模式執行個體必須傳入該參數。

SegStorageType

String

磁碟儲存類型。

目前僅支援ESSD雲端硬碟,取值為:cloud_essd

說明

建立儲存彈性模式執行個體必須傳入該參數。

EncryptionKey

String

密鑰ID。

如果參數EncryptionType的值為CloudDisk則需要通過該參數指定同地區內的加密金鑰ID,否則為空白。

CreateSampleData

Boolean

是否在執行個體建立完成後載入樣本資料集。

取值:

  • true:載入樣本資料集。

  • false(預設值):不載入樣本資料集

ServerlessMode

String

Serverless執行個體的模式。

取值:

  • Manual:手動調度,為預設值。

  • Auto:自動調度。

說明

僅Serverless模式執行個體需傳入該參數。

ServerlessResource

Integer

計算資源閾值。

取值範圍8~32,步長為8,單位為ACU。預設值為32。

說明

僅Serverless自動調度模式執行個體需傳入該參數。

PrivateIpAddress

String

私人IP地址。

SegNodeNum

Integer

計算節點個數。

取值:

  • 儲存彈性模式高可用版取值範圍為4~512,取值需為4的倍數。

  • 儲存彈性模式基礎版取值範圍為2~512,取值需為2的倍數。

  • Serverless模式取值範圍為2~512,取值需為2的倍數。

說明

建立儲存彈性模式執行個體和Serverless模式執行個體必須傳入該參數。

InstanceSpec

String

計算節點規格。

  • 儲存彈性模式高可用版取值:

    • 2C16G

    • 4C32G

    • 16C128G

  • 儲存彈性模式基礎版取值:

    • 2C8G

    • 4C16G

    • 8C32G

    • 16C64G

  • Serverless模式取值:

    • 4C16G

    • 8C32G

說明

建立儲存彈性模式執行個體和Serverless模式執行個體必須傳入該參數。

IdleTime

Integer

空閑釋放等待時間長度。

即當無業務流量的時間長度達到指定時間長度後,執行個體轉為空白閑狀態。單位為秒,最小值為60,預設值為600。

說明

僅Serverless自動調度模式執行個體需傳入該參數。

ProdType

String

產品類型。

取值:

  • standard:標準版(預設值)。

  • cost-effective:經濟版。

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