volcenginecc.rocketmq.Instance

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

RocketMQ Message Queue is a distributed messaging middleware service built on Apache RocketMQ. It is fully compatible with all open-source RocketMQ components and concepts, offering low latency, high elasticity and high reliability, and high throughput. No changes to business code are required, enabling users to quickly migrate to the cloud.

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  rocketMQInstanceDemo:
    type: volcenginecc:rocketmq:Instance
    name: RocketMQInstanceDemo
    properties:
      allowListIds:
        - acl-5380876c62044b658c3c7da4xxxx
        - acl-3e998a9ef43e48eda1d07e2exxxx
      ipVersionType: IPv4
      enableSsl: true
      tags:
        - key: env
          value: test
      version: 5.x
      zoneId: cn-beijing-a,cn-beijing-c,cn-beijing-d
      computeSpec: rocketmq.x2.2k
      storageSpace: 300
      vpcId: vpc-1a1vgeo93ycxxxxxxxjnuw
      subnetId: subnet-ij9s4h4xxxxxxx95wx4p
      fileReservedTime: 72
      instanceName: RocketMQInstanceDemo
      chargeDetail:
        charge_type: PostPaid
      sslMode: permissive
      networkTypes: PrivateNetwork
      projectName: default
      instanceDescription: RocketMQInstanceDemo description
      eipId: eip-bt6jb362txxxxx2zbpbo

Create Instance Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);

@overload
def Instance(resource_name: str,
             args: InstanceArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             subnet_id: Optional[str] = None,
             network_types: Optional[str] = None,
             charge_detail: Optional[InstanceChargeDetailArgs] = None,
             compute_spec: Optional[str] = None,
             zone_id: Optional[str] = None,
             vpc_id: Optional[str] = None,
             file_reserved_time: Optional[int] = None,
             version: Optional[str] = None,
             storage_space: Optional[int] = None,
             auto_scale_queue: Optional[bool] = None,
             project_name: Optional[str] = None,
             product_info: Optional[InstanceProductInfoArgs] = None,
             instance_name: Optional[str] = None,
             ssl_mode: Optional[str] = None,
             ip_version_type: Optional[str] = None,
             allow_list_ids: Optional[Sequence[str]] = None,
             tags: Optional[Sequence[InstanceTagArgs]] = None,
             instance_description: Optional[str] = None,
             enable_ssl: Optional[bool] = None,
             eip_id: Optional[str] = None)

func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)

public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)

public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

type: volcenginecc:rocketmq:Instance
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 InstanceArgs: 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 InstanceArgs: 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 InstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args InstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args InstanceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Instance 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 Instance resource accepts the following input properties:

ChargeDetail Volcengine.InstanceChargeDetail: Billing method and related billing information for the instance.
ComputeSpec string: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
FileReservedTime int: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
NetworkTypes string: Instance network type, fixed as PrivateNetwork.
StorageSpace int: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
SubnetId string: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
Version string: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
VpcId string: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
ZoneId string: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.
AllowListIds List<string>: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
AutoScaleQueue bool: Whether to automatically create queues when the instance specification changes.
EipId string: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
EnableSsl bool: Whether to use SSL encryption.
InstanceDescription string: Brief description of the instance. Length range: 1–128 characters.
InstanceName string: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
IpVersionType string: IP version. Options are IPv4 or DualStack.
ProductInfo Volcengine.InstanceProductInfo: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
ProjectName string: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
SslMode string: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
Tags List<Volcengine.InstanceTag>

ChargeDetail InstanceChargeDetailArgs: Billing method and related billing information for the instance.
ComputeSpec string: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
FileReservedTime int: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
NetworkTypes string: Instance network type, fixed as PrivateNetwork.
StorageSpace int: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
SubnetId string: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
Version string: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
VpcId string: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
ZoneId string: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.
AllowListIds []string: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
AutoScaleQueue bool: Whether to automatically create queues when the instance specification changes.
EipId string: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
EnableSsl bool: Whether to use SSL encryption.
InstanceDescription string: Brief description of the instance. Length range: 1–128 characters.
InstanceName string: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
IpVersionType string: IP version. Options are IPv4 or DualStack.
ProductInfo InstanceProductInfoArgs: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
ProjectName string: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
SslMode string: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
Tags []InstanceTagArgs

chargeDetail InstanceChargeDetail: Billing method and related billing information for the instance.
computeSpec String: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
fileReservedTime Integer: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
networkTypes String: Instance network type, fixed as PrivateNetwork.
storageSpace Integer: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
subnetId String: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
version String: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
vpcId String: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
zoneId String: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.
allowListIds List<String>: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
autoScaleQueue Boolean: Whether to automatically create queues when the instance specification changes.
eipId String: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
enableSsl Boolean: Whether to use SSL encryption.
instanceDescription String: Brief description of the instance. Length range: 1–128 characters.
instanceName String: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
ipVersionType String: IP version. Options are IPv4 or DualStack.
productInfo InstanceProductInfo: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
projectName String: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
sslMode String: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
tags List<InstanceTag>

chargeDetail InstanceChargeDetail: Billing method and related billing information for the instance.
computeSpec string: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
fileReservedTime number: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
networkTypes string: Instance network type, fixed as PrivateNetwork.
storageSpace number: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
subnetId string: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
version string: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
vpcId string: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
zoneId string: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.
allowListIds string[]: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
autoScaleQueue boolean: Whether to automatically create queues when the instance specification changes.
eipId string: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
enableSsl boolean: Whether to use SSL encryption.
instanceDescription string: Brief description of the instance. Length range: 1–128 characters.
instanceName string: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
ipVersionType string: IP version. Options are IPv4 or DualStack.
productInfo InstanceProductInfo: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
projectName string: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
sslMode string: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
tags InstanceTag[]

charge_detail InstanceChargeDetailArgs: Billing method and related billing information for the instance.
compute_spec str: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
file_reserved_time int: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
network_types str: Instance network type, fixed as PrivateNetwork.
storage_space int: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
subnet_id str: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
version str: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
vpc_id str: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
zone_id str: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.
allow_list_ids Sequence[str]: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
auto_scale_queue bool: Whether to automatically create queues when the instance specification changes.
eip_id str: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
enable_ssl bool: Whether to use SSL encryption.
instance_description str: Brief description of the instance. Length range: 1–128 characters.
instance_name str: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
ip_version_type str: IP version. Options are IPv4 or DualStack.
product_info InstanceProductInfoArgs: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
project_name str: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
ssl_mode str: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
tags Sequence[InstanceTagArgs]

chargeDetail Property Map: Billing method and related billing information for the instance.
computeSpec String: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
fileReservedTime Number: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
networkTypes String: Instance network type, fixed as PrivateNetwork.
storageSpace Number: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
subnetId String: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
version String: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
vpcId String: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
zoneId String: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.
allowListIds List<String>: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
autoScaleQueue Boolean: Whether to automatically create queues when the instance specification changes.
eipId String: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
enableSsl Boolean: Whether to use SSL encryption.
instanceDescription String: Brief description of the instance. Length range: 1–128 characters.
instanceName String: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
ipVersionType String: IP version. Options are IPv4 or DualStack.
productInfo Property Map: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
projectName String: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
sslMode String: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
tags List<Property Map>

Outputs

All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

AccountId string: Account ID to which the instance belongs.
ApplyPrivateDnsToPublic bool: Whether private network domain name supports public resolution. true: enabled false: disabled
AvailableQueueNumber int: Remaining number of partitions that can be created.
ConnectionInfos List<Volcengine.InstanceConnectionInfo>
CreateTime string: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
Id string: The provider-assigned unique ID for this managed resource.
InstanceId string: Instance ID.
InstanceStatus string: Instance status.
RegionId string: Region ID where the instance is located.
UsedGroupNumber int: Number of consumer groups (Group) currently created for the instance.
UsedQueueNumber int: Number of queues already used by the instance.
UsedStorageSpace int: Used storage space for the instance, in GiB.
UsedTopicNumber int: Number of topics created in the current instance.

AccountId string: Account ID to which the instance belongs.
ApplyPrivateDnsToPublic bool: Whether private network domain name supports public resolution. true: enabled false: disabled
AvailableQueueNumber int: Remaining number of partitions that can be created.
ConnectionInfos []InstanceConnectionInfo
CreateTime string: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
Id string: The provider-assigned unique ID for this managed resource.
InstanceId string: Instance ID.
InstanceStatus string: Instance status.
RegionId string: Region ID where the instance is located.
UsedGroupNumber int: Number of consumer groups (Group) currently created for the instance.
UsedQueueNumber int: Number of queues already used by the instance.
UsedStorageSpace int: Used storage space for the instance, in GiB.
UsedTopicNumber int: Number of topics created in the current instance.

accountId String: Account ID to which the instance belongs.
applyPrivateDnsToPublic Boolean: Whether private network domain name supports public resolution. true: enabled false: disabled
availableQueueNumber Integer: Remaining number of partitions that can be created.
connectionInfos List<InstanceConnectionInfo>
createTime String: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
id String: The provider-assigned unique ID for this managed resource.
instanceId String: Instance ID.
instanceStatus String: Instance status.
regionId String: Region ID where the instance is located.
usedGroupNumber Integer: Number of consumer groups (Group) currently created for the instance.
usedQueueNumber Integer: Number of queues already used by the instance.
usedStorageSpace Integer: Used storage space for the instance, in GiB.
usedTopicNumber Integer: Number of topics created in the current instance.

accountId string: Account ID to which the instance belongs.
applyPrivateDnsToPublic boolean: Whether private network domain name supports public resolution. true: enabled false: disabled
availableQueueNumber number: Remaining number of partitions that can be created.
connectionInfos InstanceConnectionInfo[]
createTime string: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
id string: The provider-assigned unique ID for this managed resource.
instanceId string: Instance ID.
instanceStatus string: Instance status.
regionId string: Region ID where the instance is located.
usedGroupNumber number: Number of consumer groups (Group) currently created for the instance.
usedQueueNumber number: Number of queues already used by the instance.
usedStorageSpace number: Used storage space for the instance, in GiB.
usedTopicNumber number: Number of topics created in the current instance.

account_id str: Account ID to which the instance belongs.
apply_private_dns_to_public bool: Whether private network domain name supports public resolution. true: enabled false: disabled
available_queue_number int: Remaining number of partitions that can be created.
connection_infos Sequence[InstanceConnectionInfo]
create_time str: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
id str: The provider-assigned unique ID for this managed resource.
instance_id str: Instance ID.
instance_status str: Instance status.
region_id str: Region ID where the instance is located.
used_group_number int: Number of consumer groups (Group) currently created for the instance.
used_queue_number int: Number of queues already used by the instance.
used_storage_space int: Used storage space for the instance, in GiB.
used_topic_number int: Number of topics created in the current instance.

accountId String: Account ID to which the instance belongs.
applyPrivateDnsToPublic Boolean: Whether private network domain name supports public resolution. true: enabled false: disabled
availableQueueNumber Number: Remaining number of partitions that can be created.
connectionInfos List<Property Map>
createTime String: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
id String: The provider-assigned unique ID for this managed resource.
instanceId String: Instance ID.
instanceStatus String: Instance status.
regionId String: Region ID where the instance is located.
usedGroupNumber Number: Number of consumer groups (Group) currently created for the instance.
usedQueueNumber Number: Number of queues already used by the instance.
usedStorageSpace Number: Used storage space for the instance, in GiB.
usedTopicNumber Number: Number of topics created in the current instance.

Look up Existing Instance Resource

Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        allow_list_ids: Optional[Sequence[str]] = None,
        apply_private_dns_to_public: Optional[bool] = None,
        auto_scale_queue: Optional[bool] = None,
        available_queue_number: Optional[int] = None,
        charge_detail: Optional[InstanceChargeDetailArgs] = None,
        compute_spec: Optional[str] = None,
        connection_infos: Optional[Sequence[InstanceConnectionInfoArgs]] = None,
        create_time: Optional[str] = None,
        eip_id: Optional[str] = None,
        enable_ssl: Optional[bool] = None,
        file_reserved_time: Optional[int] = None,
        instance_description: Optional[str] = None,
        instance_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_status: Optional[str] = None,
        ip_version_type: Optional[str] = None,
        network_types: Optional[str] = None,
        product_info: Optional[InstanceProductInfoArgs] = None,
        project_name: Optional[str] = None,
        region_id: Optional[str] = None,
        ssl_mode: Optional[str] = None,
        storage_space: Optional[int] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Sequence[InstanceTagArgs]] = None,
        used_group_number: Optional[int] = None,
        used_queue_number: Optional[int] = None,
        used_storage_space: Optional[int] = None,
        used_topic_number: Optional[int] = None,
        version: Optional[str] = None,
        vpc_id: Optional[str] = None,
        zone_id: Optional[str] = None) -> Instance

func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)

public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)

public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)

resources:  _:    type: volcenginecc:rocketmq:Instance    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.

The following state arguments are supported:

AccountId string: Account ID to which the instance belongs.
AllowListIds List<string>: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
ApplyPrivateDnsToPublic bool: Whether private network domain name supports public resolution. true: enabled false: disabled
AutoScaleQueue bool: Whether to automatically create queues when the instance specification changes.
AvailableQueueNumber int: Remaining number of partitions that can be created.
ChargeDetail Volcengine.InstanceChargeDetail: Billing method and related billing information for the instance.
ComputeSpec string: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
ConnectionInfos List<Volcengine.InstanceConnectionInfo>
CreateTime string: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
EipId string: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
EnableSsl bool: Whether to use SSL encryption.
FileReservedTime int: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
InstanceDescription string: Brief description of the instance. Length range: 1–128 characters.
InstanceId string: Instance ID.
InstanceName string: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
InstanceStatus string: Instance status.
IpVersionType string: IP version. Options are IPv4 or DualStack.
NetworkTypes string: Instance network type, fixed as PrivateNetwork.
ProductInfo Volcengine.InstanceProductInfo: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
ProjectName string: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
RegionId string: Region ID where the instance is located.
SslMode string: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
StorageSpace int: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
SubnetId string: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
Tags List<Volcengine.InstanceTag>
UsedGroupNumber int: Number of consumer groups (Group) currently created for the instance.
UsedQueueNumber int: Number of queues already used by the instance.
UsedStorageSpace int: Used storage space for the instance, in GiB.
UsedTopicNumber int: Number of topics created in the current instance.
Version string: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
VpcId string: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
ZoneId string: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.

AccountId string: Account ID to which the instance belongs.
AllowListIds []string: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
ApplyPrivateDnsToPublic bool: Whether private network domain name supports public resolution. true: enabled false: disabled
AutoScaleQueue bool: Whether to automatically create queues when the instance specification changes.
AvailableQueueNumber int: Remaining number of partitions that can be created.
ChargeDetail InstanceChargeDetailArgs: Billing method and related billing information for the instance.
ComputeSpec string: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
ConnectionInfos []InstanceConnectionInfoArgs
CreateTime string: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
EipId string: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
EnableSsl bool: Whether to use SSL encryption.
FileReservedTime int: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
InstanceDescription string: Brief description of the instance. Length range: 1–128 characters.
InstanceId string: Instance ID.
InstanceName string: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
InstanceStatus string: Instance status.
IpVersionType string: IP version. Options are IPv4 or DualStack.
NetworkTypes string: Instance network type, fixed as PrivateNetwork.
ProductInfo InstanceProductInfoArgs: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
ProjectName string: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
RegionId string: Region ID where the instance is located.
SslMode string: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
StorageSpace int: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
SubnetId string: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
Tags []InstanceTagArgs
UsedGroupNumber int: Number of consumer groups (Group) currently created for the instance.
UsedQueueNumber int: Number of queues already used by the instance.
UsedStorageSpace int: Used storage space for the instance, in GiB.
UsedTopicNumber int: Number of topics created in the current instance.
Version string: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
VpcId string: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
ZoneId string: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.

accountId String: Account ID to which the instance belongs.
allowListIds List<String>: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
applyPrivateDnsToPublic Boolean: Whether private network domain name supports public resolution. true: enabled false: disabled
autoScaleQueue Boolean: Whether to automatically create queues when the instance specification changes.
availableQueueNumber Integer: Remaining number of partitions that can be created.
chargeDetail InstanceChargeDetail: Billing method and related billing information for the instance.
computeSpec String: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
connectionInfos List<InstanceConnectionInfo>
createTime String: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
eipId String: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
enableSsl Boolean: Whether to use SSL encryption.
fileReservedTime Integer: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
instanceDescription String: Brief description of the instance. Length range: 1–128 characters.
instanceId String: Instance ID.
instanceName String: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
instanceStatus String: Instance status.
ipVersionType String: IP version. Options are IPv4 or DualStack.
networkTypes String: Instance network type, fixed as PrivateNetwork.
productInfo InstanceProductInfo: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
projectName String: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
regionId String: Region ID where the instance is located.
sslMode String: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
storageSpace Integer: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
subnetId String: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
tags List<InstanceTag>
usedGroupNumber Integer: Number of consumer groups (Group) currently created for the instance.
usedQueueNumber Integer: Number of queues already used by the instance.
usedStorageSpace Integer: Used storage space for the instance, in GiB.
usedTopicNumber Integer: Number of topics created in the current instance.
version String: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
vpcId String: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
zoneId String: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.

accountId string: Account ID to which the instance belongs.
allowListIds string[]: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
applyPrivateDnsToPublic boolean: Whether private network domain name supports public resolution. true: enabled false: disabled
autoScaleQueue boolean: Whether to automatically create queues when the instance specification changes.
availableQueueNumber number: Remaining number of partitions that can be created.
chargeDetail InstanceChargeDetail: Billing method and related billing information for the instance.
computeSpec string: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
connectionInfos InstanceConnectionInfo[]
createTime string: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
eipId string: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
enableSsl boolean: Whether to use SSL encryption.
fileReservedTime number: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
instanceDescription string: Brief description of the instance. Length range: 1–128 characters.
instanceId string: Instance ID.
instanceName string: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
instanceStatus string: Instance status.
ipVersionType string: IP version. Options are IPv4 or DualStack.
networkTypes string: Instance network type, fixed as PrivateNetwork.
productInfo InstanceProductInfo: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
projectName string: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
regionId string: Region ID where the instance is located.
sslMode string: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
storageSpace number: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
subnetId string: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
tags InstanceTag[]
usedGroupNumber number: Number of consumer groups (Group) currently created for the instance.
usedQueueNumber number: Number of queues already used by the instance.
usedStorageSpace number: Used storage space for the instance, in GiB.
usedTopicNumber number: Number of topics created in the current instance.
version string: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
vpcId string: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
zoneId string: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.

account_id str: Account ID to which the instance belongs.
allow_list_ids Sequence[str]: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
apply_private_dns_to_public bool: Whether private network domain name supports public resolution. true: enabled false: disabled
auto_scale_queue bool: Whether to automatically create queues when the instance specification changes.
available_queue_number int: Remaining number of partitions that can be created.
charge_detail InstanceChargeDetailArgs: Billing method and related billing information for the instance.
compute_spec str: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
connection_infos Sequence[InstanceConnectionInfoArgs]
create_time str: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
eip_id str: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
enable_ssl bool: Whether to use SSL encryption.
file_reserved_time int: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
instance_description str: Brief description of the instance. Length range: 1–128 characters.
instance_id str: Instance ID.
instance_name str: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
instance_status str: Instance status.
ip_version_type str: IP version. Options are IPv4 or DualStack.
network_types str: Instance network type, fixed as PrivateNetwork.
product_info InstanceProductInfoArgs: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
project_name str: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
region_id str: Region ID where the instance is located.
ssl_mode str: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
storage_space int: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
subnet_id str: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
tags Sequence[InstanceTagArgs]
used_group_number int: Number of consumer groups (Group) currently created for the instance.
used_queue_number int: Number of queues already used by the instance.
used_storage_space int: Used storage space for the instance, in GiB.
used_topic_number int: Number of topics created in the current instance.
version str: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
vpc_id str: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
zone_id str: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.

accountId String: Account ID to which the instance belongs.
allowListIds List<String>: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
applyPrivateDnsToPublic Boolean: Whether private network domain name supports public resolution. true: enabled false: disabled
autoScaleQueue Boolean: Whether to automatically create queues when the instance specification changes.
availableQueueNumber Number: Remaining number of partitions that can be created.
chargeDetail Property Map: Billing method and related billing information for the instance.
computeSpec String: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
connectionInfos List<Property Map>
createTime String: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
eipId String: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
enableSsl Boolean: Whether to use SSL encryption.
fileReservedTime Number: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
instanceDescription String: Brief description of the instance. Length range: 1–128 characters.
instanceId String: Instance ID.
instanceName String: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
instanceStatus String: Instance status.
ipVersionType String: IP version. Options are IPv4 or DualStack.
networkTypes String: Instance network type, fixed as PrivateNetwork.
productInfo Property Map: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
projectName String: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
regionId String: Region ID where the instance is located.
sslMode String: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
storageSpace Number: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
subnetId String: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
tags List<Property Map>
usedGroupNumber Number: Number of consumer groups (Group) currently created for the instance.
usedQueueNumber Number: Number of queues already used by the instance.
usedStorageSpace Number: Used storage space for the instance, in GiB.
usedTopicNumber Number: Number of topics created in the current instance.
version String: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
vpcId String: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
zoneId String: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.

Supporting Types

InstanceChargeDetail, InstanceChargeDetailArgs

AutoRenew bool: Whether the subscription instance is automatically renewed upon expiration. true: automatically renewed. false: not automatically renewed. Manual renewal is required after expiration; otherwise, the instance will be shut down.
ChargeExpireTime string: Expiration time for yearly/monthly subscription instances. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'. For pay-as-you-go instances, this field defaults to 1970-01-01T00:00:00Z.
ChargeStartTime string: Billing start time for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
ChargeStatus string: Instance billing status. Includes: Normal: normal Overdue: pay-as-you-go overdue Expired: subscription expired
ChargeType string: Billing type for the instance. Supported types include: PostPaid: pay-as-you-go; PrePaid: yearly/monthly subscription
OverdueReclaimTime string: Estimated release time after the instance is suspended due to overdue payment. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
OverdueTime string: Suspension time due to overdue payment for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
Period int: Purchase duration for subscription instances. When PeriodUnit is set to Monthly, the value range is 1–9. When PeriodUnit is set to Yearly, the value range is 1–3. Only required for subscription instances, that is, when ChargeType is set to PrePaid.
PeriodUnit string: Lifecycle unit for subscription-based instances, specifying whether to purchase by month or by year. Monthly: (default) monthly subscription Yearly: annual subscription

AutoRenew bool: Whether the subscription instance is automatically renewed upon expiration. true: automatically renewed. false: not automatically renewed. Manual renewal is required after expiration; otherwise, the instance will be shut down.
ChargeExpireTime string: Expiration time for yearly/monthly subscription instances. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'. For pay-as-you-go instances, this field defaults to 1970-01-01T00:00:00Z.
ChargeStartTime string: Billing start time for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
ChargeStatus string: Instance billing status. Includes: Normal: normal Overdue: pay-as-you-go overdue Expired: subscription expired
ChargeType string: Billing type for the instance. Supported types include: PostPaid: pay-as-you-go; PrePaid: yearly/monthly subscription
OverdueReclaimTime string: Estimated release time after the instance is suspended due to overdue payment. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
OverdueTime string: Suspension time due to overdue payment for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
Period int: Purchase duration for subscription instances. When PeriodUnit is set to Monthly, the value range is 1–9. When PeriodUnit is set to Yearly, the value range is 1–3. Only required for subscription instances, that is, when ChargeType is set to PrePaid.
PeriodUnit string: Lifecycle unit for subscription-based instances, specifying whether to purchase by month or by year. Monthly: (default) monthly subscription Yearly: annual subscription

autoRenew Boolean: Whether the subscription instance is automatically renewed upon expiration. true: automatically renewed. false: not automatically renewed. Manual renewal is required after expiration; otherwise, the instance will be shut down.
chargeExpireTime String: Expiration time for yearly/monthly subscription instances. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'. For pay-as-you-go instances, this field defaults to 1970-01-01T00:00:00Z.
chargeStartTime String: Billing start time for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
chargeStatus String: Instance billing status. Includes: Normal: normal Overdue: pay-as-you-go overdue Expired: subscription expired
chargeType String: Billing type for the instance. Supported types include: PostPaid: pay-as-you-go; PrePaid: yearly/monthly subscription
overdueReclaimTime String: Estimated release time after the instance is suspended due to overdue payment. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
overdueTime String: Suspension time due to overdue payment for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
period Integer: Purchase duration for subscription instances. When PeriodUnit is set to Monthly, the value range is 1–9. When PeriodUnit is set to Yearly, the value range is 1–3. Only required for subscription instances, that is, when ChargeType is set to PrePaid.
periodUnit String: Lifecycle unit for subscription-based instances, specifying whether to purchase by month or by year. Monthly: (default) monthly subscription Yearly: annual subscription

autoRenew boolean: Whether the subscription instance is automatically renewed upon expiration. true: automatically renewed. false: not automatically renewed. Manual renewal is required after expiration; otherwise, the instance will be shut down.
chargeExpireTime string: Expiration time for yearly/monthly subscription instances. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'. For pay-as-you-go instances, this field defaults to 1970-01-01T00:00:00Z.
chargeStartTime string: Billing start time for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
chargeStatus string: Instance billing status. Includes: Normal: normal Overdue: pay-as-you-go overdue Expired: subscription expired
chargeType string: Billing type for the instance. Supported types include: PostPaid: pay-as-you-go; PrePaid: yearly/monthly subscription
overdueReclaimTime string: Estimated release time after the instance is suspended due to overdue payment. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
overdueTime string: Suspension time due to overdue payment for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
period number: Purchase duration for subscription instances. When PeriodUnit is set to Monthly, the value range is 1–9. When PeriodUnit is set to Yearly, the value range is 1–3. Only required for subscription instances, that is, when ChargeType is set to PrePaid.
periodUnit string: Lifecycle unit for subscription-based instances, specifying whether to purchase by month or by year. Monthly: (default) monthly subscription Yearly: annual subscription

auto_renew bool: Whether the subscription instance is automatically renewed upon expiration. true: automatically renewed. false: not automatically renewed. Manual renewal is required after expiration; otherwise, the instance will be shut down.
charge_expire_time str: Expiration time for yearly/monthly subscription instances. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'. For pay-as-you-go instances, this field defaults to 1970-01-01T00:00:00Z.
charge_start_time str: Billing start time for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
charge_status str: Instance billing status. Includes: Normal: normal Overdue: pay-as-you-go overdue Expired: subscription expired
charge_type str: Billing type for the instance. Supported types include: PostPaid: pay-as-you-go; PrePaid: yearly/monthly subscription
overdue_reclaim_time str: Estimated release time after the instance is suspended due to overdue payment. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
overdue_time str: Suspension time due to overdue payment for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
period int: Purchase duration for subscription instances. When PeriodUnit is set to Monthly, the value range is 1–9. When PeriodUnit is set to Yearly, the value range is 1–3. Only required for subscription instances, that is, when ChargeType is set to PrePaid.
period_unit str: Lifecycle unit for subscription-based instances, specifying whether to purchase by month or by year. Monthly: (default) monthly subscription Yearly: annual subscription

autoRenew Boolean: Whether the subscription instance is automatically renewed upon expiration. true: automatically renewed. false: not automatically renewed. Manual renewal is required after expiration; otherwise, the instance will be shut down.
chargeExpireTime String: Expiration time for yearly/monthly subscription instances. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'. For pay-as-you-go instances, this field defaults to 1970-01-01T00:00:00Z.
chargeStartTime String: Billing start time for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
chargeStatus String: Instance billing status. Includes: Normal: normal Overdue: pay-as-you-go overdue Expired: subscription expired
chargeType String: Billing type for the instance. Supported types include: PostPaid: pay-as-you-go; PrePaid: yearly/monthly subscription
overdueReclaimTime String: Estimated release time after the instance is suspended due to overdue payment. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
overdueTime String: Suspension time due to overdue payment for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
period Number: Purchase duration for subscription instances. When PeriodUnit is set to Monthly, the value range is 1–9. When PeriodUnit is set to Yearly, the value range is 1–3. Only required for subscription instances, that is, when ChargeType is set to PrePaid.
periodUnit String: Lifecycle unit for subscription-based instances, specifying whether to purchase by month or by year. Monthly: (default) monthly subscription Yearly: annual subscription

InstanceConnectionInfo, InstanceConnectionInfoArgs

EndpointAddressIp string: Instance endpoint IP address.
EndpointType string: Instance access point type.
InternalEndpoint string: Private network endpoint address for the instance.
NetworkType string: Instance access point type.
PublicEndpoint string: Public access point address of the instance.

EndpointAddressIp string: Instance endpoint IP address.
EndpointType string: Instance access point type.
InternalEndpoint string: Private network endpoint address for the instance.
NetworkType string: Instance access point type.
PublicEndpoint string: Public access point address of the instance.

endpointAddressIp String: Instance endpoint IP address.
endpointType String: Instance access point type.
internalEndpoint String: Private network endpoint address for the instance.
networkType String: Instance access point type.
publicEndpoint String: Public access point address of the instance.

endpointAddressIp string: Instance endpoint IP address.
endpointType string: Instance access point type.
internalEndpoint string: Private network endpoint address for the instance.
networkType string: Instance access point type.
publicEndpoint string: Public access point address of the instance.

endpoint_address_ip str: Instance endpoint IP address.
endpoint_type str: Instance access point type.
internal_endpoint str: Private network endpoint address for the instance.
network_type str: Instance access point type.
public_endpoint str: Public access point address of the instance.

endpointAddressIp String: Instance endpoint IP address.
endpointType String: Instance access point type.
internalEndpoint String: Private network endpoint address for the instance.
networkType String: Instance access point type.
publicEndpoint String: Public access point address of the instance.

InstanceProductInfo, InstanceProductInfoArgs

SendReceiveRatio int: Edit the read/write throttling ratio. The default read/write ratio is 50% each. For example, if set to 40, the sending TPS ratio is 40% and the subscription ratio is 60%. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.

SendReceiveRatio int: Edit the read/write throttling ratio. The default read/write ratio is 50% each. For example, if set to 40, the sending TPS ratio is 40% and the subscription ratio is 60%. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.

sendReceiveRatio Integer: Edit the read/write throttling ratio. The default read/write ratio is 50% each. For example, if set to 40, the sending TPS ratio is 40% and the subscription ratio is 60%. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.

sendReceiveRatio number: Edit the read/write throttling ratio. The default read/write ratio is 50% each. For example, if set to 40, the sending TPS ratio is 40% and the subscription ratio is 60%. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.

send_receive_ratio int: Edit the read/write throttling ratio. The default read/write ratio is 50% each. For example, if set to 40, the sending TPS ratio is 40% and the subscription ratio is 60%. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.

sendReceiveRatio Number: Edit the read/write throttling ratio. The default read/write ratio is 50% each. For example, if set to 40, the sending TPS ratio is 40% and the subscription ratio is 60%. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.

InstanceTag, InstanceTagArgs

Key string: Tag key.
Value string: Tag value.

Key string: Tag key.
Value string: Tag value.

key String: Tag key.
value String: Tag value.

key string: Tag key.
value string: Tag value.

key str: Tag key.
value str: Tag value.

key String: Tag key.
value String: Tag value.

Import

$ pulumi import volcenginecc:rocketmq/instance:Instance example "instance_id"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.rocketmq.Instance

On this page

On this page

Example Usage

Create Instance Resource

Constructor syntax

Parameters

Instance Resource Properties

Inputs

Outputs

Look up Existing Instance Resource

Supporting Types

InstanceChargeDetail, InstanceChargeDetailArgs

InstanceConnectionInfo, InstanceConnectionInfoArgs

InstanceProductInfo, InstanceProductInfoArgs

InstanceTag, InstanceTagArgs

Import

Package Details

On this page

On this page