予約型ストレージモードで AnalyticDB for PostgreSQL インスタンスを作成するための ALIYUN::GPDB::DBInstance の使用方法 - Resource Orchestration Service

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,
    "MasterCU": Integer,
    "StandbyZoneId": String,
    "StandbyVSwitchId": String,
    "DeployMode": String,
    "AINodeSpecInfos": List,
    "ResourceGroupId": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
EngineVersion	String	はい	いいえ	エンジンバージョン。	有効な値: 6.0: 6.0 Standard Edition 6.0x: 6.0 Vector Enhanced Edition
AINodeSpecInfos	List	いいえ	いいえ	AI ノードに関する情報。	詳細については、「AINodeSpecInfos プロパティ」をご参照ください。
VSwitchId	String	はい	いいえ	vSwitch ID。	例: vsw-bp183p93qs667muql****。
DBInstanceClass	String	いいえ	いいえ	インスタンスタイプファミリー。	例: gpdb.group.segsdx2。
DBInstanceGroupCount	Integer	いいえ	いいえ	AnalyticDB for PostgreSQL インスタンスの計算ノード数。	例: 2。
VPCId	String	いいえ	いいえ	Virtual Private Cloud (VPC) の ID。	例: vpc-bp1m6fww66xbntjyc****。
SecurityIPList	String	いいえ	はい	IP アドレスのホワイトリスト。	デフォルト値: 127.0.0.1。
DBInstanceDescription	String	いいえ	はい	インスタンスの説明。	例: AnalyticDB PostgreSQL DB インスタンス。説明は最大 256 文字まで入力できます。
PayType	String	いいえ	はい	課金方法。	有効な値: Postpaid (デフォルト): 従量課金 Prepaid: サブスクリプション
Period	Integer	いいえ	はい	インスタンスのサブスクリプション期間。	PeriodUnit が Month に設定されている場合の有効な値: 1 ～ 11。 PeriodUnit が Year に設定されている場合の有効な値: 1 ～ 3。
PeriodUnit	String	いいえ	はい	サブスクリプション期間の単位。	有効な値: Month (デフォルト) Year
Tags	List	いいえ	いいえ	インスタンスのカスタムタグ。	詳細については、このトピックの「Tags プロパティ」セクションをご参照ください。
EncryptionType	String	いいえ	いいえ	暗号化タイプ。	有効な値: NULL (デフォルト): 暗号化を無効にします。 CloudDisk: クラウドディスクの暗号化を有効にします。この場合、EncryptionKey を使用して暗号鍵を指定する必要があります。説明ディスクの暗号化は、有効にした後、無効にすることはできません。
MasterNodeNum	Integer	いいえ	いいえ	コーディネーターノードの数。	有効な値: 1 ～ 2。説明このプロパティを空のままにすると、1 が使用されます。
DBInstanceMode	String	いいえ	いいえ	インスタンスのリソースモード。	有効な値: StorageElastic: エラスティックストレージモード Serverless: サーバーレスモード Classic: 予約型ストレージモード
SegDiskPerformanceLevel	String	いいえ	いいえ	Enhanced SSD (ESSD) のパフォーマンスレベル (PL)。	有効な値: pl0 pl1 pl2 説明このプロパティは、SegStorageType が cloud_essd に設定されている場合にのみ有効になります。このプロパティを指定しない場合、pl1 が使用されます。
DBInstanceCategory	String	いいえ	いいえ	インスタンスのエディション。	有効な値: HighAvailability: High-availability Edition Basic: Basic Edition 説明エラスティックストレージモードでインスタンスを作成する場合は、このプロパティを指定する必要があります。
SegStorageType	String	いいえ	いいえ	ディスクのストレージタイプ。	値を cloud_essd に設定します。cloud_essd の値は ESSD を指定します。説明エラスティックストレージモードでインスタンスを作成する場合は、このプロパティを指定する必要があります。
StorageSize	Integer	いいえ	いいえ	ストレージ容量のサイズ。	単位: GB。有効な値: 50 ～ 8000。
EncryptionKey	String	いいえ	いいえ	キー ID。	EncryptionType が CloudDisk に設定されている場合、EncryptionKey を使用して、EncryptionType で指定されたクラウドディスクと同じリージョンにある暗号鍵の ID を指定する必要があります。EncryptionType が CloudDisk に設定されていない場合は、EncryptionKey を空のままにする必要があります。
CreateSampleData	Boolean	いいえ	いいえ	インスタンスの作成後にサンプルデータセットをロードするかどうかを指定します。	有効な値: true false (デフォルト)
ServerlessMode	String	いいえ	いいえ	インスタンスのサーバーレスモード。	有効な値: Manual (デフォルト): 手動スケジューリング Auto: 自動スケジューリング説明このプロパティは、サーバーレスモードでインスタンスを作成する場合にのみ指定する必要があります。
ServerlessResource	Integer	いいえ	いいえ	計算リソースのしきい値。	単位: AnalyticDB 計算ユニット (ACU)。有効な値: 8 ～ 32。値は 8 ACU 単位でなければなりません。デフォルト値: 32。説明このプロパティは、自動サーバーレスモードでインスタンスを作成する場合にのみ指定する必要があります。
PrivateIpAddress	String	いいえ	いいえ	インスタンスのプライベート IP アドレス。	なし。
SegNodeNum	Integer	いいえ	いいえ	計算ノードの数。	エラスティックストレージモードの High-availability Edition インスタンスの有効な値: 4 ～ 512 の 4 の倍数。エラスティックストレージモードの Basic Edition インスタンスの有効な値: 2 ～ 512 の 2 の倍数。サーバーレスモードのインスタンスの有効な値: 2 ～ 512 の 2 の倍数。説明エラスティックストレージモードまたはサーバーレスモードでインスタンスを作成する場合は、このプロパティを指定する必要があります。
InstanceSpec	String	いいえ	いいえ	計算ノードの仕様。	エラスティックストレージモードの High-availability Edition インスタンスの有効な値: 2C16G 4C32G 16C128G エラスティックストレージモードの Basic Edition インスタンスの有効な値: 2C8G 4C16G 8C32G 16C64G サーバーレスモードのインスタンスの有効な値: 4C16G 8C32G 説明エラスティックストレージモードまたはサーバーレスモードでインスタンスを作成する場合は、このプロパティを指定する必要があります。
IdleTime	Integer	いいえ	いいえ	トラフィックがないインスタンスがアイドル状態になるまでの待機時間。	ビジネストラフィックが生成されない期間が指定されたしきい値に達すると、インスタンスはアイドル状態になります。最小値: 60。デフォルト値: 600。単位: 秒。説明このプロパティは、自動サーバーレスモードでインスタンスを作成する場合にのみ指定する必要があります。
ProdType	String	いいえ	いいえ	プロダクトタイプ。	有効な値: standard (デフォルト): Standard Edition cost-effective: Cost-efficient Edition
MasterCU	Integer	いいえ	いいえ	コーディネーターノードリソースの数。	なし。
StandbyZoneId	String	いいえ	いいえ	セカンダリゾーンの ID。	なし。
StandbyVSwitchId	String	いいえ	いいえ	セカンダリ vSwitch の ID。	なし。
DeployMode	String	いいえ	いいえ	デプロイモード。	なし。
ResourceGroupId	String	いいえ	はい	リソースグループ ID。	なし。
VectorConfigurationStatus	String	いいえ	いいえ	ベクター検索エンジンの最適化を有効にするかどうかを指定します。	有効な値: enabled disabled (デフォルト) 説明メインストリーム分析、データウェアハウス、リアルタイムデータウェアハウスのシナリオでは、ベクター検索エンジンの最適化を有効にしないことをお勧めします。 AI 生成コンテンツ (AIGC) およびベクター分析エンジンを必要とするベクター取得シナリオでは、ベクター検索エンジンの最適化を有効にすることをお勧めします。
ZoneId	String	はい	いいえ	ゾーン ID。	例: cn-hangzhou-h。ゾーン ID の詳細については、「DescribeRegions」をご参照ください。

AINodeSpecInfos 構文

"AINodeSpecInfos": [
  {
    "AINodeSpec": String, // AI ノードの仕様
    "AINodeNum": Integer // AI ノードの数
  }
]

AINodeSpecInfos プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
AINodeSpec	String	はい	いいえ	AI ノードの仕様。	なし。
AINodeNum	Integer	はい	いいえ	AI ノードの数。	なし。

Tags 構文

"Tags": [
  {
    "Value": String, // タグ値
    "Key": String // タグキー
  }
]

Tags プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Key	String	はい	いいえ	タグキー。	タグキーは 1 ～ 128 文字の長さでなければならず、`http://` または `https://` を含めることはできません。タグキーは `aliyun` または `acs:` で始めることはできません。
Value	String	いいえ	いいえ	タグ値。	タグ値は最大 128 文字の長さで、`http://` または `https://` を含めることはできません。タグ値は `aliyun` または `acs:` で始めることはできません。

戻り値

Fn::GetAtt

DBInstanceId: インスタンス ID。
Port: ポート。
OrderId: 注文 ID。
ConnectionString: エンドポイント。
Arn: Alibaba Cloud Resource Name (ARN)。

例

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" // ゾーンID
    },
    "VpcId": {
      "Type": "String", // VPC ID
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    },
    "VSwitchId": {
      "Type": "String", // vSwitch ID
      "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"] } // 注文ID
    },
    "ConnectionString": {
      "Value": { "Fn::GetAtt": ["DBInstance", "ConnectionString"] } // 接続文字列
    },
    "DBInstanceId": {
      "Value": { "Fn::GetAtt": ["DBInstance", "DBInstanceId"] } // DB インスタンスID
    },
    "Port": {
      "Value": { "Fn::GetAtt": ["DBInstance", "Port"] } // ポート
    }
  }
}