ALIYUN::ROCKETMQ5::Instance リソースタイプの使用方法 - Resource Orchestration Service

ALIYUN::ROCKETMQ5::Instance リソースタイプは、ApsaraMQ for RocketMQ 5.0 インスタンスを作成します。

構文

{
  "Type": "ALIYUN::ROCKETMQ5::Instance",
  "Properties": {
    "AutoRenewPeriod": Integer,
    "ProductInfo": Map,
    "ResourceGroupId": String,
    "AutoRenew": Boolean,
    "Period": Integer,
    "InternetInfo": Map,
    "SubSeriesCode": String,
    "Remark": String,
    "InstanceName": String,
    "SeriesCode": String,
    "PaymentType": String,
    "VpcInfo": Map,
    "PeriodUnit": String
  }
}

プロパティ

プロパティ	タイプ	必須	更新可能	説明	制約
AutoRenewPeriod	Integer	いいえ	いいえ	自動更新期間。	このプロパティは、インスタンスの自動更新が有効になっている場合にのみ有効になります。単位は月です。値: 月次更新の有効値: 1、2、3、6、12。
ProductInfo	Map	はい	はい	インスタンスの仕様情報。	詳細については、ProductInfo プロパティをご参照ください。
ResourceGroupId	String	いいえ	いいえ	リソースグループの ID。	なし。
AutoRenew	Boolean	いいえ	いいえ	自動更新を有効にするかどうかを指定します。	このパラメーターは、サブスクリプションインスタンスに対してのみ有効です。有効な値： true: 自動更新が有効になります。 false: 自動更新が無効になります。
Period	Integer	いいえ	いいえ	サブスクリプション期間。	このパラメーターは、サブスクリプションインスタンスに対してのみ有効です。有効な値： PeriodUnit が Month に設定されている場合: 1、2、3、4、5、6。 PeriodUnit が Year に設定されている場合: 1、2、3。
InternetInfo	Map	はい	はい	インターネットアクセス構成。	詳細については、InternetInfo プロパティをご参照ください。
SubSeriesCode	String	はい	いいえ	インスタンスのサブシリーズコード。	有効な値： cluster_ha: 高可用性クラスター版。シリーズを ultimate (Platinum Edition) に設定した場合、サブシリーズを cluster_ha (高可用性クラスター版) に設定する必要があります。 single_node: シングルノード版。 serverless: サーバーレスインスタンス説明インスタンスの作成後は、そのサブシリーズを変更することはできません。
Remark	String	いいえ	はい	インスタンスに関する備考。	なし。
InstanceName	String	いいえ	はい	作成するインスタンスの名前。	このパラメーターを指定しない場合、インスタンス ID がインスタンス名として使用されます。
SeriesCode	String	はい	いいえ	インスタンスのシリーズコード。	有効な値： standard：スタンダード版 ultimate：プラチナ版 professional：プロフェッショナル版説明インスタンスの作成後は、シリーズのスペックアップのみ可能です。シリーズのスペックダウンはできません。スペックアップパスは、Standard Edition > Professional Edition > Platinum Edition です。たとえば、インスタンスを Standard Edition から Professional Edition にスペックアップすることはできますが、Professional Edition から Standard Edition にスペックダウンすることはできません。
PaymentType	String	いいえ	いいえ	インスタンスの課金方法。	有効な値： PayAsYouGo: 使用後に支払う後払い課金方法。 Subscription: 使用前に支払う前払い課金方法。
VpcInfo	Map	はい	いいえ	VPC 構成。	詳細については、VpcInfo プロパティをご参照ください。
PeriodUnit	String	いいえ	いいえ	サブスクリプション期間の単位。	有効な値： Month: 月単位で購入します。 Year: 年単位で購入します。

ProductInfo 構文

"ProductInfo": {
  "SendReceiveRatio": Number,
  "MessageRetentionTime": Integer,
  "AutoScaling": Boolean,
  "MsgProcessSpec": String
}

ProductInfo プロパティ

プロパティ	タイプ	必須	更新可能	説明	制約
SendReceiveRatio	Number	いいえ	はい	送信メッセージと受信メッセージの比率。	値は 0.2 から 0.5 の範囲 (0.2 と 0.5 を含む) である必要があります。
MessageRetentionTime	Integer	いいえ	はい	メッセージの保存期間。	単位: 時間。 ApsaraMQ for RocketMQ 5.0 のメッセージストレージはサーバーレスで伸縮自在です。実際に使用したストレージに対して課金されます。メッセージの保存期間を調整して、ストレージ容量を制御できます。
AutoScaling	Boolean	いいえ	いいえ	Elastic TPS 機能を有効にするかどうかを指定します。	有効な値： true: Elastic TPS 機能が有効になります。 false: Elastic TPS 機能が無効になります。この機能を有効にすると、インスタンスは特定の範囲内でベース TPS の上限を超えることができます。ベース仕様を超える TPS に対して課金されます。説明この機能は、特定のインスタンスタイプでのみサポートされます。
MsgProcessSpec	String	はい	いいえ	メッセージの送受信のための計算仕様。	なし。

InternetInfo 構文

"InternetInfo": {
  "IpWhitelist": List,
  "InternetSpec": String,
  "FlowOutBandwidth": Integer,
  "FlowOutType": String
}

InternetInfo プロパティ

プロパティ	タイプ	必須	更新可能	説明	制約
IpWhitelist	List	いいえ	はい	インターネットアクセス用の IP アドレスホワイトリスト。	IP ホワイトリストは、インターネットエンドポイントに対してのみ設定できます。VPC エンドポイントは IP ホワイトリストをサポートしていません。 IP ホワイトリストを設定しない場合、すべての IP アドレスがインターネット経由で ApsaraMQ for RocketMQ 5.0 サービスにアクセスできます。 IP ホワイトリストを設定した場合、ホワイトリスト内の IP アドレスのみがインターネット経由で ApsaraMQ for RocketMQ 5.0 サービスにアクセスできます。
InternetSpec	String	はい	はい	インターネットアクセスを有効にするかどうかを指定します。	有効な値： enable: インターネットアクセスが有効になります。 disable: インターネットアクセスが無効になります。デフォルトでは、インスタンスは VPC 経由のアクセスをサポートします。インターネットアクセスを有効にすると、アウトバウンドのインターネットトラフィックに対して課金されます。
FlowOutBandwidth	Integer	いいえ	はい	インターネット帯域幅。	単位: Mbit/s。このパラメーターは、インターネットアクセスの課金方法が帯域幅課金の場合にのみ必須です。有効値: 1～1,000。
FlowOutType	String	いいえ	いいえ	インターネットアクセスの課金方法。	有効値: payByBandwidth: 帯域幅課金方法。インターネットアクセスを有効にする場合は、パラメーターをこの値に設定します。 uninvolved: 適用されません。インターネットアクセスを無効にする場合は、パラメーターをこの値に設定します。

VpcInfo 構文

"VpcInfo": {
  "VpcId": String,
  "VSwitchId": String,
  "SecurityGroupId": String,
  "VSwitchIds": List
}

VpcInfo プロパティ

プロパティ	タイプ	必須	更新可能	説明	制約
VpcId	String	はい	いいえ	インスタンスが属する VPC の ID。	説明 ApsaraMQ for RocketMQ 5.0 インスタンスの作成後は、その VPC を変更することはできません。VPC を変更するには、インスタンスをリリースして新しいインスタンスを作成します。
VSwitchId	String	いいえ	いいえ	インスタンスが属する vSwitch の ID。	説明 ApsaraMQ for RocketMQ 5.0 インスタンスの作成後は、その vSwitch を変更することはできません。vSwitch を変更するには、インスタンスをリリースして新しいインスタンスを作成します。
SecurityGroupId	String	いいえ	いいえ	インスタンスが属するセキュリティグループの ID。	なし。
VSwitchIds	List	いいえ	いいえ	インスタンスが属する vSwitch の ID。	なし。

戻り値

Fn::GetAtt

InstanceName: インスタンスの名前。
VpcEndpoint: VPC エンドポイント。
InstanceId: インスタンスの ID。
InternetEndpoint: インスタンスのインターネットエンドポイント。

例

`YAML` フォーマット

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VpcId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VPC::VPCId
  VSwitchId:
    Type: String
    AssociationProperty: ALIYUN::ECS::VSwitch::VSwitchId
    AssociationPropertyMetadata:
      VpcId: ${VpcId}
Resources:
  Instance:
    Type: ALIYUN::ROCKETMQ5::Instance
    Properties:
      ProductInfo:
        MsgProcessSpec: rmq.s2.2xlarge
        SendReceiveRatio: 0.2
        MessageRetentionTime: 72
      InternetInfo:
        InternetSpec: disable
        FlowOutBandwidth: uninvolved
      SubSeriesCode: cluster_ha
      SeriesCode: standard
      PaymentType: PayAsYouGo
      VpcInfo:
        VpcId:
          Ref: VpcId
        VSwitchId:
          Ref: VSwitchId
Outputs:
  InstanceName:
    Description: インスタンス名。
    Value:
      Fn::GetAtt:
        - Instance
        - InstanceName
  VpcEndpoint:
    Description: VPC エンドポイント。
    Value:
      Fn::GetAtt:
        - Instance
        - VpcEndpoint
  InstanceId:
    Description: 作成されたインスタンス ID。
    Value:
      Fn::GetAtt:
        - Instance
        - InstanceId
  InternetEndpoint:
    Description: インターネットエンドポイント。
    Value:
      Fn::GetAtt:
        - Instance
        - InternetEndpoint

`JSON` フォーマット

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VpcId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VPC::VPCId"
    },
    "VSwitchId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::VSwitch::VSwitchId",
      "AssociationPropertyMetadata": {
        "VpcId": "${VpcId}"
      }
    }
  },
  "Resources": {
    "Instance": {
      "Type": "ALIYUN::ROCKETMQ5::Instance",
      "Properties": {
        "ProductInfo": {
          "MsgProcessSpec": "rmq.s2.2xlarge",
          "SendReceiveRatio": 0.2,
          "MessageRetentionTime": 72
        },
        "InternetInfo": {
          "InternetSpec": "disable",
          "FlowOutBandwidth": "uninvolved"
        },
        "SubSeriesCode": "cluster_ha",
        "SeriesCode": "standard",
        "PaymentType": "PayAsYouGo",
        "VpcInfo": {
          "VpcId": {
            "Ref": "VpcId"
          },
          "VSwitchId": {
            "Ref": "VSwitchId"
          }
        }
      }
    }
  },
  "Outputs": {
    "InstanceName": {
      "Description": "インスタンス名。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceName"
        ]
      }
    },
    "VpcEndpoint": {
      "Description": "VPC エンドポイント。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "VpcEndpoint"
        ]
      }
    },
    "InstanceId": {
      "Description": "作成されたインスタンス ID。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceId"
        ]
      }
    },
    "InternetEndpoint": {
      "Description": "インターネットエンドポイント。",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InternetEndpoint"
        ]
      }
    }
  }
}

構文

プロパティ

ProductInfo 構文

ProductInfo プロパティ

InternetInfo 構文

InternetInfo プロパティ

VpcInfo 構文

VpcInfo プロパティ

戻り値

例

YAML フォーマット

JSON フォーマット

`YAML` フォーマット

`JSON` フォーマット