如何使用ROCKETMQALIYUN::ROCKETMQ5::Instance類型 -

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（訂用帳戶）時，該參數生效，取值： true：開啟自動續約。 false：不開啟自動續約。
Period	Integer	否	否	購買時間長度。	僅當執行個體付費類型為Subscription（訂用帳戶）時，該參數生效。取值：按月購買：1、2、3、4、5、6。按年購買：1、2、3。
InternetInfo	Map	是	是	公網配置資訊。	更多資訊，請參見InternetInfo屬性。
SubSeriesCode	String	是	否	執行個體的子系列編碼。	取值： cluster_ha：叢集高可用版。當主系列選擇ultimate（鉑金版）時，子系列只能選擇為cluster_ha（叢集高可用版）。 single_node：單節點測試版。說明執行個體建立成功後，子系列不支援變更。
Remark	String	否	是	執行個體的備忘資訊。	無
InstanceName	String	否	是	待建立的執行個體名稱。	不填寫則以執行個體ID作為執行個體名稱。
SeriesCode	String	是	否	執行個體的主系列編碼。	取值： standard：標準版 ultimate：鉑金版 professional：專業版說明執行個體建立成功後，主系列只支援單向變更，只升不降，變更方向為：標準版 > 專業版 > 鉑金版。例如，只支援從標準版變更到專業版，不支援從專業版降為標準版。
PaymentType	String	否	否	執行個體的付費類型。	取值： PayAsYouGo：隨用隨付，一種後付費模式，即先使用再付費。 Subscription：訂用帳戶，一種預付費模式，即先付費再使用。
VpcInfo	Map	是	否	專用網路配置資訊。	更多資訊，請參見VpcInfo屬性。
PeriodUnit	String	否	否	購買時間長度的最小周期單位。	取值： Month：按月購買。 Year：按年購買。

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	否	否	是否開啟規格外突發彈效能力。	取值： true：開啟彈效能力。 false：不開啟彈效能力。開啟彈性突發能力後，訊息佇列RocketMQ允許該執行個體在一定範圍內超過基礎規格限制的TPS，且超過基礎規格外的部分，需要收取額外的彈性規格費用。說明僅部分規格的執行個體支援開啟彈性突發規格能力。
MsgProcessSpec	String	是	否	訊息收發計算規格。	無

InternetInfo文法

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

InternetInfo屬性

屬性名稱	類型	必須	允許更新	描述	約束
IpWhitelist	List	否	是	公網訪問IP白名單。	僅公網存取點支援配置IP白名單，VPC存取點暫不支援。若不配置IP白名單，則預設所有IP位址區段通過公網訪問訊息佇列RocketMQ版5.0系列服務端。若配置IP白名單，則僅允許白名單內的IP地址通過公網訪問訊息佇列RocketMQ版5.0系列服務端。
InternetSpec	String	是	是	是否開通公網訪問。	取值： enable：開啟公網訪問。 disable：關閉公網訪問。執行個體預設支援VPC訪問方式，若開啟公網訪問，訊息佇列RocketMQ版5.0系列會收取公網下行頻寬費用。
FlowOutBandwidth	Integer	否	是	公網頻寬規格。	單位：Mb/s。只有在公網計費類型為按固定頻寬計費的時候才需要填寫。取值範圍：[1 - 1000]。
FlowOutType	String	否	否	公網計費類型。	參數取值如下： payByBandwidth：固定頻寬計費，開啟公網訪問時，設定為該參數值。 uninvolved：不涉及，未開啟公網訪問時，設定為該參數值。

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

文法

屬性

ProductInfo文法

ProductInfo屬性

InternetInfo文法

InternetInfo屬性

VpcInfo文法

VpcInfo屬性

傳回值

樣本

YAML格式

JSON格式

`YAML`格式

`JSON`格式