ALIYUN::ROCKETMQ5::Instance類型用于創建消息隊列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 | 否 | 否 | 是否自動續費。 | 僅當實例付費類型為Subscription(包年包月)時,該參數生效, 取值:
|
Period | Integer | 否 | 否 | 購買時長。 | 僅當實例付費類型為Subscription(包年包月)時,該參數生效。 取值:
|
InternetInfo | Map | 是 | 是 | 公網配置信息。 | 更多信息,請參見InternetInfo屬性。 |
SubSeriesCode | String | 是 | 否 | 實例的子系列編碼。 | 取值:
說明 實例創建成功后,子系列不支持變更。 子系列間具體差異,請參見產品選型。 |
Remark | String | 否 | 是 | 實例的備注信息。 | 無 |
InstanceName | String | 否 | 是 | 待創建的實例名稱。 | 不填寫則以實例ID作為實例名稱。 |
SeriesCode | String | 是 | 否 | 實例的主系列編碼。 | 取值:
說明 實例創建成功后,主系列只支持單向變更,只升不降,變更方向為:標準版 > 專業版 > 鉑金版。例如,只支持從標準版變更到專業版,不支持從專業版降為標準版。 主系列間的具體差異,請參見產品選型。 |
PaymentType | String | 否 | 否 | 實例的付費類型。 | 取值:
更多信息,請參見計費概述。 |
VpcInfo | Map | 是 | 否 | 專有網絡配置信息。 | 更多信息,請參見VpcInfo屬性。 |
PeriodUnit | String | 否 | 否 | 購買時長的最小周期單位。 | 取值:
|
ProductInfo語法
"ProductInfo": {
"SendReceiveRatio": Number,
"MessageRetentionTime": Integer,
"AutoScaling": Boolean,
"MsgProcessSpec": String
}
ProductInfo屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
SendReceiveRatio | Number | 否 | 是 | 消息發送和接收的比例。 | 取值范圍為0.2~0.5。 |
MessageRetentionTime | Integer | 否 | 是 | 消息保存時長。 | 單位:小時。 取值范圍,請參見資源配額。 消息隊列RocketMQ版5.0系列的消息存儲完全實現Serverless彈性,按照實際存儲空間收取費用,您可以通過調整消息保存時長來控制消息的存儲容量。 更多信息,請參見存儲費用。 |
AutoScaling | Boolean | 否 | 否 | 是否開啟規格外突發彈性能力。 | 取值:
開啟彈性突發能力后,消息隊列RocketMQ允許該實例在一定范圍內超過基礎規格限制的TPS,且超過基礎規格外的部分,需要收取額外的彈性規格費用。 更多信息,請參見消息收發計算規格費用。 說明 僅部分規格的實例支持開啟彈性突發規格能力。 具體支持的實例,請參見實例規格。 |
MsgProcessSpec | String | 是 | 否 | 消息收發計算規格。 | 關于消息收發TPS上限,請參見實例規格。 |
InternetInfo語法
"InternetInfo": {
"IpWhitelist": List,
"InternetSpec": String,
"FlowOutBandwidth": Integer,
"FlowOutType": String
}
InternetInfo屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
IpWhitelist | List | 否 | 是 | 公網訪問IP白名單。 | 僅公網接入點支持配置IP白名單,VPC接入點暫不支持。
|
InternetSpec | String | 是 | 是 | 是否開通公網訪問。 | 取值:
實例默認支持VPC訪問方式,若開啟公網訪問,消息隊列RocketMQ版5.0系列會收取公網下行帶寬費用。 具體計費信息,請參見公網訪問費用。 |
FlowOutBandwidth | Integer | 否 | 是 | 公網帶寬規格。 | 單位:Mb/s。 只有在公網計費類型為按固定帶寬計費的時候才需要填寫。 取值范圍:[1 - 1000]。 |
FlowOutType | String | 否 | 否 | 公網計費類型。 | 參數取值如下:
|
VpcInfo語法
"VpcInfo": {
"VpcId": String,
"VSwitchId": String,
"SecurityGroupId": String,
"VSwitchIds": List
}
VpcInfo屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
VpcId | String | 是 | 否 | 待創建實例所關聯的專有網絡的ID。 | 說明 消息隊列RocketMQ版5.0系列實例創建后,選擇的VPC不支持變更。若要修改關聯的VPC,您需要先釋放已購買的消息隊列RocketMQ版5.0系列實例,再重新購買。 |
VSwitchId | String | 否 | 否 | 實例所關聯的交換機ID。 | 說明 消息隊列RocketMQ版5.0系列實例創建后,選擇的交換機不支持變更。若要修改關聯的交換機,您需要先釋放已購買的消息隊列RocketMQ版5.0系列實例,再重新購買。 |
SecurityGroupId | String | 否 | 否 | 實例所屬的安全組ID。 | 無 |
VSwitchIds | List | 否 | 否 | 實例所關聯的交換機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"
]
}
}
}
}