ALIYUN::GPDB::DBInstance を使用して、予約ストレージモードの AnalyticDB for PostgreSQL インスタンスを作成します - 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,
    "CacheStorageSize": String,
    "BackupId": String,
    "MasterAISpec": String,
    "EnableSSL": Boolean,
    "SrcDbInstanceName": 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`：Standard Edition。 `6.0x`：ベクター強化エディション。
AINodeSpecInfos	List	いいえ	いいえ	AI ノードの詳細情報。	詳細については、「AINodeSpecInfos のプロパティ」セクションをご参照ください。
VSwitchId	String	はい	いいえ	VSwitch の ID。	例：`vsw-bp183p93qs667muql****`。
BackupId	String	いいえ	いいえ	過去のバックアップセットの ID。	なし。
CacheStorageSize	String	いいえ	いいえ	キャッシュディスクサイズ。	単位：GB。
EnableSSL	Boolean	いいえ	いいえ	SSL 暗号化を有効にするかどうかを指定します。	有効な値： true：SSL 暗号化を有効にします。 false（デフォルト）：SSL 暗号化を無効にします。
MasterAISpec	String	いいえ	いいえ	コーディネーターノードを MasterAI ノードへアップグレードするための仕様。	説明このパラメーターと `MasterCU` パラメーターを同時に指定することはできません。このアップグレードは、特定のリージョンおよび可用性ゾーンでのみサポートされています。 MasterAI ノードは、AnalyticDB for PostgreSQL 7.0 の Basic Edition インスタンスのみがサポートしています。このパラメーターの有効な値は、インスタンスのアップグレードページで確認できます。
SrcDbInstanceName	String	いいえ	いいえ	クローン元となるソースインスタンスの ID。	なし。
DBInstanceClass	String	いいえ	いいえ	インスタンスタイプ。	例：`gpdb.group.segsdx2`。
DBInstanceGroupCount	Integer	いいえ	いいえ	計算グループ数。	例：`2`。
VPCId	String	いいえ	いいえ	仮想プライベートクラウド (VPC) の ID。	例：`vpc-bp1m6fww66xbntjyc****`。
SecurityIPList	String	いいえ	はい	インスタンスの IP アドレスホワイトリスト。	デフォルト値：`127.0.0.1`。
DBInstanceDescription	String	いいえ	はい	インスタンスの説明。	例：`AnalyticDB for PostgreSQL DB Instance`。説明は最大 256 文字まで入力可能です。
PayType	String	いいえ	はい	インスタンスの課金方法。	有効な値： `Postpaid`（デフォルト）：従量課金。 `Prepaid`：サブスクリプション課金。
Period	Integer	いいえ	はい	サブスクリプション期間。	`PayType` を `Prepaid` に設定した場合にのみ必須です。有効な値： `PeriodUnit` を `Month` に設定した場合：1～11。 `PeriodUnit` を `Year` に設定した場合：1、2、3。
PeriodUnit	String	いいえ	はい	サブスクリプション期間の単位。	`PayType` を `Prepaid` に設定した場合にのみ必須です。有効な値： `Month`（デフォルト） `Year`
Tags	List	いいえ	いいえ	インスタンスのタグ。	詳細については、「Tags のプロパティ」セクションをご参照ください。
EncryptionType	String	いいえ	いいえ	暗号化タイプ。	有効な値： NULL（デフォルト）：クラウドディスク暗号化を無効にします。 CloudDisk：クラウドディスク暗号化を有効にします。この値を選択した場合は、`EncryptionKey` パラメーターを指定する必要があります。説明クラウドディスク暗号化を有効化した後は、無効化できません。
MasterNodeNum	Integer	いいえ	いいえ	コーディネーターノード数。	有効な値：1、2。説明このパラメーターを指定しない場合、デフォルト値は 1 です。
DBInstanceMode	String	いいえ	いいえ	インスタンスのストレージモード。	有効な値： StorageElastic：弾性ストレージモード。 Serverless：Serverless モード。 Classic：予約ストレージモード。
SegDiskPerformanceLevel	String	いいえ	いいえ	拡張 SSD（ESSD）のパフォーマンスレベル（PL）。	有効な値： pl0：PL0。 pl1：PL1。 pl2：PL2。説明このパラメーターは、ディスクストレージタイプが ESSD の場合にのみ適用されます。このパラメーターを指定しない場合、デフォルト値は pl1 です。
DBInstanceCategory	String	いいえ	いいえ	インスタンスエディション。	有効な値： HighAvailability: High-availability Edition. Basic：Basic Edition。説明このパラメーターは、弾性ストレージモードのインスタンスに必須です。
SegStorageType	String	いいえ	いいえ	ディスクストレージタイプ。	現在、拡張 SSD（ESSD）のみがサポートされています。値は cloud_essd に設定してください。説明このパラメーターは、弾性ストレージモードのインスタンスに必須です。
StorageSize	Integer	いいえ	いいえ	ストレージ容量。	単位：GB。有効な値：50～8000。
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	いいえ	いいえ	計算ノード数。	有効な値：弾性ストレージモードの High-availability Edition インスタンスの場合：4～512（4 の倍数）。弾性ストレージモードの Basic Edition インスタンスの場合：2～512（2 の倍数）。 Serverless モードのインスタンスの場合：2～512（2 の倍数）。説明このパラメーターは、弾性ストレージモードまたは Serverless モードのインスタンスに必須です。
InstanceSpec	String	いいえ	いいえ	計算ノードの仕様。	弾性ストレージモードの High-availability Edition の値： 2C16G 4C32G 16C128G 弾性ストレージモードの Basic Edition の値： 2C8G 4C16G 8C32G 16C64G Serverless モードの値： 4C16G 8C32G 説明このパラメーターは、弾性ストレージモードまたは Serverless モードのインスタンスに必須です。
IdleTime	Integer	いいえ	いいえ	インスタンスが自動的に一時停止されるまでのアイドル状態の持続時間（秒単位）。	この期間の非アクティブ状態の後に、インスタンスはアイドル状態になります。最小値：60。デフォルト値：600。説明このパラメーターは、自動スケジューリングを使用する Serverless モードのインスタンスに必須です。
ProdType	String	いいえ	いいえ	プロダクトタイプ。	有効な値： standard（デフォルト）：Standard Edition。 cost-effective：コスト効率重視エディション。
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`。可用性ゾーンについて詳しくは、「利用可能なリージョンとゾーンの表示」をご参照ください。

AINodeSpecInfos の構文

"AINodeSpecInfos": [
  {
    "AINodeSpec": String,
    "AINodeNum": Integer
  }
]

AINodeSpecInfos のプロパティ

パラメーター	型	必須	更新可否	説明	制約条件
AINodeSpec	String	はい	いいえ	AI ノードの仕様。	なし。
AINodeNum	Integer	はい	いいえ	AI ノード数。	なし。

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：注文の 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"
    },
    "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"] }
    }
  }
}