Resource Orchestration Service:ALIYUN::ROCKETMQ5::Instance - ROS

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
  }
}

プロパティ

プロパティ名	型	必須	更新可否	説明	制約条件
InternetInfo	Map	はい	はい	パブリックネットワークの構成。	詳細については、「InternetInfo のプロパティ」をご参照ください。
ProductInfo	Map	はい	はい	インスタンスの仕様。	詳細については、「ProductInfo のプロパティ」をご参照ください。
SeriesCode	String	はい	いいえ	インスタンスの主系列コード。	有効な値： standard：Standard Edition ultimate：Platinum Edition professional：Professional Edition 説明インスタンスを作成した後は、主系列をアップグレードすることはできますが、ダウングレードすることはできません。アップグレード可能な経路は「Standard Edition → Professional Edition → Platinum Edition」です。たとえば、Standard Edition のインスタンスを Professional Edition にアップグレードできますが、Professional Edition のインスタンスを Standard Edition にダウングレードすることはできません。
SubSeriesCode	String	はい	いいえ	インスタンスのサブシリーズコード。	有効な値： cluster_ha：High-availability Cluster Edition。主系列を `ultimate`（Platinum Edition）に設定する場合は、サブシリーズを必ず `cluster_ha`（High-availability Cluster Edition）に設定する必要があります。 single_node：テスト用のシングルノード版。 serverless：サーバーレスインスタンス。説明インスタンスを作成した後は、そのサブシリーズを変更することはできません。
VpcInfo	Map	はい	いいえ	VPC の構成。	詳細については、「VpcInfo のプロパティ」をご参照ください。
AutoRenew	Boolean	いいえ	いいえ	自動更新を有効にするかどうかを指定します。	このパラメーターは、インスタンスの課金方法が `Subscription` の場合のみ有効です。有効な値： true：自動更新を有効にします。 false：自動更新を無効にします。
AutoRenewPeriod	Integer	いいえ	いいえ	自動更新期間。	このパラメーターは、自動更新が有効な場合のみ有効です。単位：月。有効な値：月単位での更新の場合：1、2、3、6、12。
InstanceName	String	いいえ	はい	作成するインスタンスの名前。	このパラメーターを指定しない場合、インスタンス ID がインスタンス名として使用されます。
PaymentType	String	いいえ	いいえ	インスタンスの課金方法。	有効な値： PayAsYouGo：使用したリソースに対して従量課金される課金方法。 Subscription：事前に料金を支払うサブスクリプション課金方法。
Period	Integer	いいえ	いいえ	サブスクリプション期間。	このパラメーターは、インスタンスの課金方法が `Subscription` の場合のみ有効です。有効な値：月単位で購入する場合：1、2、3、4、5、6。年単位で購入する場合：1、2、3。
PeriodUnit	String	いいえ	いいえ	最小のサブスクリプション期間単位。	有効な値： Month：サブスクリプション期間の単位が月であることを示します。 Year：サブスクリプション期間の単位が年であることを示します。
Remark	String	いいえ	はい	インスタンスに関する備考。	なし
ResourceGroupId	String	いいえ	いいえ	リソースグループの ID。	なし

ProductInfo の構文

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

ProductInfo のプロパティ

プロパティ名	型	必須	更新可否	説明	制約条件
MsgProcessSpec	String	はい	いいえ	メッセージ送信および受信のためのコンピューティング仕様。	なし
AutoScaling	Boolean	いいえ	いいえ	ベース仕様を超えたバーストスケーリングを有効にするかどうかを指定します。	有効な値： true：バーストスケーリングを有効にします。 false：バーストスケーリングを無効にします。バーストスケーリングを有効にすると、ApsaraMQ for RocketMQ は、特定の範囲内でインスタンスがベース仕様の TPS 制限を超えることを許可します。ベース仕様を超えたトラフィックには別途課金されます。説明一部のインスタンスタイプのみがバーストスケーリングをサポートしています。
CapacityType	String	いいえ	いいえ	容量モード。	有効な値： provisioned：プロビジョニング済み + フレキシブル ondemand：従量課金
MessageRetentionTime	Integer	いいえ	はい	メッセージの保存期間。	単位：時間。 ApsaraMQ for RocketMQ 5.0 では、サーバーレスおよびエラスティックなストレージが提供されています。実際の使用ストレージ量に対して課金されます。保存期間を調整することで、ストレージ容量を制御できます。
ProvisionedCapacity	Integer	いいえ	いいえ	プロビジョニング済み容量。	なし
SendReceiveRatio	Number	いいえ	はい	メッセージ送信と受信の比率。	値は 0.2 ～ 0.5 の範囲内である必要があります。

InternetInfo の構文

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

InternetInfo のプロパティ

プロパティ名	型	必須	更新可否	説明	制約条件
InternetSpec	String	はい	はい	パブリックネットワークアクセスを有効にするかどうかを指定します。	有効な値： enable：パブリックネットワークアクセスを有効にします。 disable：パブリックネットワークアクセスを無効にします。デフォルトでは、インスタンスへのアクセスは VPC 経由で行われます。パブリックネットワークアクセスを有効にすると、パブリックアウトバウンドトラフィックに対して課金されます。
FlowOutBandwidth	Integer	いいえ	はい	パブリック帯域幅仕様。	単位：Mbps。このパラメーターは、パブリックネットワークの課金方法が帯域幅課金の場合にのみ必須です。有効な値：1 ～ 1000。
FlowOutType	String	いいえ	いいえ	パブリックネットワークの課金方法。	有効な値： payByBandwidth：帯域幅課金。パブリックネットワークアクセスを有効にする場合にこの値を設定します。 uninvolved：該当なし。パブリックネットワークアクセスを無効にする場合にこの値を設定します。
IpWhitelist	List	いいえ	はい	パブリックネットワークアクセスの IP アドレスホワイトリスト。	IP アドレスホワイトリストは、パブリックエンドポイントに対してのみ設定できます。VPC エンドポイントには対応していません。ホワイトリストを設定しない場合、デフォルトですべての IP アドレスから ApsaraMQ for RocketMQ 5.0 サーバーへパブリックネットワーク経由でアクセスできます。ホワイトリストを設定した場合、ホワイトリストに登録された IP アドレスからのみ、ApsaraMQ for RocketMQ 5.0 サーバーへパブリックネットワーク経由でアクセスできます。

VpcInfo の構文

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

VpcInfo のプロパティ

プロパティ名	型	必須	更新許可済み	説明	制約条件
VpcId	String	はい	いいえ	インスタンスが属する VPC の ID。	説明 ApsaraMQ for RocketMQ 5.0 インスタンスを作成した後は、その VPC を変更することはできません。VPC を変更するには、インスタンスをリリースし、新しいインスタンスを購入する必要があります。
SecurityGroupId	String	いいえ	いいえ	インスタンスが属するセキュリティグループの ID。	なし
VSwitchId	String	いいえ	いいえ	インスタンスが接続されている vSwitch の ID。	説明 ApsaraMQ for RocketMQ 5.0 インスタンスを作成した後は、その vSwitch を変更することはできません。vSwitch を変更するには、インスタンスをリリースし、新しいインスタンスを購入する必要があります。
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: Instance name.
    Value:
      Fn::GetAtt:
        - Instance
        - InstanceName
  VpcEndpoint:
    Description: VPC endpoint.
    Value:
      Fn::GetAtt:
        - Instance
        - VpcEndpoint
  InstanceId:
    Description: Instance ID created.
    Value:
      Fn::GetAtt:
        - Instance
        - InstanceId
  InternetEndpoint:
    Description: Internet endpoint.
    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": "Instance name.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceName"
        ]
      }
    },
    "VpcEndpoint": {
      "Description": "VPC endpoint.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "VpcEndpoint"
        ]
      }
    },
    "InstanceId": {
      "Description": "Instance ID created.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InstanceId"
        ]
      }
    },
    "InternetEndpoint": {
      "Description": "Internet endpoint.",
      "Value": {
        "Fn::GetAtt": [
          "Instance",
          "InternetEndpoint"
        ]
      }
    }
  }
}