This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

rocketmq¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

class pulumi_alicloud.rocketmq.Acl(resource_name, opts=None, name=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Sag Acl resource. Smart Access Gateway (SAG) provides the access control list (ACL) function in the form of whitelists and blacklists for different SAG instances.

For information about Sag Acl and how to use it, see What is access control list (ACL).

NOTE: Available in 1.60.0+
NOTE: Only the following regions support create Cloud Connect Network. [cn-shanghai, cn-shanghai-finance-1, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1]

import pulumi
import pulumi_alicloud as alicloud

default = alicloud.rocketmq.Acl("default")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the ACL instance. The name can contain 2 to 128 characters including a-z, A-Z, 0-9, periods, underlines, and hyphens. The name must start with an English letter, but cannot start with http:// or https://.

name: pulumi.Output[str] = None¶: The name of the ACL instance. The name can contain 2 to 128 characters including a-z, A-Z, 0-9, periods, underlines, and hyphens. The name must start with an English letter, but cannot start with http:// or https://.

static get(resource_name, id, opts=None, name=None)¶

Get an existing Acl resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the ACL instance. The name can contain 2 to 128 characters including a-z, A-Z, 0-9, periods, underlines, and hyphens. The name must start with an English letter, but cannot start with http:// or https://.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.rocketmq.AclRule(resource_name, opts=None, acl_id=None, description=None, dest_cidr=None, dest_port_range=None, direction=None, ip_protocol=None, policy=None, priority=None, source_cidr=None, source_port_range=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Sag Acl Rule resource. This topic describes how to configure an access control list (ACL) rule for a target Smart Access Gateway instance to permit or deny access to or from specified IP addresses in the ACL rule.

For information about Sag Acl Rule and how to use it, see What is access control list (ACL) rule.

NOTE: Available in 1.60.0+
NOTE: Only the following regions support create Cloud Connect Network. [cn-shanghai, cn-shanghai-finance-1, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1]

import pulumi
import pulumi_alicloud as alicloud

default_acl = alicloud.rocketmq.Acl("defaultAcl", sag_count="0")
default_acl_rule = alicloud.rocketmq.AclRule("defaultAclRule",
    acl_id=default_acl.id,
    description="tf-testSagAclRule",
    dest_cidr="192.168.1.0/24",
    dest_port_range="-1/-1",
    direction="in",
    ip_protocol="ALL",
    policy="accept",
    priority="1",
    source_cidr="10.10.1.0/24",
    source_port_range="-1/-1")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
acl_id (pulumi.Input[str]) – The ID of the ACL.
description (pulumi.Input[str]) – The description of the ACL rule. It must be 1 to 512 characters in length.
dest_cidr (pulumi.Input[str]) – The destination address. It is an IPv4 address range in CIDR format. Default value: 0.0.0.0/0.
dest_port_range (pulumi.Input[str]) – The range of the destination port. Valid value: 80/80.
direction (pulumi.Input[str]) – The direction of the ACL rule. Valid values: in|out.
ip_protocol (pulumi.Input[str]) – The protocol used by the ACL rule. The value is not case sensitive.
policy (pulumi.Input[str]) – The policy used by the ACL rule. Valid values: accept|drop.
priority (pulumi.Input[float]) – The priority of the ACL rule. Value range: 1 to 100.
source_cidr (pulumi.Input[str]) – The source address. It is an IPv4 address range in the CIDR format. Default value: 0.0.0.0/0.
source_port_range (pulumi.Input[str]) – The range of the source port. Valid value: 80/80.

acl_id: pulumi.Output[str] = None¶: The ID of the ACL.

description: pulumi.Output[str] = None¶: The description of the ACL rule. It must be 1 to 512 characters in length.

dest_cidr: pulumi.Output[str] = None¶: The destination address. It is an IPv4 address range in CIDR format. Default value: 0.0.0.0/0.

dest_port_range: pulumi.Output[str] = None¶: The range of the destination port. Valid value: 80/80.

direction: pulumi.Output[str] = None¶: The direction of the ACL rule. Valid values: in|out.

ip_protocol: pulumi.Output[str] = None¶: The protocol used by the ACL rule. The value is not case sensitive.

policy: pulumi.Output[str] = None¶: The policy used by the ACL rule. Valid values: accept|drop.

priority: pulumi.Output[float] = None¶: The priority of the ACL rule. Value range: 1 to 100.

source_cidr: pulumi.Output[str] = None¶: The source address. It is an IPv4 address range in the CIDR format. Default value: 0.0.0.0/0.

source_port_range: pulumi.Output[str] = None¶: The range of the source port. Valid value: 80/80.

static get(resource_name, id, opts=None, acl_id=None, description=None, dest_cidr=None, dest_port_range=None, direction=None, ip_protocol=None, policy=None, priority=None, source_cidr=None, source_port_range=None)¶

Get an existing AclRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
acl_id (pulumi.Input[str]) – The ID of the ACL.
description (pulumi.Input[str]) – The description of the ACL rule. It must be 1 to 512 characters in length.
dest_cidr (pulumi.Input[str]) – The destination address. It is an IPv4 address range in CIDR format. Default value: 0.0.0.0/0.
dest_port_range (pulumi.Input[str]) – The range of the destination port. Valid value: 80/80.
direction (pulumi.Input[str]) – The direction of the ACL rule. Valid values: in|out.
ip_protocol (pulumi.Input[str]) – The protocol used by the ACL rule. The value is not case sensitive.
policy (pulumi.Input[str]) – The policy used by the ACL rule. Valid values: accept|drop.
priority (pulumi.Input[float]) – The priority of the ACL rule. Value range: 1 to 100.
source_cidr (pulumi.Input[str]) – The source address. It is an IPv4 address range in the CIDR format. Default value: 0.0.0.0/0.
source_port_range (pulumi.Input[str]) – The range of the source port. Valid value: 80/80.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.rocketmq.AwaitableGetGroupsResult(group_id_regex=None, groups=None, id=None, ids=None, instance_id=None, output_file=None)¶

class pulumi_alicloud.rocketmq.AwaitableGetInstancesResult(id=None, ids=None, instances=None, name_regex=None, names=None, output_file=None)¶

class pulumi_alicloud.rocketmq.AwaitableGetTopicsResult(id=None, instance_id=None, name_regex=None, names=None, output_file=None, topics=None)¶

class pulumi_alicloud.rocketmq.ClientUser(resource_name, opts=None, bandwidth=None, client_ip=None, kms_encrypted_password=None, kms_encryption_context=None, password=None, sag_id=None, user_mail=None, user_name=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Sag ClientUser resource. This topic describes how to manage accounts as an administrator. After you configure the network, you can create multiple accounts and distribute them to end users so that clients can access Alibaba Cloud.

For information about Sag ClientUser and how to use it, see What is Sag ClientUser.

NOTE: Available in 1.65.0+
NOTE: Only the following regions support. [cn-shanghai, cn-shanghai-finance-1, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1]

import pulumi
import pulumi_alicloud as alicloud

default = alicloud.rocketmq.ClientUser("default",
    bandwidth="20",
    client_ip="192.1.10.0",
    password="xxxxxxx",
    sag_id="sag-xxxxx",
    user_mail="tftest-xxxxx@test.com",
    user_name="th-username-xxxxx")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
bandwidth (pulumi.Input[float]) – The SAG APP bandwidth that the user can use. Unit: Kbit/s. Maximum value: 2000 Kbit/s.
client_ip (pulumi.Input[str]) – The IP address of the SAG APP. If you specify this parameter, the current account always uses the specified IP address.Note The IP address must be in the private CIDR block of the SAG client.If you do not specify this parameter, the system automatically allocates an IP address from the private CIDR block of the SAG client. In this case, each re-connection uses a different IP address.
password (pulumi.Input[str]) – The password used to log on to the SAG APP.Both the user name and the password must be specified. If you specify the user name, the password must be specified, too.
sag_id (pulumi.Input[str]) – The ID of the SAG instance created for the SAG APP.
user_mail (pulumi.Input[str]) – The email address of the user. The administrator uses this address to send the account information for logging on to the APP to the user.
user_name (pulumi.Input[str]) – The user name. User names in the same SAG APP must be unique.Both the user name and the password must be specified. If you specify the user name, the password must be specified, too.

bandwidth: pulumi.Output[float] = None¶: The SAG APP bandwidth that the user can use. Unit: Kbit/s. Maximum value: 2000 Kbit/s.

client_ip: pulumi.Output[str] = None¶: The IP address of the SAG APP. If you specify this parameter, the current account always uses the specified IP address.Note The IP address must be in the private CIDR block of the SAG client.If you do not specify this parameter, the system automatically allocates an IP address from the private CIDR block of the SAG client. In this case, each re-connection uses a different IP address.

password: pulumi.Output[str] = None¶: The password used to log on to the SAG APP.Both the user name and the password must be specified. If you specify the user name, the password must be specified, too.

sag_id: pulumi.Output[str] = None¶: The ID of the SAG instance created for the SAG APP.

user_mail: pulumi.Output[str] = None¶: The email address of the user. The administrator uses this address to send the account information for logging on to the APP to the user.

user_name: pulumi.Output[str] = None¶: The user name. User names in the same SAG APP must be unique.Both the user name and the password must be specified. If you specify the user name, the password must be specified, too.

static get(resource_name, id, opts=None, bandwidth=None, client_ip=None, kms_encrypted_password=None, kms_encryption_context=None, password=None, sag_id=None, user_mail=None, user_name=None)¶

Get an existing ClientUser resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
bandwidth (pulumi.Input[float]) – The SAG APP bandwidth that the user can use. Unit: Kbit/s. Maximum value: 2000 Kbit/s.
client_ip (pulumi.Input[str]) – The IP address of the SAG APP. If you specify this parameter, the current account always uses the specified IP address.Note The IP address must be in the private CIDR block of the SAG client.If you do not specify this parameter, the system automatically allocates an IP address from the private CIDR block of the SAG client. In this case, each re-connection uses a different IP address.
password (pulumi.Input[str]) – The password used to log on to the SAG APP.Both the user name and the password must be specified. If you specify the user name, the password must be specified, too.
sag_id (pulumi.Input[str]) – The ID of the SAG instance created for the SAG APP.
user_mail (pulumi.Input[str]) – The email address of the user. The administrator uses this address to send the account information for logging on to the APP to the user.
user_name (pulumi.Input[str]) – The user name. User names in the same SAG APP must be unique.Both the user name and the password must be specified. If you specify the user name, the password must be specified, too.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.rocketmq.DnatEntry(resource_name, opts=None, external_ip=None, external_port=None, internal_ip=None, internal_port=None, ip_protocol=None, sag_id=None, type=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Sag DnatEntry resource. This topic describes how to add a DNAT entry to a Smart Access Gateway (SAG) instance to enable the DNAT function. By using the DNAT function, you can forward requests received by public IP addresses to Alibaba Cloud instances according to custom mapping rules.

For information about Sag DnatEntry and how to use it, see What is Sag DnatEntry.

NOTE: Available in 1.63.0+
NOTE: Only the following regions suppor. [cn-shanghai, cn-shanghai-finance-1, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1]

import pulumi
import pulumi_alicloud as alicloud

default = alicloud.rocketmq.DnatEntry("default",
    external_ip="1.0.0.2",
    external_port="1",
    internal_ip="10.0.0.2",
    internal_port="20",
    ip_protocol="tcp",
    sag_id="sag-3rb1t3iagy3w0zgwy9",
    type="Intranet")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
external_ip (pulumi.Input[str]) – The external public IP address.when “type” is “Internet”,automatically identify the external ip.
external_port (pulumi.Input[str]) – The public port.Value range: 1 to 65535 or “any”.
internal_ip (pulumi.Input[str]) – The destination private IP address.
internal_port (pulumi.Input[str]) – The destination private port.Value range: 1 to 65535 or “any”.
ip_protocol (pulumi.Input[str]) – The protocol type. Valid values: TCP: Forwards packets of the TCP protocol. UDP: Forwards packets of the UDP protocol. Any: Forwards packets of all protocols.
sag_id (pulumi.Input[str]) – The ID of the SAG instance.
type (pulumi.Input[str]) – The DNAT type. Valid values: Intranet: DNAT of private IP addresses. Internet: DNAT of public IP addresses

external_ip: pulumi.Output[str] = None¶: The external public IP address.when “type” is “Internet”,automatically identify the external ip.

external_port: pulumi.Output[str] = None¶: The public port.Value range: 1 to 65535 or “any”.

internal_ip: pulumi.Output[str] = None¶: The destination private IP address.

internal_port: pulumi.Output[str] = None¶: The destination private port.Value range: 1 to 65535 or “any”.

ip_protocol: pulumi.Output[str] = None¶: The protocol type. Valid values: TCP: Forwards packets of the TCP protocol. UDP: Forwards packets of the UDP protocol. Any: Forwards packets of all protocols.

sag_id: pulumi.Output[str] = None¶: The ID of the SAG instance.

type: pulumi.Output[str] = None¶: The DNAT type. Valid values: Intranet: DNAT of private IP addresses. Internet: DNAT of public IP addresses

static get(resource_name, id, opts=None, external_ip=None, external_port=None, internal_ip=None, internal_port=None, ip_protocol=None, sag_id=None, type=None)¶

Get an existing DnatEntry resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
external_ip (pulumi.Input[str]) – The external public IP address.when “type” is “Internet”,automatically identify the external ip.
external_port (pulumi.Input[str]) – The public port.Value range: 1 to 65535 or “any”.
internal_ip (pulumi.Input[str]) – The destination private IP address.
internal_port (pulumi.Input[str]) – The destination private port.Value range: 1 to 65535 or “any”.
ip_protocol (pulumi.Input[str]) – The protocol type. Valid values: TCP: Forwards packets of the TCP protocol. UDP: Forwards packets of the UDP protocol. Any: Forwards packets of all protocols.
sag_id (pulumi.Input[str]) – The ID of the SAG instance.
type (pulumi.Input[str]) – The DNAT type. Valid values: Intranet: DNAT of private IP addresses. Internet: DNAT of public IP addresses

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.rocketmq.GetGroupsResult(group_id_regex=None, groups=None, id=None, ids=None, instance_id=None, output_file=None)¶

A collection of values returned by getGroups.

groups = None¶: A list of groups. Each element contains the following attributes:

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of group names.

class pulumi_alicloud.rocketmq.GetInstancesResult(id=None, ids=None, instances=None, name_regex=None, names=None, output_file=None)¶

A collection of values returned by getInstances.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of instance IDs.

instances = None¶: A list of instances. Each element contains the following attributes:

names = None¶: A list of instance names.

class pulumi_alicloud.rocketmq.GetTopicsResult(id=None, instance_id=None, name_regex=None, names=None, output_file=None, topics=None)¶

A collection of values returned by getTopics.

id = None¶: The provider-assigned unique ID for this managed resource.

names = None¶: A list of topic names.

topics = None¶: A list of topics. Each element contains the following attributes:

class pulumi_alicloud.rocketmq.Group(resource_name, opts=None, group_id=None, instance_id=None, read_enable=None, remark=None, __props__=None, __name__=None, __opts__=None)¶

Provides an ONS group resource.

For more information about how to use it, see RocketMQ Group Management API.

NOTE: Available in 1.53.0+

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "onsInstanceName"
group_id = config.get("groupId")
if group_id is None:
    group_id = "GID-onsGroupDatasourceName"
default_instance = alicloud.rocketmq.Instance("defaultInstance", remark="default_ons_instance_remark")
default_group = alicloud.rocketmq.Group("defaultGroup",
    group_id=group_id,
    instance_id=default_instance.id,
    remark="dafault_ons_group_remark")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
group_id (pulumi.Input[str]) – Name of the group. Two groups on a single instance cannot have the same name. A group_id starts with “GID” or “GID-“, and contains letters, numbers, hyphens (-), and underscores ().
instance_id (pulumi.Input[str]) – ID of the ONS Instance that owns the groups.
read_enable (pulumi.Input[bool]) – This attribute is used to set the message reading enabled or disabled. It can only be set after the group is used by the client.
remark (pulumi.Input[str]) – This attribute is a concise description of group. The length cannot exceed 256.

group_id: pulumi.Output[str] = None¶: Name of the group. Two groups on a single instance cannot have the same name. A group_id starts with “GID” or “GID-“, and contains letters, numbers, hyphens (-), and underscores ().

instance_id: pulumi.Output[str] = None¶: ID of the ONS Instance that owns the groups.

read_enable: pulumi.Output[bool] = None¶: This attribute is used to set the message reading enabled or disabled. It can only be set after the group is used by the client.

remark: pulumi.Output[str] = None¶: This attribute is a concise description of group. The length cannot exceed 256.

static get(resource_name, id, opts=None, group_id=None, instance_id=None, read_enable=None, remark=None)¶

Get an existing Group resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
group_id (pulumi.Input[str]) – Name of the group. Two groups on a single instance cannot have the same name. A group_id starts with “GID” or “GID-“, and contains letters, numbers, hyphens (-), and underscores ().
instance_id (pulumi.Input[str]) – ID of the ONS Instance that owns the groups.
read_enable (pulumi.Input[bool]) – This attribute is used to set the message reading enabled or disabled. It can only be set after the group is used by the client.
remark (pulumi.Input[str]) – This attribute is a concise description of group. The length cannot exceed 256.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.rocketmq.Instance(resource_name, opts=None, name=None, remark=None, __props__=None, __name__=None, __opts__=None)¶

Provides an ONS instance resource.

For more information about how to use it, see RocketMQ Instance Management API.

NOTE: The number of instances in the same region cannot exceed 8. At present, the resource does not support region “mq-internet-access” and “ap-southeast-5”.
NOTE: Available in 1.51.0+

import pulumi
import pulumi_alicloud as alicloud

example = alicloud.rocketmq.Instance("example", remark="tf-example-ons-instance-remark")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – Two instances on a single account in the same region cannot have the same name. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed.
remark (pulumi.Input[str]) – This attribute is a concise description of instance. The length cannot exceed 128.

instance_status: pulumi.Output[float] = None¶: The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.

instance_type: pulumi.Output[float] = None¶: The edition of instance. 1 represents the postPaid edition, and 2 represents the platinum edition.

name: pulumi.Output[str] = None¶: Two instances on a single account in the same region cannot have the same name. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed.

release_time: pulumi.Output[str] = None¶: Platinum edition instance expiration time.

remark: pulumi.Output[str] = None¶: This attribute is a concise description of instance. The length cannot exceed 128.

static get(resource_name, id, opts=None, instance_status=None, instance_type=None, name=None, release_time=None, remark=None)¶

Get an existing Instance resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
instance_status (pulumi.Input[float]) – The status of instance. 1 represents the platinum edition instance is in deployment. 2 represents the postpaid edition instance are overdue. 5 represents the postpaid or platinum edition instance is in service. 7 represents the platinum version instance is in upgrade and the service is available.
instance_type (pulumi.Input[float]) – The edition of instance. 1 represents the postPaid edition, and 2 represents the platinum edition.
name (pulumi.Input[str]) – Two instances on a single account in the same region cannot have the same name. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed.
release_time (pulumi.Input[str]) – Platinum edition instance expiration time.
remark (pulumi.Input[str]) – This attribute is a concise description of instance. The length cannot exceed 128.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.rocketmq.Qos(resource_name, opts=None, name=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Sag Qos resource. Smart Access Gateway (SAG) supports quintuple-based QoS functions to differentiate traffic of different services and ensure high-priority traffic bandwidth.

For information about Sag Qos and how to use it, see What is Qos.

NOTE: Available in 1.60.0+
NOTE: Only the following regions support. [cn-shanghai, cn-shanghai-finance-1, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1]

import pulumi
import pulumi_alicloud as alicloud

default = alicloud.rocketmq.Qos("default")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the QoS policy to be created. The name can contain 2 to 128 characters including a-z, A-Z, 0-9, periods, underlines, and hyphens. The name must start with an English letter, but cannot start with http:// or https://.

name: pulumi.Output[str] = None¶: The name of the QoS policy to be created. The name can contain 2 to 128 characters including a-z, A-Z, 0-9, periods, underlines, and hyphens. The name must start with an English letter, but cannot start with http:// or https://.

static get(resource_name, id, opts=None, name=None)¶

Get an existing Qos resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the QoS policy to be created. The name can contain 2 to 128 characters including a-z, A-Z, 0-9, periods, underlines, and hyphens. The name must start with an English letter, but cannot start with http:// or https://.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.rocketmq.QosCar(resource_name, opts=None, description=None, limit_type=None, max_bandwidth_abs=None, max_bandwidth_percent=None, min_bandwidth_abs=None, min_bandwidth_percent=None, name=None, percent_source_type=None, priority=None, qos_id=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Sag qos car resource. You need to create a QoS car to set priorities, rate limits, and quintuple rules for different messages.

For information about Sag Qos Car and how to use it, see What is Qos Car.

NOTE: Available in 1.60.0+
NOTE: Only the following regions support. [cn-shanghai, cn-shanghai-finance-1, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1]

import pulumi
import pulumi_alicloud as alicloud

default_qos = alicloud.rocketmq.Qos("defaultQos")
default_qos_car = alicloud.rocketmq.QosCar("defaultQosCar",
    description="tf-testSagQosCarDescription",
    limit_type="Absolute",
    max_bandwidth_abs="20",
    max_bandwidth_percent="20",
    min_bandwidth_abs="10",
    min_bandwidth_percent="10",
    percent_source_type="InternetUpBandwidth",
    priority="1",
    qos_id=default_qos.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description of the QoS speed limiting rule.
limit_type (pulumi.Input[str]) – The speed limiting method. Valid values: Absolute, Percent.
max_bandwidth_abs (pulumi.Input[float]) – The maximum bandwidth allowed for the stream specified in the quintuple rule. This parameter is required when the value of the LimitType is Absolute.
max_bandwidth_percent (pulumi.Input[float]) – The maximum bandwidth percentage allowed for the stream specified in the quintuple rule. It is based on the maximum upstream bandwidth you set for the associated Smart Access Gateway (SAG) instance.This parameter is required when the value of the LimitType parameter is Percent.
min_bandwidth_abs (pulumi.Input[float]) – The minimum bandwidth allowed for the stream specified in the quintuple rule. This parameter is required when the value of the LimitType parameter is Absolute.
min_bandwidth_percent (pulumi.Input[float]) – The minimum bandwidth percentage allowed for the stream specified in the quintuple rule. It is based on the maximum upstream bandwidth you set for the associated SAG instance.This parameter is required when the value of the LimitType parameter is Percent.
name (pulumi.Input[str]) – The name of the QoS speed limiting rule..
percent_source_type (pulumi.Input[str]) – The bandwidth type when the speed is limited based on percentage. Valid values: CcnBandwidth, InternetUpBandwidth.The default value is InternetUpBandwidth.
priority (pulumi.Input[float]) – The priority of the specified stream.
qos_id (pulumi.Input[str]) – The instance ID of the QoS.

description: pulumi.Output[str] = None¶: The description of the QoS speed limiting rule.

limit_type: pulumi.Output[str] = None¶: The speed limiting method. Valid values: Absolute, Percent.

max_bandwidth_abs: pulumi.Output[float] = None¶: The maximum bandwidth allowed for the stream specified in the quintuple rule. This parameter is required when the value of the LimitType is Absolute.

max_bandwidth_percent: pulumi.Output[float] = None¶: The maximum bandwidth percentage allowed for the stream specified in the quintuple rule. It is based on the maximum upstream bandwidth you set for the associated Smart Access Gateway (SAG) instance.This parameter is required when the value of the LimitType parameter is Percent.

min_bandwidth_abs: pulumi.Output[float] = None¶: The minimum bandwidth allowed for the stream specified in the quintuple rule. This parameter is required when the value of the LimitType parameter is Absolute.

min_bandwidth_percent: pulumi.Output[float] = None¶: The minimum bandwidth percentage allowed for the stream specified in the quintuple rule. It is based on the maximum upstream bandwidth you set for the associated SAG instance.This parameter is required when the value of the LimitType parameter is Percent.

name: pulumi.Output[str] = None¶: The name of the QoS speed limiting rule..

percent_source_type: pulumi.Output[str] = None¶: The bandwidth type when the speed is limited based on percentage. Valid values: CcnBandwidth, InternetUpBandwidth.The default value is InternetUpBandwidth.

priority: pulumi.Output[float] = None¶: The priority of the specified stream.

qos_id: pulumi.Output[str] = None¶: The instance ID of the QoS.

static get(resource_name, id, opts=None, description=None, limit_type=None, max_bandwidth_abs=None, max_bandwidth_percent=None, min_bandwidth_abs=None, min_bandwidth_percent=None, name=None, percent_source_type=None, priority=None, qos_id=None)¶

Get an existing QosCar resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description of the QoS speed limiting rule.
limit_type (pulumi.Input[str]) – The speed limiting method. Valid values: Absolute, Percent.
max_bandwidth_abs (pulumi.Input[float]) – The maximum bandwidth allowed for the stream specified in the quintuple rule. This parameter is required when the value of the LimitType is Absolute.
max_bandwidth_percent (pulumi.Input[float]) – The maximum bandwidth percentage allowed for the stream specified in the quintuple rule. It is based on the maximum upstream bandwidth you set for the associated Smart Access Gateway (SAG) instance.This parameter is required when the value of the LimitType parameter is Percent.
min_bandwidth_abs (pulumi.Input[float]) – The minimum bandwidth allowed for the stream specified in the quintuple rule. This parameter is required when the value of the LimitType parameter is Absolute.
min_bandwidth_percent (pulumi.Input[float]) – The minimum bandwidth percentage allowed for the stream specified in the quintuple rule. It is based on the maximum upstream bandwidth you set for the associated SAG instance.This parameter is required when the value of the LimitType parameter is Percent.
name (pulumi.Input[str]) – The name of the QoS speed limiting rule..
percent_source_type (pulumi.Input[str]) – The bandwidth type when the speed is limited based on percentage. Valid values: CcnBandwidth, InternetUpBandwidth.The default value is InternetUpBandwidth.
priority (pulumi.Input[float]) – The priority of the specified stream.
qos_id (pulumi.Input[str]) – The instance ID of the QoS.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.rocketmq.QosPolicy(resource_name, opts=None, description=None, dest_cidr=None, dest_port_range=None, end_time=None, ip_protocol=None, name=None, priority=None, qos_id=None, source_cidr=None, source_port_range=None, start_time=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Sag qos policy resource. You need to create a QoS policy to set priorities, rate limits, and quintuple rules for different messages.

For information about Sag Qos Policy and how to use it, see What is Qos Policy.

NOTE: Available in 1.60.0+
NOTE: Only the following regions support. [cn-shanghai, cn-shanghai-finance-1, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1]

import pulumi
import pulumi_alicloud as alicloud

default_qos = alicloud.rocketmq.Qos("defaultQos")
default_qos_policy = alicloud.rocketmq.QosPolicy("defaultQosPolicy",
    description="tf-testSagQosPolicyDescription",
    dest_cidr="10.10.0.0/24",
    dest_port_range="-1/-1",
    end_time="2019-10-26T16:41:33+0800",
    ip_protocol="ALL",
    priority="1",
    qos_id=default_qos.id,
    source_cidr="192.168.0.0/24",
    source_port_range="-1/-1",
    start_time="2019-10-25T16:41:33+0800")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description of the QoS policy.
dest_cidr (pulumi.Input[str]) – The destination CIDR block.
dest_port_range (pulumi.Input[str]) – The destination port range.
end_time (pulumi.Input[str]) – The expiration time of the quintuple rule.
ip_protocol (pulumi.Input[str]) – The transport layer protocol.
name (pulumi.Input[str]) – The name of the QoS policy.
priority (pulumi.Input[float]) – The priority of the quintuple rule. A smaller value indicates a higher priority. If the priorities of two quintuple rules are the same, the rule created earlier is applied first.Value range: 1 to 7.
qos_id (pulumi.Input[str]) – The instance ID of the QoS policy to which the quintuple rule is created.
source_cidr (pulumi.Input[str]) – The source CIDR block.
source_port_range (pulumi.Input[str]) – The source port range of the transport layer.
start_time (pulumi.Input[str]) – The time when the quintuple rule takes effect.

description: pulumi.Output[str] = None¶: The description of the QoS policy.

dest_cidr: pulumi.Output[str] = None¶: The destination CIDR block.

dest_port_range: pulumi.Output[str] = None¶: The destination port range.

end_time: pulumi.Output[str] = None¶: The expiration time of the quintuple rule.

ip_protocol: pulumi.Output[str] = None¶: The transport layer protocol.

name: pulumi.Output[str] = None¶: The name of the QoS policy.

priority: pulumi.Output[float] = None¶: The priority of the quintuple rule. A smaller value indicates a higher priority. If the priorities of two quintuple rules are the same, the rule created earlier is applied first.Value range: 1 to 7.

qos_id: pulumi.Output[str] = None¶: The instance ID of the QoS policy to which the quintuple rule is created.

source_cidr: pulumi.Output[str] = None¶: The source CIDR block.

source_port_range: pulumi.Output[str] = None¶: The source port range of the transport layer.

start_time: pulumi.Output[str] = None¶: The time when the quintuple rule takes effect.

static get(resource_name, id, opts=None, description=None, dest_cidr=None, dest_port_range=None, end_time=None, ip_protocol=None, name=None, priority=None, qos_id=None, source_cidr=None, source_port_range=None, start_time=None)¶

Get an existing QosPolicy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description of the QoS policy.
dest_cidr (pulumi.Input[str]) – The destination CIDR block.
dest_port_range (pulumi.Input[str]) – The destination port range.
end_time (pulumi.Input[str]) – The expiration time of the quintuple rule.
ip_protocol (pulumi.Input[str]) – The transport layer protocol.
name (pulumi.Input[str]) – The name of the QoS policy.
priority (pulumi.Input[float]) – The priority of the quintuple rule. A smaller value indicates a higher priority. If the priorities of two quintuple rules are the same, the rule created earlier is applied first.Value range: 1 to 7.
qos_id (pulumi.Input[str]) – The instance ID of the QoS policy to which the quintuple rule is created.
source_cidr (pulumi.Input[str]) – The source CIDR block.
source_port_range (pulumi.Input[str]) – The source port range of the transport layer.
start_time (pulumi.Input[str]) – The time when the quintuple rule takes effect.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.rocketmq.SnatEntry(resource_name, opts=None, cidr_block=None, sag_id=None, snat_ip=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Sag SnatEntry resource. This topic describes how to add a SNAT entry to enable the SNAT function. The SNAT function can hide internal IP addresses and resolve private IP address conflicts. With this function, on-premises sites can access internal IP addresses, but cannot be accessed by internal IP addresses. If you do not add a SNAT entry, on-premises sites can access each other only when all related IP addresses do not conflict.

For information about Sag SnatEntry and how to use it, see What is Sag SnatEntry.

NOTE: Available in 1.61.0+
NOTE: Only the following regions support. [cn-shanghai, cn-shanghai-finance-1, cn-hongkong, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-5, ap-northeast-1, eu-central-1]

import pulumi
import pulumi_alicloud as alicloud

default = alicloud.rocketmq.SnatEntry("default",
    cidr_block="192.168.7.0/24",
    sag_id="sag-3rb1t3iagy3w0zgwy9",
    snat_ip="192.0.0.2")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
cidr_block (pulumi.Input[str]) – The destination CIDR block.
sag_id (pulumi.Input[str]) – The ID of the SAG instance.
snat_ip (pulumi.Input[str]) – The public IP address.

cidr_block: pulumi.Output[str] = None¶: The destination CIDR block.

sag_id: pulumi.Output[str] = None¶: The ID of the SAG instance.

snat_ip: pulumi.Output[str] = None¶: The public IP address.

static get(resource_name, id, opts=None, cidr_block=None, sag_id=None, snat_ip=None)¶

Get an existing SnatEntry resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
cidr_block (pulumi.Input[str]) – The destination CIDR block.
sag_id (pulumi.Input[str]) – The ID of the SAG instance.
snat_ip (pulumi.Input[str]) – The public IP address.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.rocketmq.Topic(resource_name, opts=None, instance_id=None, message_type=None, perm=None, remark=None, topic=None, __props__=None, __name__=None, __opts__=None)¶

Provides an ONS topic resource.

For more information about how to use it, see RocketMQ Topic Management API.

NOTE: Available in 1.53.0+

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "onsInstanceName"
topic = config.get("topic")
if topic is None:
    topic = "onsTopicName"
default_instance = alicloud.rocketmq.Instance("defaultInstance", remark="default_ons_instance_remark")
default_topic = alicloud.rocketmq.Topic("defaultTopic",
    instance_id=default_instance.id,
    message_type=0,
    remark="dafault_ons_topic_remark",
    topic=topic)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
instance_id (pulumi.Input[str]) – ID of the ONS Instance that owns the topics.
message_type (pulumi.Input[float]) – The type of the message. Read Ons Topic Create for further details.
perm (pulumi.Input[float]) – This attribute is used to set the read-write mode for the topic. Read Request parameters for further details.
remark (pulumi.Input[str]) – This attribute is a concise description of topic. The length cannot exceed 128.
topic (pulumi.Input[str]) – Name of the topic. Two topics on a single instance cannot have the same name and the name cannot start with ‘GID’ or ‘CID’. The length cannot exceed 64 characters.

instance_id: pulumi.Output[str] = None¶: ID of the ONS Instance that owns the topics.

message_type: pulumi.Output[float] = None¶: The type of the message. Read Ons Topic Create for further details.

perm: pulumi.Output[float] = None¶: This attribute is used to set the read-write mode for the topic. Read Request parameters for further details.

remark: pulumi.Output[str] = None¶: This attribute is a concise description of topic. The length cannot exceed 128.

topic: pulumi.Output[str] = None¶: Name of the topic. Two topics on a single instance cannot have the same name and the name cannot start with ‘GID’ or ‘CID’. The length cannot exceed 64 characters.

static get(resource_name, id, opts=None, instance_id=None, message_type=None, perm=None, remark=None, topic=None)¶

Get an existing Topic resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
instance_id (pulumi.Input[str]) – ID of the ONS Instance that owns the topics.
message_type (pulumi.Input[float]) –
The type of the message. Read Ons Topic Create for further details.
perm (pulumi.Input[float]) –
This attribute is used to set the read-write mode for the topic. Read Request parameters for further details.
remark (pulumi.Input[str]) – This attribute is a concise description of topic. The length cannot exceed 128.
topic (pulumi.Input[str]) – Name of the topic. Two topics on a single instance cannot have the same name and the name cannot start with ‘GID’ or ‘CID’. The length cannot exceed 64 characters.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_alicloud.rocketmq.get_groups(group_id_regex=None, instance_id=None, output_file=None, opts=None)¶

This data source provides a list of ONS Groups in an Alibaba Cloud account according to the specified filters.

NOTE: Available in 1.53.0+

Parameters

group_id_regex (str) – A regex string to filter results by the group name.
instance_id (str) – ID of the ONS Instance that owns the groups.

pulumi_alicloud.rocketmq.get_instances(ids=None, name_regex=None, output_file=None, opts=None)¶

This data source provides a list of ONS Instances in an Alibaba Cloud account according to the specified filters.

NOTE: Available in 1.52.0+

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "onsInstanceDatasourceName"
default = alicloud.rocketmq.Instance("default", remark="default_ons_instance_remark")
instances_ds = pulumi.Output.all(default.id, default.name).apply(lambda id, name: alicloud.rocketmq.get_instances(ids=[id],
    name_regex=name,
    output_file="instances.txt"))
pulumi.export("firstInstanceId", instances_ds.instances[0]["instance_id"])

Parameters

ids (list) – A list of instance IDs to filter results.
name_regex (str) – A regex string to filter results by the instance name.

pulumi_alicloud.rocketmq.get_topics(instance_id=None, name_regex=None, output_file=None, opts=None)¶

This data source provides a list of ONS Topics in an Alibaba Cloud account according to the specified filters.

NOTE: Available in 1.53.0+

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "onsInstanceName"
topic = config.get("topic")
if topic is None:
    topic = "onsTopicDatasourceName"
default_instance = alicloud.rocketmq.Instance("defaultInstance", remark="default_ons_instance_remark")
default_topic = alicloud.rocketmq.Topic("defaultTopic",
    instance_id=default_instance.id,
    message_type=0,
    remark="dafault_ons_topic_remark",
    topic=topic)
topics_ds = default_topic.instance_id.apply(lambda instance_id: alicloud.rocketmq.get_topics(instance_id=instance_id,
    name_regex=topic,
    output_file="topics.txt"))
pulumi.export("firstTopicName", topics_ds.topics[0]["topic"])

Parameters

instance_id (str) – ID of the ONS Instance that owns the topics.
name_regex (str) – A regex string to filter results by the topic name.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

rocketmq¶

On This Page