alicloud.rocketmq.RocketMQInstance
Explore with Pulumi AI
Import
RocketMQ Instance can be imported using the id, e.g.
$ pulumi import alicloud:rocketmq/rocketMQInstance:RocketMQInstance example <id>
Create RocketMQInstance Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RocketMQInstance(name: string, args: RocketMQInstanceArgs, opts?: CustomResourceOptions);
@overload
def RocketMQInstance(resource_name: str,
args: RocketMQInstanceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RocketMQInstance(resource_name: str,
opts: Optional[ResourceOptions] = None,
network_info: Optional[RocketMQInstanceNetworkInfoArgs] = None,
sub_series_code: Optional[str] = None,
service_code: Optional[str] = None,
series_code: Optional[str] = None,
payment_type: Optional[str] = None,
commodity_code: Optional[str] = None,
remark: Optional[str] = None,
instance_name: Optional[str] = None,
acl_info: Optional[RocketMQInstanceAclInfoArgs] = None,
period: Optional[int] = None,
period_unit: Optional[str] = None,
product_info: Optional[RocketMQInstanceProductInfoArgs] = None,
ip_whitelists: Optional[Sequence[str]] = None,
resource_group_id: Optional[str] = None,
auto_renew_period_unit: Optional[str] = None,
auto_renew_period: Optional[int] = None,
software: Optional[RocketMQInstanceSoftwareArgs] = None,
auto_renew: Optional[bool] = None,
tags: Optional[Mapping[str, str]] = None)
func NewRocketMQInstance(ctx *Context, name string, args RocketMQInstanceArgs, opts ...ResourceOption) (*RocketMQInstance, error)
public RocketMQInstance(string name, RocketMQInstanceArgs args, CustomResourceOptions? opts = null)
public RocketMQInstance(String name, RocketMQInstanceArgs args)
public RocketMQInstance(String name, RocketMQInstanceArgs args, CustomResourceOptions options)
type: alicloud:rocketmq:RocketMQInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args RocketMQInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args RocketMQInstanceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args RocketMQInstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RocketMQInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RocketMQInstanceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var rocketMQInstanceResource = new AliCloud.RocketMQ.RocketMQInstance("rocketMQInstanceResource", new()
{
NetworkInfo = new AliCloud.RocketMQ.Inputs.RocketMQInstanceNetworkInfoArgs
{
InternetInfo = new AliCloud.RocketMQ.Inputs.RocketMQInstanceNetworkInfoInternetInfoArgs
{
FlowOutType = "string",
InternetSpec = "string",
FlowOutBandwidth = 0,
},
VpcInfo = new AliCloud.RocketMQ.Inputs.RocketMQInstanceNetworkInfoVpcInfoArgs
{
VpcId = "string",
SecurityGroupIds = "string",
Vswitches = new[]
{
new AliCloud.RocketMQ.Inputs.RocketMQInstanceNetworkInfoVpcInfoVswitchArgs
{
VswitchId = "string",
},
},
},
Endpoints = new[]
{
new AliCloud.RocketMQ.Inputs.RocketMQInstanceNetworkInfoEndpointArgs
{
EndpointType = "string",
EndpointUrl = "string",
IpWhiteLists = new[]
{
"string",
},
},
},
},
SubSeriesCode = "string",
ServiceCode = "string",
SeriesCode = "string",
PaymentType = "string",
CommodityCode = "string",
Remark = "string",
InstanceName = "string",
AclInfo = new AliCloud.RocketMQ.Inputs.RocketMQInstanceAclInfoArgs
{
AclTypes = new[]
{
"string",
},
DefaultVpcAuthFree = false,
},
Period = 0,
PeriodUnit = "string",
ProductInfo = new AliCloud.RocketMQ.Inputs.RocketMQInstanceProductInfoArgs
{
MsgProcessSpec = "string",
AutoScaling = false,
MessageRetentionTime = 0,
SendReceiveRatio = 0,
StorageEncryption = false,
StorageSecretKey = "string",
SupportAutoScaling = false,
TraceOn = false,
},
IpWhitelists = new[]
{
"string",
},
ResourceGroupId = "string",
AutoRenewPeriodUnit = "string",
AutoRenewPeriod = 0,
Software = new AliCloud.RocketMQ.Inputs.RocketMQInstanceSoftwareArgs
{
MaintainTime = "string",
SoftwareVersion = "string",
UpgradeMethod = "string",
},
AutoRenew = false,
Tags =
{
{ "string", "string" },
},
});
example, err := rocketmq.NewRocketMQInstance(ctx, "rocketMQInstanceResource", &rocketmq.RocketMQInstanceArgs{
NetworkInfo: &rocketmq.RocketMQInstanceNetworkInfoArgs{
InternetInfo: &rocketmq.RocketMQInstanceNetworkInfoInternetInfoArgs{
FlowOutType: pulumi.String("string"),
InternetSpec: pulumi.String("string"),
FlowOutBandwidth: pulumi.Int(0),
},
VpcInfo: &rocketmq.RocketMQInstanceNetworkInfoVpcInfoArgs{
VpcId: pulumi.String("string"),
SecurityGroupIds: pulumi.String("string"),
Vswitches: rocketmq.RocketMQInstanceNetworkInfoVpcInfoVswitchArray{
&rocketmq.RocketMQInstanceNetworkInfoVpcInfoVswitchArgs{
VswitchId: pulumi.String("string"),
},
},
},
Endpoints: rocketmq.RocketMQInstanceNetworkInfoEndpointArray{
&rocketmq.RocketMQInstanceNetworkInfoEndpointArgs{
EndpointType: pulumi.String("string"),
EndpointUrl: pulumi.String("string"),
IpWhiteLists: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
SubSeriesCode: pulumi.String("string"),
ServiceCode: pulumi.String("string"),
SeriesCode: pulumi.String("string"),
PaymentType: pulumi.String("string"),
CommodityCode: pulumi.String("string"),
Remark: pulumi.String("string"),
InstanceName: pulumi.String("string"),
AclInfo: &rocketmq.RocketMQInstanceAclInfoArgs{
AclTypes: pulumi.StringArray{
pulumi.String("string"),
},
DefaultVpcAuthFree: pulumi.Bool(false),
},
Period: pulumi.Int(0),
PeriodUnit: pulumi.String("string"),
ProductInfo: &rocketmq.RocketMQInstanceProductInfoArgs{
MsgProcessSpec: pulumi.String("string"),
AutoScaling: pulumi.Bool(false),
MessageRetentionTime: pulumi.Int(0),
SendReceiveRatio: pulumi.Float64(0),
StorageEncryption: pulumi.Bool(false),
StorageSecretKey: pulumi.String("string"),
SupportAutoScaling: pulumi.Bool(false),
TraceOn: pulumi.Bool(false),
},
IpWhitelists: pulumi.StringArray{
pulumi.String("string"),
},
ResourceGroupId: pulumi.String("string"),
AutoRenewPeriodUnit: pulumi.String("string"),
AutoRenewPeriod: pulumi.Int(0),
Software: &rocketmq.RocketMQInstanceSoftwareArgs{
MaintainTime: pulumi.String("string"),
SoftwareVersion: pulumi.String("string"),
UpgradeMethod: pulumi.String("string"),
},
AutoRenew: pulumi.Bool(false),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var rocketMQInstanceResource = new RocketMQInstance("rocketMQInstanceResource", RocketMQInstanceArgs.builder()
.networkInfo(RocketMQInstanceNetworkInfoArgs.builder()
.internetInfo(RocketMQInstanceNetworkInfoInternetInfoArgs.builder()
.flowOutType("string")
.internetSpec("string")
.flowOutBandwidth(0)
.build())
.vpcInfo(RocketMQInstanceNetworkInfoVpcInfoArgs.builder()
.vpcId("string")
.securityGroupIds("string")
.vswitches(RocketMQInstanceNetworkInfoVpcInfoVswitchArgs.builder()
.vswitchId("string")
.build())
.build())
.endpoints(RocketMQInstanceNetworkInfoEndpointArgs.builder()
.endpointType("string")
.endpointUrl("string")
.ipWhiteLists("string")
.build())
.build())
.subSeriesCode("string")
.serviceCode("string")
.seriesCode("string")
.paymentType("string")
.commodityCode("string")
.remark("string")
.instanceName("string")
.aclInfo(RocketMQInstanceAclInfoArgs.builder()
.aclTypes("string")
.defaultVpcAuthFree(false)
.build())
.period(0)
.periodUnit("string")
.productInfo(RocketMQInstanceProductInfoArgs.builder()
.msgProcessSpec("string")
.autoScaling(false)
.messageRetentionTime(0)
.sendReceiveRatio(0)
.storageEncryption(false)
.storageSecretKey("string")
.supportAutoScaling(false)
.traceOn(false)
.build())
.ipWhitelists("string")
.resourceGroupId("string")
.autoRenewPeriodUnit("string")
.autoRenewPeriod(0)
.software(RocketMQInstanceSoftwareArgs.builder()
.maintainTime("string")
.softwareVersion("string")
.upgradeMethod("string")
.build())
.autoRenew(false)
.tags(Map.of("string", "string"))
.build());
rocket_mq_instance_resource = alicloud.rocketmq.RocketMQInstance("rocketMQInstanceResource",
network_info={
"internet_info": {
"flow_out_type": "string",
"internet_spec": "string",
"flow_out_bandwidth": 0,
},
"vpc_info": {
"vpc_id": "string",
"security_group_ids": "string",
"vswitches": [{
"vswitch_id": "string",
}],
},
"endpoints": [{
"endpoint_type": "string",
"endpoint_url": "string",
"ip_white_lists": ["string"],
}],
},
sub_series_code="string",
service_code="string",
series_code="string",
payment_type="string",
commodity_code="string",
remark="string",
instance_name="string",
acl_info={
"acl_types": ["string"],
"default_vpc_auth_free": False,
},
period=0,
period_unit="string",
product_info={
"msg_process_spec": "string",
"auto_scaling": False,
"message_retention_time": 0,
"send_receive_ratio": 0,
"storage_encryption": False,
"storage_secret_key": "string",
"support_auto_scaling": False,
"trace_on": False,
},
ip_whitelists=["string"],
resource_group_id="string",
auto_renew_period_unit="string",
auto_renew_period=0,
software={
"maintain_time": "string",
"software_version": "string",
"upgrade_method": "string",
},
auto_renew=False,
tags={
"string": "string",
})
const rocketMQInstanceResource = new alicloud.rocketmq.RocketMQInstance("rocketMQInstanceResource", {
networkInfo: {
internetInfo: {
flowOutType: "string",
internetSpec: "string",
flowOutBandwidth: 0,
},
vpcInfo: {
vpcId: "string",
securityGroupIds: "string",
vswitches: [{
vswitchId: "string",
}],
},
endpoints: [{
endpointType: "string",
endpointUrl: "string",
ipWhiteLists: ["string"],
}],
},
subSeriesCode: "string",
serviceCode: "string",
seriesCode: "string",
paymentType: "string",
commodityCode: "string",
remark: "string",
instanceName: "string",
aclInfo: {
aclTypes: ["string"],
defaultVpcAuthFree: false,
},
period: 0,
periodUnit: "string",
productInfo: {
msgProcessSpec: "string",
autoScaling: false,
messageRetentionTime: 0,
sendReceiveRatio: 0,
storageEncryption: false,
storageSecretKey: "string",
supportAutoScaling: false,
traceOn: false,
},
ipWhitelists: ["string"],
resourceGroupId: "string",
autoRenewPeriodUnit: "string",
autoRenewPeriod: 0,
software: {
maintainTime: "string",
softwareVersion: "string",
upgradeMethod: "string",
},
autoRenew: false,
tags: {
string: "string",
},
});
type: alicloud:rocketmq:RocketMQInstance
properties:
aclInfo:
aclTypes:
- string
defaultVpcAuthFree: false
autoRenew: false
autoRenewPeriod: 0
autoRenewPeriodUnit: string
commodityCode: string
instanceName: string
ipWhitelists:
- string
networkInfo:
endpoints:
- endpointType: string
endpointUrl: string
ipWhiteLists:
- string
internetInfo:
flowOutBandwidth: 0
flowOutType: string
internetSpec: string
vpcInfo:
securityGroupIds: string
vpcId: string
vswitches:
- vswitchId: string
paymentType: string
period: 0
periodUnit: string
productInfo:
autoScaling: false
messageRetentionTime: 0
msgProcessSpec: string
sendReceiveRatio: 0
storageEncryption: false
storageSecretKey: string
supportAutoScaling: false
traceOn: false
remark: string
resourceGroupId: string
seriesCode: string
serviceCode: string
software:
maintainTime: string
softwareVersion: string
upgradeMethod: string
subSeriesCode: string
tags:
string: string
RocketMQInstance Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The RocketMQInstance resource accepts the following input properties:
- Network
Info Pulumi.Ali Cloud. Rocket MQ. Inputs. Rocket MQInstance Network Info - Instance network configuration information See
network_info
below. - Payment
Type string The payment type for the instance. Alibaba Cloud Message Queue RocketMQ version supports two types of payment:
The parameter values are as follows:
- PayAsYouGo: Pay-as-you-go, a post-payment model where you pay after usage.
- Subscription: Subscription-based, a pre-payment model where you pay before usage.
For more information, please refer to Billing Methods.
- Series
Code string The primary series encoding for the instance. For specific differences between the primary series, please refer to Product Selection.
The parameter values are as follows:
- standard: Standard Edition
- ultimate: Platinum Edition
- professional: Professional Edition
- Service
Code string - The code of the service code instance. The code of the RocketMQ is rmq.
- Sub
Series stringCode The sub-series encoding for the instance. For specific differences between the sub-series, please refer to Product Selection.
The parameter values are as follows:
- cluster_ha: Cluster High Availability Edition
- single_node: Single Node Testing Edition
- serverless:Serverless instance
NOTE: From version 1.245.0,
sub_series_code
can be set toserverless
. When selecting the primary series as ultimate (Platinum Edition), the sub-series can only be chosen as cluster_ha (Cluster High Availability Edition).
- Acl
Info Pulumi.Ali Cloud. Rocket MQ. Inputs. Rocket MQInstance Acl Info - The access control list for the instance. See
acl_info
below. - Auto
Renew bool - Whether to enable auto-renewal. This parameter is only applicable when the payment type for the instance is Subscription (prepaid).
- true: Enable auto-renewal
- false: Disable auto-renewal
- Auto
Renew intPeriod Auto-renewal period. This parameter is only valid when auto-renewal is enabled. Unit: months.
The values can be as follows:
- Monthly renewal: 1, 2, 3, 6, 12
- Auto
Renew stringPeriod Unit - The minimum periodic unit for the duration of auto-renewal. This parameter is only valid when auto-renewal is enabled. Valid values:
Month
,Year
. - Commodity
Code string Commodity code
ons_rmqsub_public_cn: Package year and month instance
ons_rmqpost_public_cn: Pay-As-You-Go instance
Next: Serverless instances
- Instance
Name string - The name of instance
- Ip
Whitelists List<string> - The ip whitelist.
- Period int
Duration of purchase. This parameter is only valid when the payment type for the instance is Subscription (prepaid).
The values can be as follows:
- Monthly purchase: 1, 2, 3, 4, 5, 6
- Annual purchase: 1, 2, 3
- Period
Unit string The minimum periodic unit for the duration of purchase.
The parameter values are as follows:
- Month: Purchase on a monthly basis
- Year: Purchase on an annual basis
- Product
Info Pulumi.Ali Cloud. Rocket MQ. Inputs. Rocket MQInstance Product Info - product info See
product_info
below. - Remark string
- Custom description
- Resource
Group stringId - The ID of the resource group
- Software
Pulumi.
Ali Cloud. Rocket MQ. Inputs. Rocket MQInstance Software - Instance software information. See
software
below. - Dictionary<string, string>
- The resource label.
- Network
Info RocketMQInstance Network Info Args - Instance network configuration information See
network_info
below. - Payment
Type string The payment type for the instance. Alibaba Cloud Message Queue RocketMQ version supports two types of payment:
The parameter values are as follows:
- PayAsYouGo: Pay-as-you-go, a post-payment model where you pay after usage.
- Subscription: Subscription-based, a pre-payment model where you pay before usage.
For more information, please refer to Billing Methods.
- Series
Code string The primary series encoding for the instance. For specific differences between the primary series, please refer to Product Selection.
The parameter values are as follows:
- standard: Standard Edition
- ultimate: Platinum Edition
- professional: Professional Edition
- Service
Code string - The code of the service code instance. The code of the RocketMQ is rmq.
- Sub
Series stringCode The sub-series encoding for the instance. For specific differences between the sub-series, please refer to Product Selection.
The parameter values are as follows:
- cluster_ha: Cluster High Availability Edition
- single_node: Single Node Testing Edition
- serverless:Serverless instance
NOTE: From version 1.245.0,
sub_series_code
can be set toserverless
. When selecting the primary series as ultimate (Platinum Edition), the sub-series can only be chosen as cluster_ha (Cluster High Availability Edition).
- Acl
Info RocketMQInstance Acl Info Args - The access control list for the instance. See
acl_info
below. - Auto
Renew bool - Whether to enable auto-renewal. This parameter is only applicable when the payment type for the instance is Subscription (prepaid).
- true: Enable auto-renewal
- false: Disable auto-renewal
- Auto
Renew intPeriod Auto-renewal period. This parameter is only valid when auto-renewal is enabled. Unit: months.
The values can be as follows:
- Monthly renewal: 1, 2, 3, 6, 12
- Auto
Renew stringPeriod Unit - The minimum periodic unit for the duration of auto-renewal. This parameter is only valid when auto-renewal is enabled. Valid values:
Month
,Year
. - Commodity
Code string Commodity code
ons_rmqsub_public_cn: Package year and month instance
ons_rmqpost_public_cn: Pay-As-You-Go instance
Next: Serverless instances
- Instance
Name string - The name of instance
- Ip
Whitelists []string - The ip whitelist.
- Period int
Duration of purchase. This parameter is only valid when the payment type for the instance is Subscription (prepaid).
The values can be as follows:
- Monthly purchase: 1, 2, 3, 4, 5, 6
- Annual purchase: 1, 2, 3
- Period
Unit string The minimum periodic unit for the duration of purchase.
The parameter values are as follows:
- Month: Purchase on a monthly basis
- Year: Purchase on an annual basis
- Product
Info RocketMQInstance Product Info Args - product info See
product_info
below. - Remark string
- Custom description
- Resource
Group stringId - The ID of the resource group
- Software
Rocket
MQInstance Software Args - Instance software information. See
software
below. - map[string]string
- The resource label.
- network
Info RocketMQInstance Network Info - Instance network configuration information See
network_info
below. - payment
Type String The payment type for the instance. Alibaba Cloud Message Queue RocketMQ version supports two types of payment:
The parameter values are as follows:
- PayAsYouGo: Pay-as-you-go, a post-payment model where you pay after usage.
- Subscription: Subscription-based, a pre-payment model where you pay before usage.
For more information, please refer to Billing Methods.
- series
Code String The primary series encoding for the instance. For specific differences between the primary series, please refer to Product Selection.
The parameter values are as follows:
- standard: Standard Edition
- ultimate: Platinum Edition
- professional: Professional Edition
- service
Code String - The code of the service code instance. The code of the RocketMQ is rmq.
- sub
Series StringCode The sub-series encoding for the instance. For specific differences between the sub-series, please refer to Product Selection.
The parameter values are as follows:
- cluster_ha: Cluster High Availability Edition
- single_node: Single Node Testing Edition
- serverless:Serverless instance
NOTE: From version 1.245.0,
sub_series_code
can be set toserverless
. When selecting the primary series as ultimate (Platinum Edition), the sub-series can only be chosen as cluster_ha (Cluster High Availability Edition).
- acl
Info RocketMQInstance Acl Info - The access control list for the instance. See
acl_info
below. - auto
Renew Boolean - Whether to enable auto-renewal. This parameter is only applicable when the payment type for the instance is Subscription (prepaid).
- true: Enable auto-renewal
- false: Disable auto-renewal
- auto
Renew IntegerPeriod Auto-renewal period. This parameter is only valid when auto-renewal is enabled. Unit: months.
The values can be as follows:
- Monthly renewal: 1, 2, 3, 6, 12
- auto
Renew StringPeriod Unit - The minimum periodic unit for the duration of auto-renewal. This parameter is only valid when auto-renewal is enabled. Valid values:
Month
,Year
. - commodity
Code String Commodity code
ons_rmqsub_public_cn: Package year and month instance
ons_rmqpost_public_cn: Pay-As-You-Go instance
Next: Serverless instances
- instance
Name String - The name of instance
- ip
Whitelists List<String> - The ip whitelist.
- period Integer
Duration of purchase. This parameter is only valid when the payment type for the instance is Subscription (prepaid).
The values can be as follows:
- Monthly purchase: 1, 2, 3, 4, 5, 6
- Annual purchase: 1, 2, 3
- period
Unit String The minimum periodic unit for the duration of purchase.
The parameter values are as follows:
- Month: Purchase on a monthly basis
- Year: Purchase on an annual basis
- product
Info RocketMQInstance Product Info - product info See
product_info
below. - remark String
- Custom description
- resource
Group StringId - The ID of the resource group
- software
Rocket
MQInstance Software - Instance software information. See
software
below. - Map<String,String>
- The resource label.
- network
Info RocketMQInstance Network Info - Instance network configuration information See
network_info
below. - payment
Type string The payment type for the instance. Alibaba Cloud Message Queue RocketMQ version supports two types of payment:
The parameter values are as follows:
- PayAsYouGo: Pay-as-you-go, a post-payment model where you pay after usage.
- Subscription: Subscription-based, a pre-payment model where you pay before usage.
For more information, please refer to Billing Methods.
- series
Code string The primary series encoding for the instance. For specific differences between the primary series, please refer to Product Selection.
The parameter values are as follows:
- standard: Standard Edition
- ultimate: Platinum Edition
- professional: Professional Edition
- service
Code string - The code of the service code instance. The code of the RocketMQ is rmq.
- sub
Series stringCode The sub-series encoding for the instance. For specific differences between the sub-series, please refer to Product Selection.
The parameter values are as follows:
- cluster_ha: Cluster High Availability Edition
- single_node: Single Node Testing Edition
- serverless:Serverless instance
NOTE: From version 1.245.0,
sub_series_code
can be set toserverless
. When selecting the primary series as ultimate (Platinum Edition), the sub-series can only be chosen as cluster_ha (Cluster High Availability Edition).
- acl
Info RocketMQInstance Acl Info - The access control list for the instance. See
acl_info
below. - auto
Renew boolean - Whether to enable auto-renewal. This parameter is only applicable when the payment type for the instance is Subscription (prepaid).
- true: Enable auto-renewal
- false: Disable auto-renewal
- auto
Renew numberPeriod Auto-renewal period. This parameter is only valid when auto-renewal is enabled. Unit: months.
The values can be as follows:
- Monthly renewal: 1, 2, 3, 6, 12
- auto
Renew stringPeriod Unit - The minimum periodic unit for the duration of auto-renewal. This parameter is only valid when auto-renewal is enabled. Valid values:
Month
,Year
. - commodity
Code string Commodity code
ons_rmqsub_public_cn: Package year and month instance
ons_rmqpost_public_cn: Pay-As-You-Go instance
Next: Serverless instances
- instance
Name string - The name of instance
- ip
Whitelists string[] - The ip whitelist.
- period number
Duration of purchase. This parameter is only valid when the payment type for the instance is Subscription (prepaid).
The values can be as follows:
- Monthly purchase: 1, 2, 3, 4, 5, 6
- Annual purchase: 1, 2, 3
- period
Unit string The minimum periodic unit for the duration of purchase.
The parameter values are as follows:
- Month: Purchase on a monthly basis
- Year: Purchase on an annual basis
- product
Info RocketMQInstance Product Info - product info See
product_info
below. - remark string
- Custom description
- resource
Group stringId - The ID of the resource group
- software
Rocket
MQInstance Software - Instance software information. See
software
below. - {[key: string]: string}
- The resource label.
- network_
info RocketMQInstance Network Info Args - Instance network configuration information See
network_info
below. - payment_
type str The payment type for the instance. Alibaba Cloud Message Queue RocketMQ version supports two types of payment:
The parameter values are as follows:
- PayAsYouGo: Pay-as-you-go, a post-payment model where you pay after usage.
- Subscription: Subscription-based, a pre-payment model where you pay before usage.
For more information, please refer to Billing Methods.
- series_
code str The primary series encoding for the instance. For specific differences between the primary series, please refer to Product Selection.
The parameter values are as follows:
- standard: Standard Edition
- ultimate: Platinum Edition
- professional: Professional Edition
- service_
code str - The code of the service code instance. The code of the RocketMQ is rmq.
- sub_
series_ strcode The sub-series encoding for the instance. For specific differences between the sub-series, please refer to Product Selection.
The parameter values are as follows:
- cluster_ha: Cluster High Availability Edition
- single_node: Single Node Testing Edition
- serverless:Serverless instance
NOTE: From version 1.245.0,
sub_series_code
can be set toserverless
. When selecting the primary series as ultimate (Platinum Edition), the sub-series can only be chosen as cluster_ha (Cluster High Availability Edition).
- acl_
info RocketMQInstance Acl Info Args - The access control list for the instance. See
acl_info
below. - auto_
renew bool - Whether to enable auto-renewal. This parameter is only applicable when the payment type for the instance is Subscription (prepaid).
- true: Enable auto-renewal
- false: Disable auto-renewal
- auto_
renew_ intperiod Auto-renewal period. This parameter is only valid when auto-renewal is enabled. Unit: months.
The values can be as follows:
- Monthly renewal: 1, 2, 3, 6, 12
- auto_
renew_ strperiod_ unit - The minimum periodic unit for the duration of auto-renewal. This parameter is only valid when auto-renewal is enabled. Valid values:
Month
,Year
. - commodity_
code str Commodity code
ons_rmqsub_public_cn: Package year and month instance
ons_rmqpost_public_cn: Pay-As-You-Go instance
Next: Serverless instances
- instance_
name str - The name of instance
- ip_
whitelists Sequence[str] - The ip whitelist.
- period int
Duration of purchase. This parameter is only valid when the payment type for the instance is Subscription (prepaid).
The values can be as follows:
- Monthly purchase: 1, 2, 3, 4, 5, 6
- Annual purchase: 1, 2, 3
- period_
unit str The minimum periodic unit for the duration of purchase.
The parameter values are as follows:
- Month: Purchase on a monthly basis
- Year: Purchase on an annual basis
- product_
info RocketMQInstance Product Info Args - product info See
product_info
below. - remark str
- Custom description
- resource_
group_ strid - The ID of the resource group
- software
Rocket
MQInstance Software Args - Instance software information. See
software
below. - Mapping[str, str]
- The resource label.
- network
Info Property Map - Instance network configuration information See
network_info
below. - payment
Type String The payment type for the instance. Alibaba Cloud Message Queue RocketMQ version supports two types of payment:
The parameter values are as follows:
- PayAsYouGo: Pay-as-you-go, a post-payment model where you pay after usage.
- Subscription: Subscription-based, a pre-payment model where you pay before usage.
For more information, please refer to Billing Methods.
- series
Code String The primary series encoding for the instance. For specific differences between the primary series, please refer to Product Selection.
The parameter values are as follows:
- standard: Standard Edition
- ultimate: Platinum Edition
- professional: Professional Edition
- service
Code String - The code of the service code instance. The code of the RocketMQ is rmq.
- sub
Series StringCode The sub-series encoding for the instance. For specific differences between the sub-series, please refer to Product Selection.
The parameter values are as follows:
- cluster_ha: Cluster High Availability Edition
- single_node: Single Node Testing Edition
- serverless:Serverless instance
NOTE: From version 1.245.0,
sub_series_code
can be set toserverless
. When selecting the primary series as ultimate (Platinum Edition), the sub-series can only be chosen as cluster_ha (Cluster High Availability Edition).
- acl
Info Property Map - The access control list for the instance. See
acl_info
below. - auto
Renew Boolean - Whether to enable auto-renewal. This parameter is only applicable when the payment type for the instance is Subscription (prepaid).
- true: Enable auto-renewal
- false: Disable auto-renewal
- auto
Renew NumberPeriod Auto-renewal period. This parameter is only valid when auto-renewal is enabled. Unit: months.
The values can be as follows:
- Monthly renewal: 1, 2, 3, 6, 12
- auto
Renew StringPeriod Unit - The minimum periodic unit for the duration of auto-renewal. This parameter is only valid when auto-renewal is enabled. Valid values:
Month
,Year
. - commodity
Code String Commodity code
ons_rmqsub_public_cn: Package year and month instance
ons_rmqpost_public_cn: Pay-As-You-Go instance
Next: Serverless instances
- instance
Name String - The name of instance
- ip
Whitelists List<String> - The ip whitelist.
- period Number
Duration of purchase. This parameter is only valid when the payment type for the instance is Subscription (prepaid).
The values can be as follows:
- Monthly purchase: 1, 2, 3, 4, 5, 6
- Annual purchase: 1, 2, 3
- period
Unit String The minimum periodic unit for the duration of purchase.
The parameter values are as follows:
- Month: Purchase on a monthly basis
- Year: Purchase on an annual basis
- product
Info Property Map - product info See
product_info
below. - remark String
- Custom description
- resource
Group StringId - The ID of the resource group
- software Property Map
- Instance software information. See
software
below. - Map<String>
- The resource label.
Outputs
All input properties are implicitly available as output properties. Additionally, the RocketMQInstance resource produces the following output properties:
- Create
Time string - The creation time of the resource
- Id string
- The provider-assigned unique ID for this managed resource.
- Region
Id string - (Available since v1.245.0) The ID of the region in which the instance resides.
- Status string
- The status of the instance
- Create
Time string - The creation time of the resource
- Id string
- The provider-assigned unique ID for this managed resource.
- Region
Id string - (Available since v1.245.0) The ID of the region in which the instance resides.
- Status string
- The status of the instance
- create
Time String - The creation time of the resource
- id String
- The provider-assigned unique ID for this managed resource.
- region
Id String - (Available since v1.245.0) The ID of the region in which the instance resides.
- status String
- The status of the instance
- create
Time string - The creation time of the resource
- id string
- The provider-assigned unique ID for this managed resource.
- region
Id string - (Available since v1.245.0) The ID of the region in which the instance resides.
- status string
- The status of the instance
- create_
time str - The creation time of the resource
- id str
- The provider-assigned unique ID for this managed resource.
- region_
id str - (Available since v1.245.0) The ID of the region in which the instance resides.
- status str
- The status of the instance
- create
Time String - The creation time of the resource
- id String
- The provider-assigned unique ID for this managed resource.
- region
Id String - (Available since v1.245.0) The ID of the region in which the instance resides.
- status String
- The status of the instance
Look up Existing RocketMQInstance Resource
Get an existing RocketMQInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: RocketMQInstanceState, opts?: CustomResourceOptions): RocketMQInstance
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
acl_info: Optional[RocketMQInstanceAclInfoArgs] = None,
auto_renew: Optional[bool] = None,
auto_renew_period: Optional[int] = None,
auto_renew_period_unit: Optional[str] = None,
commodity_code: Optional[str] = None,
create_time: Optional[str] = None,
instance_name: Optional[str] = None,
ip_whitelists: Optional[Sequence[str]] = None,
network_info: Optional[RocketMQInstanceNetworkInfoArgs] = None,
payment_type: Optional[str] = None,
period: Optional[int] = None,
period_unit: Optional[str] = None,
product_info: Optional[RocketMQInstanceProductInfoArgs] = None,
region_id: Optional[str] = None,
remark: Optional[str] = None,
resource_group_id: Optional[str] = None,
series_code: Optional[str] = None,
service_code: Optional[str] = None,
software: Optional[RocketMQInstanceSoftwareArgs] = None,
status: Optional[str] = None,
sub_series_code: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None) -> RocketMQInstance
func GetRocketMQInstance(ctx *Context, name string, id IDInput, state *RocketMQInstanceState, opts ...ResourceOption) (*RocketMQInstance, error)
public static RocketMQInstance Get(string name, Input<string> id, RocketMQInstanceState? state, CustomResourceOptions? opts = null)
public static RocketMQInstance get(String name, Output<String> id, RocketMQInstanceState state, CustomResourceOptions options)
resources: _: type: alicloud:rocketmq:RocketMQInstance get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Acl
Info Pulumi.Ali Cloud. Rocket MQ. Inputs. Rocket MQInstance Acl Info - The access control list for the instance. See
acl_info
below. - Auto
Renew bool - Whether to enable auto-renewal. This parameter is only applicable when the payment type for the instance is Subscription (prepaid).
- true: Enable auto-renewal
- false: Disable auto-renewal
- Auto
Renew intPeriod Auto-renewal period. This parameter is only valid when auto-renewal is enabled. Unit: months.
The values can be as follows:
- Monthly renewal: 1, 2, 3, 6, 12
- Auto
Renew stringPeriod Unit - The minimum periodic unit for the duration of auto-renewal. This parameter is only valid when auto-renewal is enabled. Valid values:
Month
,Year
. - Commodity
Code string Commodity code
ons_rmqsub_public_cn: Package year and month instance
ons_rmqpost_public_cn: Pay-As-You-Go instance
Next: Serverless instances
- Create
Time string - The creation time of the resource
- Instance
Name string - The name of instance
- Ip
Whitelists List<string> - The ip whitelist.
- Network
Info Pulumi.Ali Cloud. Rocket MQ. Inputs. Rocket MQInstance Network Info - Instance network configuration information See
network_info
below. - Payment
Type string The payment type for the instance. Alibaba Cloud Message Queue RocketMQ version supports two types of payment:
The parameter values are as follows:
- PayAsYouGo: Pay-as-you-go, a post-payment model where you pay after usage.
- Subscription: Subscription-based, a pre-payment model where you pay before usage.
For more information, please refer to Billing Methods.
- Period int
Duration of purchase. This parameter is only valid when the payment type for the instance is Subscription (prepaid).
The values can be as follows:
- Monthly purchase: 1, 2, 3, 4, 5, 6
- Annual purchase: 1, 2, 3
- Period
Unit string The minimum periodic unit for the duration of purchase.
The parameter values are as follows:
- Month: Purchase on a monthly basis
- Year: Purchase on an annual basis
- Product
Info Pulumi.Ali Cloud. Rocket MQ. Inputs. Rocket MQInstance Product Info - product info See
product_info
below. - Region
Id string - (Available since v1.245.0) The ID of the region in which the instance resides.
- Remark string
- Custom description
- Resource
Group stringId - The ID of the resource group
- Series
Code string The primary series encoding for the instance. For specific differences between the primary series, please refer to Product Selection.
The parameter values are as follows:
- standard: Standard Edition
- ultimate: Platinum Edition
- professional: Professional Edition
- Service
Code string - The code of the service code instance. The code of the RocketMQ is rmq.
- Software
Pulumi.
Ali Cloud. Rocket MQ. Inputs. Rocket MQInstance Software - Instance software information. See
software
below. - Status string
- The status of the instance
- Sub
Series stringCode The sub-series encoding for the instance. For specific differences between the sub-series, please refer to Product Selection.
The parameter values are as follows:
- cluster_ha: Cluster High Availability Edition
- single_node: Single Node Testing Edition
- serverless:Serverless instance
NOTE: From version 1.245.0,
sub_series_code
can be set toserverless
. When selecting the primary series as ultimate (Platinum Edition), the sub-series can only be chosen as cluster_ha (Cluster High Availability Edition).
- Dictionary<string, string>
- The resource label.
- Acl
Info RocketMQInstance Acl Info Args - The access control list for the instance. See
acl_info
below. - Auto
Renew bool - Whether to enable auto-renewal. This parameter is only applicable when the payment type for the instance is Subscription (prepaid).
- true: Enable auto-renewal
- false: Disable auto-renewal
- Auto
Renew intPeriod Auto-renewal period. This parameter is only valid when auto-renewal is enabled. Unit: months.
The values can be as follows:
- Monthly renewal: 1, 2, 3, 6, 12
- Auto
Renew stringPeriod Unit - The minimum periodic unit for the duration of auto-renewal. This parameter is only valid when auto-renewal is enabled. Valid values:
Month
,Year
. - Commodity
Code string Commodity code
ons_rmqsub_public_cn: Package year and month instance
ons_rmqpost_public_cn: Pay-As-You-Go instance
Next: Serverless instances
- Create
Time string - The creation time of the resource
- Instance
Name string - The name of instance
- Ip
Whitelists []string - The ip whitelist.
- Network
Info RocketMQInstance Network Info Args - Instance network configuration information See
network_info
below. - Payment
Type string The payment type for the instance. Alibaba Cloud Message Queue RocketMQ version supports two types of payment:
The parameter values are as follows:
- PayAsYouGo: Pay-as-you-go, a post-payment model where you pay after usage.
- Subscription: Subscription-based, a pre-payment model where you pay before usage.
For more information, please refer to Billing Methods.
- Period int
Duration of purchase. This parameter is only valid when the payment type for the instance is Subscription (prepaid).
The values can be as follows:
- Monthly purchase: 1, 2, 3, 4, 5, 6
- Annual purchase: 1, 2, 3
- Period
Unit string The minimum periodic unit for the duration of purchase.
The parameter values are as follows:
- Month: Purchase on a monthly basis
- Year: Purchase on an annual basis
- Product
Info RocketMQInstance Product Info Args - product info See
product_info
below. - Region
Id string - (Available since v1.245.0) The ID of the region in which the instance resides.
- Remark string
- Custom description
- Resource
Group stringId - The ID of the resource group
- Series
Code string The primary series encoding for the instance. For specific differences between the primary series, please refer to Product Selection.
The parameter values are as follows:
- standard: Standard Edition
- ultimate: Platinum Edition
- professional: Professional Edition
- Service
Code string - The code of the service code instance. The code of the RocketMQ is rmq.
- Software
Rocket
MQInstance Software Args - Instance software information. See
software
below. - Status string
- The status of the instance
- Sub
Series stringCode The sub-series encoding for the instance. For specific differences between the sub-series, please refer to Product Selection.
The parameter values are as follows:
- cluster_ha: Cluster High Availability Edition
- single_node: Single Node Testing Edition
- serverless:Serverless instance
NOTE: From version 1.245.0,
sub_series_code
can be set toserverless
. When selecting the primary series as ultimate (Platinum Edition), the sub-series can only be chosen as cluster_ha (Cluster High Availability Edition).
- map[string]string
- The resource label.
- acl
Info RocketMQInstance Acl Info - The access control list for the instance. See
acl_info
below. - auto
Renew Boolean - Whether to enable auto-renewal. This parameter is only applicable when the payment type for the instance is Subscription (prepaid).
- true: Enable auto-renewal
- false: Disable auto-renewal
- auto
Renew IntegerPeriod Auto-renewal period. This parameter is only valid when auto-renewal is enabled. Unit: months.
The values can be as follows:
- Monthly renewal: 1, 2, 3, 6, 12
- auto
Renew StringPeriod Unit - The minimum periodic unit for the duration of auto-renewal. This parameter is only valid when auto-renewal is enabled. Valid values:
Month
,Year
. - commodity
Code String Commodity code
ons_rmqsub_public_cn: Package year and month instance
ons_rmqpost_public_cn: Pay-As-You-Go instance
Next: Serverless instances
- create
Time String - The creation time of the resource
- instance
Name String - The name of instance
- ip
Whitelists List<String> - The ip whitelist.
- network
Info RocketMQInstance Network Info - Instance network configuration information See
network_info
below. - payment
Type String The payment type for the instance. Alibaba Cloud Message Queue RocketMQ version supports two types of payment:
The parameter values are as follows:
- PayAsYouGo: Pay-as-you-go, a post-payment model where you pay after usage.
- Subscription: Subscription-based, a pre-payment model where you pay before usage.
For more information, please refer to Billing Methods.
- period Integer
Duration of purchase. This parameter is only valid when the payment type for the instance is Subscription (prepaid).
The values can be as follows:
- Monthly purchase: 1, 2, 3, 4, 5, 6
- Annual purchase: 1, 2, 3
- period
Unit String The minimum periodic unit for the duration of purchase.
The parameter values are as follows:
- Month: Purchase on a monthly basis
- Year: Purchase on an annual basis
- product
Info RocketMQInstance Product Info - product info See
product_info
below. - region
Id String - (Available since v1.245.0) The ID of the region in which the instance resides.
- remark String
- Custom description
- resource
Group StringId - The ID of the resource group
- series
Code String The primary series encoding for the instance. For specific differences between the primary series, please refer to Product Selection.
The parameter values are as follows:
- standard: Standard Edition
- ultimate: Platinum Edition
- professional: Professional Edition
- service
Code String - The code of the service code instance. The code of the RocketMQ is rmq.
- software
Rocket
MQInstance Software - Instance software information. See
software
below. - status String
- The status of the instance
- sub
Series StringCode The sub-series encoding for the instance. For specific differences between the sub-series, please refer to Product Selection.
The parameter values are as follows:
- cluster_ha: Cluster High Availability Edition
- single_node: Single Node Testing Edition
- serverless:Serverless instance
NOTE: From version 1.245.0,
sub_series_code
can be set toserverless
. When selecting the primary series as ultimate (Platinum Edition), the sub-series can only be chosen as cluster_ha (Cluster High Availability Edition).
- Map<String,String>
- The resource label.
- acl
Info RocketMQInstance Acl Info - The access control list for the instance. See
acl_info
below. - auto
Renew boolean - Whether to enable auto-renewal. This parameter is only applicable when the payment type for the instance is Subscription (prepaid).
- true: Enable auto-renewal
- false: Disable auto-renewal
- auto
Renew numberPeriod Auto-renewal period. This parameter is only valid when auto-renewal is enabled. Unit: months.
The values can be as follows:
- Monthly renewal: 1, 2, 3, 6, 12
- auto
Renew stringPeriod Unit - The minimum periodic unit for the duration of auto-renewal. This parameter is only valid when auto-renewal is enabled. Valid values:
Month
,Year
. - commodity
Code string Commodity code
ons_rmqsub_public_cn: Package year and month instance
ons_rmqpost_public_cn: Pay-As-You-Go instance
Next: Serverless instances
- create
Time string - The creation time of the resource
- instance
Name string - The name of instance
- ip
Whitelists string[] - The ip whitelist.
- network
Info RocketMQInstance Network Info - Instance network configuration information See
network_info
below. - payment
Type string The payment type for the instance. Alibaba Cloud Message Queue RocketMQ version supports two types of payment:
The parameter values are as follows:
- PayAsYouGo: Pay-as-you-go, a post-payment model where you pay after usage.
- Subscription: Subscription-based, a pre-payment model where you pay before usage.
For more information, please refer to Billing Methods.
- period number
Duration of purchase. This parameter is only valid when the payment type for the instance is Subscription (prepaid).
The values can be as follows:
- Monthly purchase: 1, 2, 3, 4, 5, 6
- Annual purchase: 1, 2, 3
- period
Unit string The minimum periodic unit for the duration of purchase.
The parameter values are as follows:
- Month: Purchase on a monthly basis
- Year: Purchase on an annual basis
- product
Info RocketMQInstance Product Info - product info See
product_info
below. - region
Id string - (Available since v1.245.0) The ID of the region in which the instance resides.
- remark string
- Custom description
- resource
Group stringId - The ID of the resource group
- series
Code string The primary series encoding for the instance. For specific differences between the primary series, please refer to Product Selection.
The parameter values are as follows:
- standard: Standard Edition
- ultimate: Platinum Edition
- professional: Professional Edition
- service
Code string - The code of the service code instance. The code of the RocketMQ is rmq.
- software
Rocket
MQInstance Software - Instance software information. See
software
below. - status string
- The status of the instance
- sub
Series stringCode The sub-series encoding for the instance. For specific differences between the sub-series, please refer to Product Selection.
The parameter values are as follows:
- cluster_ha: Cluster High Availability Edition
- single_node: Single Node Testing Edition
- serverless:Serverless instance
NOTE: From version 1.245.0,
sub_series_code
can be set toserverless
. When selecting the primary series as ultimate (Platinum Edition), the sub-series can only be chosen as cluster_ha (Cluster High Availability Edition).
- {[key: string]: string}
- The resource label.
- acl_
info RocketMQInstance Acl Info Args - The access control list for the instance. See
acl_info
below. - auto_
renew bool - Whether to enable auto-renewal. This parameter is only applicable when the payment type for the instance is Subscription (prepaid).
- true: Enable auto-renewal
- false: Disable auto-renewal
- auto_
renew_ intperiod Auto-renewal period. This parameter is only valid when auto-renewal is enabled. Unit: months.
The values can be as follows:
- Monthly renewal: 1, 2, 3, 6, 12
- auto_
renew_ strperiod_ unit - The minimum periodic unit for the duration of auto-renewal. This parameter is only valid when auto-renewal is enabled. Valid values:
Month
,Year
. - commodity_
code str Commodity code
ons_rmqsub_public_cn: Package year and month instance
ons_rmqpost_public_cn: Pay-As-You-Go instance
Next: Serverless instances
- create_
time str - The creation time of the resource
- instance_
name str - The name of instance
- ip_
whitelists Sequence[str] - The ip whitelist.
- network_
info RocketMQInstance Network Info Args - Instance network configuration information See
network_info
below. - payment_
type str The payment type for the instance. Alibaba Cloud Message Queue RocketMQ version supports two types of payment:
The parameter values are as follows:
- PayAsYouGo: Pay-as-you-go, a post-payment model where you pay after usage.
- Subscription: Subscription-based, a pre-payment model where you pay before usage.
For more information, please refer to Billing Methods.
- period int
Duration of purchase. This parameter is only valid when the payment type for the instance is Subscription (prepaid).
The values can be as follows:
- Monthly purchase: 1, 2, 3, 4, 5, 6
- Annual purchase: 1, 2, 3
- period_
unit str The minimum periodic unit for the duration of purchase.
The parameter values are as follows:
- Month: Purchase on a monthly basis
- Year: Purchase on an annual basis
- product_
info RocketMQInstance Product Info Args - product info See
product_info
below. - region_
id str - (Available since v1.245.0) The ID of the region in which the instance resides.
- remark str
- Custom description
- resource_
group_ strid - The ID of the resource group
- series_
code str The primary series encoding for the instance. For specific differences between the primary series, please refer to Product Selection.
The parameter values are as follows:
- standard: Standard Edition
- ultimate: Platinum Edition
- professional: Professional Edition
- service_
code str - The code of the service code instance. The code of the RocketMQ is rmq.
- software
Rocket
MQInstance Software Args - Instance software information. See
software
below. - status str
- The status of the instance
- sub_
series_ strcode The sub-series encoding for the instance. For specific differences between the sub-series, please refer to Product Selection.
The parameter values are as follows:
- cluster_ha: Cluster High Availability Edition
- single_node: Single Node Testing Edition
- serverless:Serverless instance
NOTE: From version 1.245.0,
sub_series_code
can be set toserverless
. When selecting the primary series as ultimate (Platinum Edition), the sub-series can only be chosen as cluster_ha (Cluster High Availability Edition).
- Mapping[str, str]
- The resource label.
- acl
Info Property Map - The access control list for the instance. See
acl_info
below. - auto
Renew Boolean - Whether to enable auto-renewal. This parameter is only applicable when the payment type for the instance is Subscription (prepaid).
- true: Enable auto-renewal
- false: Disable auto-renewal
- auto
Renew NumberPeriod Auto-renewal period. This parameter is only valid when auto-renewal is enabled. Unit: months.
The values can be as follows:
- Monthly renewal: 1, 2, 3, 6, 12
- auto
Renew StringPeriod Unit - The minimum periodic unit for the duration of auto-renewal. This parameter is only valid when auto-renewal is enabled. Valid values:
Month
,Year
. - commodity
Code String Commodity code
ons_rmqsub_public_cn: Package year and month instance
ons_rmqpost_public_cn: Pay-As-You-Go instance
Next: Serverless instances
- create
Time String - The creation time of the resource
- instance
Name String - The name of instance
- ip
Whitelists List<String> - The ip whitelist.
- network
Info Property Map - Instance network configuration information See
network_info
below. - payment
Type String The payment type for the instance. Alibaba Cloud Message Queue RocketMQ version supports two types of payment:
The parameter values are as follows:
- PayAsYouGo: Pay-as-you-go, a post-payment model where you pay after usage.
- Subscription: Subscription-based, a pre-payment model where you pay before usage.
For more information, please refer to Billing Methods.
- period Number
Duration of purchase. This parameter is only valid when the payment type for the instance is Subscription (prepaid).
The values can be as follows:
- Monthly purchase: 1, 2, 3, 4, 5, 6
- Annual purchase: 1, 2, 3
- period
Unit String The minimum periodic unit for the duration of purchase.
The parameter values are as follows:
- Month: Purchase on a monthly basis
- Year: Purchase on an annual basis
- product
Info Property Map - product info See
product_info
below. - region
Id String - (Available since v1.245.0) The ID of the region in which the instance resides.
- remark String
- Custom description
- resource
Group StringId - The ID of the resource group
- series
Code String The primary series encoding for the instance. For specific differences between the primary series, please refer to Product Selection.
The parameter values are as follows:
- standard: Standard Edition
- ultimate: Platinum Edition
- professional: Professional Edition
- service
Code String - The code of the service code instance. The code of the RocketMQ is rmq.
- software Property Map
- Instance software information. See
software
below. - status String
- The status of the instance
- sub
Series StringCode The sub-series encoding for the instance. For specific differences between the sub-series, please refer to Product Selection.
The parameter values are as follows:
- cluster_ha: Cluster High Availability Edition
- single_node: Single Node Testing Edition
- serverless:Serverless instance
NOTE: From version 1.245.0,
sub_series_code
can be set toserverless
. When selecting the primary series as ultimate (Platinum Edition), the sub-series can only be chosen as cluster_ha (Cluster High Availability Edition).
- Map<String>
- The resource label.
Supporting Types
RocketMQInstanceAclInfo, RocketMQInstanceAclInfoArgs
- Acl
Types List<string> - The authentication type of the instance. Valid values:
- Default
Vpc boolAuth Free - Indicates whether the authentication-free in VPCs feature is enabled. Indicates whether the authentication-free in VPCs feature is enabled. Valid values:
- Acl
Types []string - The authentication type of the instance. Valid values:
- Default
Vpc boolAuth Free - Indicates whether the authentication-free in VPCs feature is enabled. Indicates whether the authentication-free in VPCs feature is enabled. Valid values:
- acl
Types List<String> - The authentication type of the instance. Valid values:
- default
Vpc BooleanAuth Free - Indicates whether the authentication-free in VPCs feature is enabled. Indicates whether the authentication-free in VPCs feature is enabled. Valid values:
- acl
Types string[] - The authentication type of the instance. Valid values:
- default
Vpc booleanAuth Free - Indicates whether the authentication-free in VPCs feature is enabled. Indicates whether the authentication-free in VPCs feature is enabled. Valid values:
- acl_
types Sequence[str] - The authentication type of the instance. Valid values:
- default_
vpc_ boolauth_ free - Indicates whether the authentication-free in VPCs feature is enabled. Indicates whether the authentication-free in VPCs feature is enabled. Valid values:
- acl
Types List<String> - The authentication type of the instance. Valid values:
- default
Vpc BooleanAuth Free - Indicates whether the authentication-free in VPCs feature is enabled. Indicates whether the authentication-free in VPCs feature is enabled. Valid values:
RocketMQInstanceNetworkInfo, RocketMQInstanceNetworkInfoArgs
- Internet
Info Pulumi.Ali Cloud. Rocket MQ. Inputs. Rocket MQInstance Network Info Internet Info - instance internet info. See
internet_info
below. - Vpc
Info Pulumi.Ali Cloud. Rocket MQ. Inputs. Rocket MQInstance Network Info Vpc Info - Proprietary network information. See
vpc_info
below. - Endpoints
List<Pulumi.
Ali Cloud. Rocket MQ. Inputs. Rocket MQInstance Network Info Endpoint> - Access point list.
- Internet
Info RocketMQInstance Network Info Internet Info - instance internet info. See
internet_info
below. - Vpc
Info RocketMQInstance Network Info Vpc Info - Proprietary network information. See
vpc_info
below. - Endpoints
[]Rocket
MQInstance Network Info Endpoint - Access point list.
- internet
Info RocketMQInstance Network Info Internet Info - instance internet info. See
internet_info
below. - vpc
Info RocketMQInstance Network Info Vpc Info - Proprietary network information. See
vpc_info
below. - endpoints
List<Rocket
MQInstance Network Info Endpoint> - Access point list.
- internet
Info RocketMQInstance Network Info Internet Info - instance internet info. See
internet_info
below. - vpc
Info RocketMQInstance Network Info Vpc Info - Proprietary network information. See
vpc_info
below. - endpoints
Rocket
MQInstance Network Info Endpoint[] - Access point list.
- internet_
info RocketMQInstance Network Info Internet Info - instance internet info. See
internet_info
below. - vpc_
info RocketMQInstance Network Info Vpc Info - Proprietary network information. See
vpc_info
below. - endpoints
Sequence[Rocket
MQInstance Network Info Endpoint] - Access point list.
- internet
Info Property Map - instance internet info. See
internet_info
below. - vpc
Info Property Map - Proprietary network information. See
vpc_info
below. - endpoints List<Property Map>
- Access point list.
RocketMQInstanceNetworkInfoEndpoint, RocketMQInstanceNetworkInfoEndpointArgs
- Endpoint
Type string - Access point type.
- Endpoint
Url string - Access point address.
- Ip
White List<string>Lists - White list of access addresses.
- Endpoint
Type string - Access point type.
- Endpoint
Url string - Access point address.
- Ip
White []stringLists - White list of access addresses.
- endpoint
Type String - Access point type.
- endpoint
Url String - Access point address.
- ip
White List<String>Lists - White list of access addresses.
- endpoint
Type string - Access point type.
- endpoint
Url string - Access point address.
- ip
White string[]Lists - White list of access addresses.
- endpoint_
type str - Access point type.
- endpoint_
url str - Access point address.
- ip_
white_ Sequence[str]lists - White list of access addresses.
- endpoint
Type String - Access point type.
- endpoint
Url String - Access point address.
- ip
White List<String>Lists - White list of access addresses.
RocketMQInstanceNetworkInfoInternetInfo, RocketMQInstanceNetworkInfoInternetInfoArgs
- Flow
Out stringType - Public network billing type. Parameter values are as follows:
- payByBandwidth: Fixed bandwidth billing. This parameter must be set to the value when public network access is enabled.
- uninvolved: Not involved. This parameter must be set to the value when public network access is disabled.
- Internet
Spec string - Whether to enable public network access. The parameter values are as follows:
- enable: Enable public network access
- disable: Disable public network access Instances by default support VPC access. If public network access is enabled, Alibaba Cloud Message Queue RocketMQ version will incur charges for public network outbound bandwidth. For specific billing information, please refer to Public Network Access Fees.
- Flow
Out intBandwidth - Public network bandwidth specification. Unit: Mb/s. This field should only be filled when the public network billing type is set to payByBandwidth. The value range is [1 - 1000].
- Ip
Whitelists List<string> - Field
ip_whitelist
has been deprecated from provider version 1.245.0. New fieldip_whitelists
instead.
- Flow
Out stringType - Public network billing type. Parameter values are as follows:
- payByBandwidth: Fixed bandwidth billing. This parameter must be set to the value when public network access is enabled.
- uninvolved: Not involved. This parameter must be set to the value when public network access is disabled.
- Internet
Spec string - Whether to enable public network access. The parameter values are as follows:
- enable: Enable public network access
- disable: Disable public network access Instances by default support VPC access. If public network access is enabled, Alibaba Cloud Message Queue RocketMQ version will incur charges for public network outbound bandwidth. For specific billing information, please refer to Public Network Access Fees.
- Flow
Out intBandwidth - Public network bandwidth specification. Unit: Mb/s. This field should only be filled when the public network billing type is set to payByBandwidth. The value range is [1 - 1000].
- Ip
Whitelists []string - Field
ip_whitelist
has been deprecated from provider version 1.245.0. New fieldip_whitelists
instead.
- flow
Out StringType - Public network billing type. Parameter values are as follows:
- payByBandwidth: Fixed bandwidth billing. This parameter must be set to the value when public network access is enabled.
- uninvolved: Not involved. This parameter must be set to the value when public network access is disabled.
- internet
Spec String - Whether to enable public network access. The parameter values are as follows:
- enable: Enable public network access
- disable: Disable public network access Instances by default support VPC access. If public network access is enabled, Alibaba Cloud Message Queue RocketMQ version will incur charges for public network outbound bandwidth. For specific billing information, please refer to Public Network Access Fees.
- flow
Out IntegerBandwidth - Public network bandwidth specification. Unit: Mb/s. This field should only be filled when the public network billing type is set to payByBandwidth. The value range is [1 - 1000].
- ip
Whitelists List<String> - Field
ip_whitelist
has been deprecated from provider version 1.245.0. New fieldip_whitelists
instead.
- flow
Out stringType - Public network billing type. Parameter values are as follows:
- payByBandwidth: Fixed bandwidth billing. This parameter must be set to the value when public network access is enabled.
- uninvolved: Not involved. This parameter must be set to the value when public network access is disabled.
- internet
Spec string - Whether to enable public network access. The parameter values are as follows:
- enable: Enable public network access
- disable: Disable public network access Instances by default support VPC access. If public network access is enabled, Alibaba Cloud Message Queue RocketMQ version will incur charges for public network outbound bandwidth. For specific billing information, please refer to Public Network Access Fees.
- flow
Out numberBandwidth - Public network bandwidth specification. Unit: Mb/s. This field should only be filled when the public network billing type is set to payByBandwidth. The value range is [1 - 1000].
- ip
Whitelists string[] - Field
ip_whitelist
has been deprecated from provider version 1.245.0. New fieldip_whitelists
instead.
- flow_
out_ strtype - Public network billing type. Parameter values are as follows:
- payByBandwidth: Fixed bandwidth billing. This parameter must be set to the value when public network access is enabled.
- uninvolved: Not involved. This parameter must be set to the value when public network access is disabled.
- internet_
spec str - Whether to enable public network access. The parameter values are as follows:
- enable: Enable public network access
- disable: Disable public network access Instances by default support VPC access. If public network access is enabled, Alibaba Cloud Message Queue RocketMQ version will incur charges for public network outbound bandwidth. For specific billing information, please refer to Public Network Access Fees.
- flow_
out_ intbandwidth - Public network bandwidth specification. Unit: Mb/s. This field should only be filled when the public network billing type is set to payByBandwidth. The value range is [1 - 1000].
- ip_
whitelists Sequence[str] - Field
ip_whitelist
has been deprecated from provider version 1.245.0. New fieldip_whitelists
instead.
- flow
Out StringType - Public network billing type. Parameter values are as follows:
- payByBandwidth: Fixed bandwidth billing. This parameter must be set to the value when public network access is enabled.
- uninvolved: Not involved. This parameter must be set to the value when public network access is disabled.
- internet
Spec String - Whether to enable public network access. The parameter values are as follows:
- enable: Enable public network access
- disable: Disable public network access Instances by default support VPC access. If public network access is enabled, Alibaba Cloud Message Queue RocketMQ version will incur charges for public network outbound bandwidth. For specific billing information, please refer to Public Network Access Fees.
- flow
Out NumberBandwidth - Public network bandwidth specification. Unit: Mb/s. This field should only be filled when the public network billing type is set to payByBandwidth. The value range is [1 - 1000].
- ip
Whitelists List<String> - Field
ip_whitelist
has been deprecated from provider version 1.245.0. New fieldip_whitelists
instead.
RocketMQInstanceNetworkInfoVpcInfo, RocketMQInstanceNetworkInfoVpcInfoArgs
- Vpc
Id string - Proprietary Network.
- Security
Group stringIds - Security group id.
- Vswitch
Id string - VPC switch id.
- Vswitches
List<Pulumi.
Ali Cloud. Rocket MQ. Inputs. Rocket MQInstance Network Info Vpc Info Vswitch> - Multiple VSwitches. At least two VSwitches are required for a serverless instance. See
vswitches
below.
- Vpc
Id string - Proprietary Network.
- Security
Group stringIds - Security group id.
- Vswitch
Id string - VPC switch id.
- Vswitches
[]Rocket
MQInstance Network Info Vpc Info Vswitch - Multiple VSwitches. At least two VSwitches are required for a serverless instance. See
vswitches
below.
- vpc
Id String - Proprietary Network.
- security
Group StringIds - Security group id.
- vswitch
Id String - VPC switch id.
- vswitches
List<Rocket
MQInstance Network Info Vpc Info Vswitch> - Multiple VSwitches. At least two VSwitches are required for a serverless instance. See
vswitches
below.
- vpc
Id string - Proprietary Network.
- security
Group stringIds - Security group id.
- vswitch
Id string - VPC switch id.
- vswitches
Rocket
MQInstance Network Info Vpc Info Vswitch[] - Multiple VSwitches. At least two VSwitches are required for a serverless instance. See
vswitches
below.
- vpc_
id str - Proprietary Network.
- security_
group_ strids - Security group id.
- vswitch_
id str - VPC switch id.
- vswitches
Sequence[Rocket
MQInstance Network Info Vpc Info Vswitch] - Multiple VSwitches. At least two VSwitches are required for a serverless instance. See
vswitches
below.
- vpc
Id String - Proprietary Network.
- security
Group StringIds - Security group id.
- vswitch
Id String - VPC switch id.
- vswitches List<Property Map>
- Multiple VSwitches. At least two VSwitches are required for a serverless instance. See
vswitches
below.
RocketMQInstanceNetworkInfoVpcInfoVswitch, RocketMQInstanceNetworkInfoVpcInfoVswitchArgs
- Vswitch
Id string - VPC switch id.
- Vswitch
Id string - VPC switch id.
- vswitch
Id String - VPC switch id.
- vswitch
Id string - VPC switch id.
- vswitch_
id str - VPC switch id.
- vswitch
Id String - VPC switch id.
RocketMQInstanceProductInfo, RocketMQInstanceProductInfoArgs
- Msg
Process stringSpec - Message sending and receiving calculation specifications. For details about the upper limit for sending and receiving messages, see Instance Specifications.
- Auto
Scaling bool - is open auto scaling.
- Message
Retention intTime - Duration of message retention. Unit: hours. For the range of values, please refer to Usage Limits>Resource Quotas>Limitations on Message Retention. The message storage in AlibabaCloud RocketMQ is fully implemented in a serverless and elastic manner, with charges based on the actual storage space. You can control the storage capacity of messages by adjusting the duration of message retention. For more information, please see Storage Fees.
- Send
Receive doubleRatio - message send receive ratio. Value range: [0.2, 0.5].
- Storage
Encryption bool - Specifies whether to enable the encryption at rest feature. Valid values:
true
,false
. - Storage
Secret stringKey - The key for encryption at rest.
- Support
Auto boolScaling - is support auto scaling.
- Trace
On bool - Whether to enable the message trace function. Valid values:
true
,false
.
- Msg
Process stringSpec - Message sending and receiving calculation specifications. For details about the upper limit for sending and receiving messages, see Instance Specifications.
- Auto
Scaling bool - is open auto scaling.
- Message
Retention intTime - Duration of message retention. Unit: hours. For the range of values, please refer to Usage Limits>Resource Quotas>Limitations on Message Retention. The message storage in AlibabaCloud RocketMQ is fully implemented in a serverless and elastic manner, with charges based on the actual storage space. You can control the storage capacity of messages by adjusting the duration of message retention. For more information, please see Storage Fees.
- Send
Receive float64Ratio - message send receive ratio. Value range: [0.2, 0.5].
- Storage
Encryption bool - Specifies whether to enable the encryption at rest feature. Valid values:
true
,false
. - Storage
Secret stringKey - The key for encryption at rest.
- Support
Auto boolScaling - is support auto scaling.
- Trace
On bool - Whether to enable the message trace function. Valid values:
true
,false
.
- msg
Process StringSpec - Message sending and receiving calculation specifications. For details about the upper limit for sending and receiving messages, see Instance Specifications.
- auto
Scaling Boolean - is open auto scaling.
- message
Retention IntegerTime - Duration of message retention. Unit: hours. For the range of values, please refer to Usage Limits>Resource Quotas>Limitations on Message Retention. The message storage in AlibabaCloud RocketMQ is fully implemented in a serverless and elastic manner, with charges based on the actual storage space. You can control the storage capacity of messages by adjusting the duration of message retention. For more information, please see Storage Fees.
- send
Receive DoubleRatio - message send receive ratio. Value range: [0.2, 0.5].
- storage
Encryption Boolean - Specifies whether to enable the encryption at rest feature. Valid values:
true
,false
. - storage
Secret StringKey - The key for encryption at rest.
- support
Auto BooleanScaling - is support auto scaling.
- trace
On Boolean - Whether to enable the message trace function. Valid values:
true
,false
.
- msg
Process stringSpec - Message sending and receiving calculation specifications. For details about the upper limit for sending and receiving messages, see Instance Specifications.
- auto
Scaling boolean - is open auto scaling.
- message
Retention numberTime - Duration of message retention. Unit: hours. For the range of values, please refer to Usage Limits>Resource Quotas>Limitations on Message Retention. The message storage in AlibabaCloud RocketMQ is fully implemented in a serverless and elastic manner, with charges based on the actual storage space. You can control the storage capacity of messages by adjusting the duration of message retention. For more information, please see Storage Fees.
- send
Receive numberRatio - message send receive ratio. Value range: [0.2, 0.5].
- storage
Encryption boolean - Specifies whether to enable the encryption at rest feature. Valid values:
true
,false
. - storage
Secret stringKey - The key for encryption at rest.
- support
Auto booleanScaling - is support auto scaling.
- trace
On boolean - Whether to enable the message trace function. Valid values:
true
,false
.
- msg_
process_ strspec - Message sending and receiving calculation specifications. For details about the upper limit for sending and receiving messages, see Instance Specifications.
- auto_
scaling bool - is open auto scaling.
- message_
retention_ inttime - Duration of message retention. Unit: hours. For the range of values, please refer to Usage Limits>Resource Quotas>Limitations on Message Retention. The message storage in AlibabaCloud RocketMQ is fully implemented in a serverless and elastic manner, with charges based on the actual storage space. You can control the storage capacity of messages by adjusting the duration of message retention. For more information, please see Storage Fees.
- send_
receive_ floatratio - message send receive ratio. Value range: [0.2, 0.5].
- storage_
encryption bool - Specifies whether to enable the encryption at rest feature. Valid values:
true
,false
. - storage_
secret_ strkey - The key for encryption at rest.
- support_
auto_ boolscaling - is support auto scaling.
- trace_
on bool - Whether to enable the message trace function. Valid values:
true
,false
.
- msg
Process StringSpec - Message sending and receiving calculation specifications. For details about the upper limit for sending and receiving messages, see Instance Specifications.
- auto
Scaling Boolean - is open auto scaling.
- message
Retention NumberTime - Duration of message retention. Unit: hours. For the range of values, please refer to Usage Limits>Resource Quotas>Limitations on Message Retention. The message storage in AlibabaCloud RocketMQ is fully implemented in a serverless and elastic manner, with charges based on the actual storage space. You can control the storage capacity of messages by adjusting the duration of message retention. For more information, please see Storage Fees.
- send
Receive NumberRatio - message send receive ratio. Value range: [0.2, 0.5].
- storage
Encryption Boolean - Specifies whether to enable the encryption at rest feature. Valid values:
true
,false
. - storage
Secret StringKey - The key for encryption at rest.
- support
Auto BooleanScaling - is support auto scaling.
- trace
On Boolean - Whether to enable the message trace function. Valid values:
true
,false
.
RocketMQInstanceSoftware, RocketMQInstanceSoftwareArgs
- Maintain
Time string - Upgrade time period.
- Software
Version string - Software version.
- Upgrade
Method string - Upgrade method.
- Maintain
Time string - Upgrade time period.
- Software
Version string - Software version.
- Upgrade
Method string - Upgrade method.
- maintain
Time String - Upgrade time period.
- software
Version String - Software version.
- upgrade
Method String - Upgrade method.
- maintain
Time string - Upgrade time period.
- software
Version string - Software version.
- upgrade
Method string - Upgrade method.
- maintain_
time str - Upgrade time period.
- software_
version str - Software version.
- upgrade_
method str - Upgrade method.
- maintain
Time String - Upgrade time period.
- software
Version String - Software version.
- upgrade
Method String - Upgrade method.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloud
Terraform Provider.