How to use the ALIYUN::ROCKETMQ5::Instance resource type - Resource Orchestration Service

The ALIYUN::ROCKETMQ5::Instance resource type creates an ApsaraMQ for RocketMQ 5.0 instance.

Syntax

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

Properties

Property	Type	Required	Update allowed	Description	Constraint
AutoRenewPeriod	Integer	No	No	The auto-renewal period.	This property takes effect only when auto-renewal is enabled for the instance. The unit is months. Value: Valid values for monthly renewal: 1, 2, 3, 6, and 12.
ProductInfo	Map	Yes	Yes	The instance specification information.	For more information, see ProductInfo properties.
ResourceGroupId	String	No	No	The ID of the resource group.	None.
AutoRenew	Boolean	No	No	Specifies whether to enable auto-renewal.	This parameter is valid only for subscription instances. Valid values: true: Auto-renewal is enabled. false: Auto-renewal is disabled.
Period	Integer	No	No	The subscription duration.	This parameter is valid only for subscription instances. Valid values: If PeriodUnit is set to Month: 1, 2, 3, 4, 5, and 6. If PeriodUnit is set to Year: 1, 2, and 3.
InternetInfo	Map	Yes	Yes	The Internet access configurations.	For more information, see InternetInfo properties.
SubSeriesCode	String	Yes	No	The sub-series code of the instance.	Valid values: cluster_ha: High-availability Cluster Edition. If you set the series to ultimate (Platinum Edition), you must set the sub-series to cluster_ha (High-availability Cluster Edition). single_node: Single-node Edition. serverless: Serverless instance Note After an instance is created, you cannot change its sub-series.
Remark	String	No	Yes	The remarks on the instance.	None.
InstanceName	String	No	Yes	The name of the instance to create.	If you do not specify this parameter, the instance ID is used as the instance name.
SeriesCode	String	Yes	No	The series code of the instance.	Valid values: standard: Standard Edition ultimate: Platinum Edition professional: Professional Edition Note After an instance is created, you can only upgrade its series. You cannot downgrade the series. The upgrade path is: Standard Edition > Professional Edition > Platinum Edition. For example, you can upgrade an instance from Standard Edition to Professional Edition, but you cannot downgrade an instance from Professional Edition to Standard Edition.
PaymentType	String	No	No	The billing method of the instance.	Valid values: PayAsYouGo: A post-paid billing method where you pay after use. Subscription: A prepaid billing method where you pay before use.
VpcInfo	Map	Yes	No	The VPC configurations.	For more information, see VpcInfo properties.
PeriodUnit	String	No	No	The unit of the subscription duration.	Valid values: Month: Purchase on a monthly basis. Year: Purchase on a yearly basis.

ProductInfo syntax

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

ProductInfo properties

Property	Type	Required	Update allowed	Description	Constraint
SendReceiveRatio	Number	No	Yes	The ratio of messages sent to messages received.	The value must be between 0.2 and 0.5, inclusive.
MessageRetentionTime	Integer	No	Yes	The message retention period.	Unit: hours. The message storage for ApsaraMQ for RocketMQ 5.0 is serverless and elastic. You are charged for the actual storage that you use. You can adjust the message retention period to control storage capacity.
AutoScaling	Boolean	No	No	Specifies whether to enable the elastic TPS feature.	Valid values: true: The elastic TPS feature is enabled. false: The elastic TPS feature is disabled. If you enable this feature, the instance can exceed its base TPS limit within a specific range. You are charged for the TPS that exceeds the base specification. Note This feature is supported only by specific instance types.
MsgProcessSpec	String	Yes	No	The computing specification for message sending and receiving.	None.

InternetInfo syntax

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

InternetInfo properties

Property	Type	Required	Update allowed	Description	Constraint
IpWhitelist	List	No	Yes	The IP address whitelist for Internet access.	You can configure an IP whitelist only for an Internet endpoint. VPC endpoints do not support IP whitelists. If you do not configure an IP whitelist, all IP addresses can access the ApsaraMQ for RocketMQ 5.0 service over the Internet. If you configure an IP whitelist, only the IP addresses in the whitelist can access the ApsaraMQ for RocketMQ 5.0 service over the Internet.
InternetSpec	String	Yes	Yes	Specifies whether to enable Internet access.	Valid values: enable: Internet access is enabled. disable: Internet access is disabled. By default, instances support access over a VPC. If you enable Internet access, you are charged for outbound Internet traffic.
FlowOutBandwidth	Integer	No	Yes	The Internet bandwidth.	Unit: Mbit/s. This parameter is required only when the billing method for Internet access is pay-by-bandwidth. Value range: 1 to 1,000.
FlowOutType	String	No	No	The billing method for Internet access.	Valid values: payByBandwidth: The pay-by-bandwidth billing method. Set the parameter to this value when you enable Internet access. uninvolved: Not applicable. Set the parameter to this value when you disable Internet access.

VpcInfo syntax

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

VpcInfo properties

Property	Type	Required	Update allowed	Description	Constraint
VpcId	String	Yes	No	The ID of the VPC to which the instance belongs.	Note After an ApsaraMQ for RocketMQ 5.0 instance is created, you cannot change its VPC. To change the VPC, release the instance and create a new one.
VSwitchId	String	No	No	The ID of the vSwitch to which the instance belongs.	Note After an ApsaraMQ for RocketMQ 5.0 instance is created, you cannot change its vSwitch. To change the vSwitch, release the instance and create a new one.
SecurityGroupId	String	No	No	The ID of the security group to which the instance belongs.	None.
VSwitchIds	List	No	No	The IDs of the vSwitches to which the instance belongs.	None.

Return values

Fn::GetAtt

InstanceName: The name of the instance.
VpcEndpoint: The VPC endpoint.
InstanceId: The ID of the instance.
InternetEndpoint: The Internet endpoint of the instance.

Examples

`YAML` format

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` format

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

Syntax

Properties

ProductInfo syntax

ProductInfo properties

InternetInfo syntax

InternetInfo properties

VpcInfo syntax

VpcInfo properties

Return values

Examples

YAML format

JSON format

`YAML` format

`JSON` format