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

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 Name	Type	Required	Update allowed	Description	Constraints
InternetInfo	Map	Yes	Yes	The public network configuration.	For more information, see InternetInfo properties.
ProductInfo	Map	Yes	Yes	The instance specifications.	For more information, see ProductInfo properties.
SeriesCode	String	Yes	No	The primary 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 primary series (Standard Edition > Professional Edition > Platinum Edition). Downgrades are not supported.
SubSeriesCode	String	Yes	No	The sub-series code of the instance.	Valid values: cluster_ha: High-availability Cluster Edition. If you set the primary series to `ultimate` (Platinum Edition), you must set the sub-series to `cluster_ha` (High-availability Cluster Edition). single_node: Single-node Edition for testing. serverless: Serverless instance Note After an instance is created, you cannot change its sub-series.
VpcInfo	Map	Yes	No	The VPC configuration.	For more information, see VpcInfo properties.
AutoRenew	Boolean	No	No	Whether to enable auto-renewal.	This parameter is valid only if the billing method of the instance is `Subscription`. Valid values: true: Enables auto-renewal. false: Disables auto-renewal.
AutoRenewPeriod	Integer	No	No	The auto-renewal period.	This parameter is valid only if auto-renewal is enabled. Unit: months. Valid values: For monthly renewal: 1, 2, 3, 6, and 12.
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.
PaymentType	String	No	No	The billing method of the instance.	Valid values: PayAsYouGo: Pay-as-you-go. You are billed based on actual resource usage. Subscription: You pay upfront for a fixed duration.
Period	Integer	No	No	The subscription duration.	This parameter is valid only if the billing method of the instance is `Subscription`. Valid values: If you purchase by month: 1, 2, 3, 4, 5, and 6. If you purchase by year: 1, 2, and 3.
PeriodUnit	String	No	No	The unit of the subscription duration.	Valid values: Month: The subscription duration is measured in months. Year: The subscription duration is measured in years.
Remark	String	No	Yes	The remarks on the instance.	None
ResourceGroupId	String	No	No	The ID of the resource group.	None

ProductInfo syntax

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

ProductInfo properties

Property Name	Type	Required	Update allowed	Description	Constraints
MsgProcessSpec	String	Yes	No	The computing specification for message sending and receiving.	None
AutoScaling	Boolean	No	No	Whether to enable burst scaling beyond the specifications.	Valid values: true: Enables burst scaling. false: Disables burst scaling. When enabled, the instance can exceed its base TPS limit within a specific range. You are charged for traffic that exceeds the base specifications. Note Only some instance types support burst scaling.
CapacityType	String	No	No	The capacity mode.	Valid values: provisioned: provisioned + flexible ondemand: pay-as-you-go
MessageRetentionTime	Integer	No	Yes	The message retention period.	Unit: hours. ApsaraMQ for RocketMQ 5.0 uses serverless elastic storage, billed by actual usage. Adjust the message retention period to control your storage capacity.
ProvisionedCapacity	Integer	No	No	The provisioned capacity.	None
SendReceiveRatio	Number	No	Yes	The ratio of message sending to receiving.	The value must be between 0.2 and 0.5.

InternetInfo syntax

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

InternetInfo properties

Property Name	Type	Required	Update allowed	Description	Constraints
InternetSpec	String	Yes	Yes	Whether to enable public network access.	Valid values: enable: Enables public network access. disable: Disables public network access. By default, instances are accessed over a VPC. If you enable public network access, you are charged for outbound public bandwidth.
FlowOutBandwidth	Integer	No	Yes	Public bandwidth specification	Unit: Mbps. This parameter is required only when the public network billing type is pay-by-bandwidth. Valid values: 1 to 1000.
FlowOutType	String	No	No	The public network billing type.	Valid values: payByBandwidth: pay-by-bandwidth. Set the parameter to this value when public network access is enabled. uninvolved: not applicable. Set the parameter to this value when public network access is disabled.
IpWhitelist	List	No	Yes	The IP address whitelist for public network access.	IP address whitelists apply only to public endpoints, not VPC endpoints. If no whitelist is configured, all IP addresses can access the instance over the public network. If a whitelist is configured, only the whitelisted IP addresses can access the instance over the public network.

VpcInfo syntax

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

VpcInfo properties

Property Name	Type	Required	Update allowed	Description	Constraints
VpcId	String	Yes	No	The ID of the VPC to which the instance belongs.	Note The VPC cannot be changed after the instance is created. To use a different VPC, release the instance and create a new one.
SecurityGroupId	String	No	No	The ID of the security group to which the instance belongs.	None
VSwitchId	String	No	No	The ID of the vSwitch to which the instance is connected.	Note The vSwitch cannot be changed after the instance is created. To use a different vSwitch, release the instance and create a new one.
VSwitchIds	List	No	No	A list of vSwitch IDs to which the instance is connected.	None

Return values

Fn::GetAtt

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

Examples

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