ALIYUN::ROCKETMQ5::Instance - Resource Orchestration Service - Centro de documentación de Alibaba Cloud

Crea una instancia de ApsaraMQ for RocketMQ 5.0.

Sintaxis

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

Propiedades

Nombre de la propiedad	Tipo	Obligatorio	Actualización permitida	Descripción	Restricciones
InternetInfo	Map	Sí	Sí	Configuración de red pública.	Para obtener más información, consulte InternetInfo properties.
ProductInfo	Map	Sí	Sí	Especificaciones de la instancia.	Para obtener más información, consulte ProductInfo properties.
SeriesCode	String	Sí	No	Código de serie principal de la instancia.	Valores válidos: standard: Standard Edition ultimate: Platinum Edition professional: Professional Edition Nota Una vez creada la instancia, solo puede actualizar su serie principal (Standard Edition > Professional Edition > Platinum Edition). No se admiten reducciones de categoría.
SubSeriesCode	String	Sí	No	Código de subserie de la instancia.	Valores válidos: cluster_ha: High-availability Cluster Edition. Si establece la serie principal en `ultimate` (Platinum Edition), debe establecer la subserie en `cluster_ha` (High-availability Cluster Edition). single_node: Single-node Edition para pruebas. serverless: Instancia serverless Nota Una vez creada la instancia, no puede cambiar su subserie.
VpcInfo	Map	Sí	No	Configuración de VPC.	Para obtener más información, consulte VpcInfo properties.
AutoRenew	Boolean	No	No	Indica si se habilita la renovación automática.	Este parámetro solo es válido si el método de facturación de la instancia es `Subscription`. Valores válidos: true: Habilita la renovación automática. false: Deshabilita la renovación automática.
AutoRenewPeriod	Integer	No	No	Periodo de renovación automática.	Este parámetro solo es válido si la renovación automática está habilitada. Unidad: meses. Valores válidos: Para renovación mensual: 1, 2, 3, 6 y 12.
InstanceName	String	No	Sí	Nombre de la instancia por crear.	Si no especifica este parámetro, se utiliza el ID de la instancia como nombre.
PaymentType	String	No	No	Método de facturación de la instancia.	Valores válidos: PayAsYouGo: pay-as-you-go. Se le factura según el uso real de recursos. Subscription: Pago por adelantado por una duración fija.
Period	Integer	No	No	Duración de la suscripción.	Este parámetro solo es válido si el método de facturación de la instancia es `Subscription`. Valores válidos: Si compra por mes: 1, 2, 3, 4, 5 y 6. Si compra por año: 1, 2 y 3.
PeriodUnit	String	No	No	Unidad de duración de la suscripción.	Valores válidos: Month: La duración de la suscripción se mide en meses. Year: La duración de la suscripción se mide en años.
Remark	String	No	Sí	Comentarios sobre la instancia.	Ninguna
ResourceGroupId	String	No	No	ID del resource group.	Ninguna

Sintaxis de ProductInfo

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

Propiedades de ProductInfo

Nombre de la propiedad	Tipo	Obligatorio	Actualización permitida	Descripción	Restricciones
MsgProcessSpec	String	Sí	No	Especificación de cómputo para el envío y recepción de mensajes.	Ninguna
AutoScaling	Boolean	No	No	Indica si se habilita el escalado bajo demanda más allá de las especificaciones.	Valores válidos: true: Habilita el escalado bajo demanda. false: Deshabilita el escalado bajo demanda. Cuando está habilitado, la instancia puede superar su límite base de TPS dentro de un rango específico. Se le cobra por el tráfico que exceda las especificaciones base. Nota Solo algunos tipos de instancia son compatibles con el escalado bajo demanda.
CapacityType	String	No	No	Modo de capacidad.	Valores válidos: provisioned: aprovisionada + flexible ondemand: pay-as-you-go
MessageRetentionTime	Integer	No	Sí	Periodo de retención de mensajes.	Unidad: horas. ApsaraMQ for RocketMQ 5.0 utiliza almacenamiento elástico serverless, facturado según el uso real. Ajuste el periodo de retención de mensajes para controlar su capacidad de almacenamiento.
ProvisionedCapacity	Integer	No	No	Capacidad aprovisionada.	Ninguna
SendReceiveRatio	Number	No	Sí	Proporción entre el envío y la recepción de mensajes.	El valor debe estar entre 0.2 y 0.5.

Sintaxis de InternetInfo

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

Propiedades de InternetInfo

Nombre de la propiedad	Tipo	Obligatorio	Actualización permitida	Descripción	Restricciones
InternetSpec	String	Sí	Sí	Indica si se habilita el acceso a la red pública.	Valores válidos: enable: Habilita el acceso a la red pública. disable: Deshabilita el acceso a la red pública. De forma predeterminada, se accede a las instancias a través de una VPC. Si habilita el acceso a la red pública, se le cobrará por el ancho de banda público de salida.
FlowOutBandwidth	Integer	No	Sí	Especificación de ancho de banda público	Unidad: Mbps. Este parámetro es obligatorio solo cuando el tipo de facturación de red pública es por ancho de banda. Valores válidos: de 1 a 1000.
FlowOutType	String	No	No	Tipo de facturación de red pública.	Valores válidos: payByBandwidth: facturación por ancho de banda. Establezca el parámetro en este valor cuando el acceso a la red pública esté habilitado. uninvolved: no aplica. Establezca el parámetro en este valor cuando el acceso a la red pública esté deshabilitado.
IpWhitelist	List	No	Sí	Lista blanca de direcciones IP para el acceso a la red pública.	Las listas blancas de direcciones IP solo aplican a endpoints públicos, no a endpoints de VPC. Si no se configura ninguna lista blanca, todas las direcciones IP pueden acceder a la instancia a través de la red pública. Si se configura una lista blanca, solo las direcciones IP incluidas en ella pueden acceder a la instancia a través de la red pública.

Sintaxis de VpcInfo

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

Propiedades de VpcInfo

Nombre de la propiedad	Tipo	Obligatorio	Actualización permitida	Descripción	Restricciones
VpcId	String	Sí	No	ID de la VPC a la que pertenece la instancia.	Nota La VPC no se puede cambiar después de crear la instancia. Para usar una VPC diferente, libere la instancia y cree una nueva.
SecurityGroupId	String	No	No	ID del security group al que pertenece la instancia.	Ninguna
VSwitchId	String	No	No	ID del vSwitch al que está conectada la instancia.	Nota El vSwitch no se puede cambiar después de crear la instancia. Para usar un vSwitch diferente, libere la instancia y cree una nueva.
VSwitchIds	List	No	No	Lista de IDs de vSwitch a los que está conectada la instancia.	Ninguna

Valores de retorno

Fn::GetAtt

InstanceName: Nombre de la instancia.
VpcEndpoint: Nombre de dominio de la VPC.
InstanceId: ID de la instancia.
InternetEndpoint: Endpoint público de la instancia.

Ejemplos

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