Module rocketmq
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.
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-alicloudrepo; however, if that doesn’t turn up anything, please consult the sourceterraform-providers/terraform-provider-alicloudrepo.
Resources
Functions
Others
- AclArgs
- AclRuleArgs
- AclRuleState
- AclState
- ClientUserArgs
- ClientUserState
- DnatEntryArgs
- DnatEntryState
- GetGroupsArgs
- GetGroupsResult
- GetInstancesArgs
- GetInstancesResult
- GetTopicsArgs
- GetTopicsResult
- GroupArgs
- GroupState
- InstanceArgs
- InstanceState
- QosArgs
- QosCarArgs
- QosCarState
- QosPolicyArgs
- QosPolicyState
- QosState
- SnatEntryArgs
- SnatEntryState
- TopicArgs
- TopicState
Resources
Resource Acl
class Acl extends CustomResourceProvides 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]
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const defaultAcl = new alicloud.rocketmq.Acl("default", {});constructor
new Acl(name: string, args?: AclArgs, opts?: pulumi.CustomResourceOptions)Create a Acl resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AclState, opts?: pulumi.CustomResourceOptions): AclGet an existing Acl resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is AclReturns true if the given object is an instance of Acl. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property name
public name: pulumi.Output<string>;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://.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Resource AclRule
class AclRule extends CustomResourceProvides 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]
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const defaultAcl = new alicloud.rocketmq.Acl("default", {
sagCount: "0",
});
const defaultAclRule = new alicloud.rocketmq.AclRule("default", {
aclId: defaultAcl.id,
description: "tf-testSagAclRule",
destCidr: "192.168.1.0/24",
destPortRange: "-1/-1",
direction: "in",
ipProtocol: "ALL",
policy: "accept",
priority: 1,
sourceCidr: "10.10.1.0/24",
sourcePortRange: "-1/-1",
});constructor
new AclRule(name: string, args: AclRuleArgs, opts?: pulumi.CustomResourceOptions)Create a AclRule resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AclRuleState, opts?: pulumi.CustomResourceOptions): AclRuleGet an existing AclRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is AclRuleReturns true if the given object is an instance of AclRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property aclId
public aclId: pulumi.Output<string>;The ID of the ACL.
property description
public description: pulumi.Output<string | undefined>;The description of the ACL rule. It must be 1 to 512 characters in length.
property destCidr
public destCidr: pulumi.Output<string>;The destination address. It is an IPv4 address range in CIDR format. Default value: 0.0.0.0/0.
property destPortRange
public destPortRange: pulumi.Output<string>;The range of the destination port. Valid value: 80/80.
property direction
public direction: pulumi.Output<string>;The direction of the ACL rule. Valid values: in|out.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property ipProtocol
public ipProtocol: pulumi.Output<string>;The protocol used by the ACL rule. The value is not case sensitive.
property policy
public policy: pulumi.Output<string>;The policy used by the ACL rule. Valid values: accept|drop.
property priority
public priority: pulumi.Output<number | undefined>;The priority of the ACL rule. Value range: 1 to 100.
property sourceCidr
public sourceCidr: pulumi.Output<string>;The source address. It is an IPv4 address range in the CIDR format. Default value: 0.0.0.0/0.
property sourcePortRange
public sourcePortRange: pulumi.Output<string>;The range of the source port. Valid value: 80/80.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Resource ClientUser
class ClientUser extends CustomResourceProvides 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]
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const defaultClientUser = new alicloud.rocketmq.ClientUser("default", {
bandwidth: 20,
clientIp: "192.1.10.0",
password: "xxxxxxx",
sagId: "sag-xxxxx",
userMail: "tftest-xxxxx@test.com",
userName: "th-username-xxxxx",
});constructor
new ClientUser(name: string, args: ClientUserArgs, opts?: pulumi.CustomResourceOptions)Create a ClientUser resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClientUserState, opts?: pulumi.CustomResourceOptions): ClientUserGet an existing ClientUser resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is ClientUserReturns true if the given object is an instance of ClientUser. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property bandwidth
public bandwidth: pulumi.Output<number>;The SAG APP bandwidth that the user can use. Unit: Kbit/s. Maximum value: 2000 Kbit/s.
property clientIp
public clientIp: pulumi.Output<string | undefined>;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.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property kmsEncryptedPassword
public kmsEncryptedPassword: pulumi.Output<string | undefined>;property kmsEncryptionContext
public kmsEncryptionContext: pulumi.Output<{[key: string]: any} | undefined>;property password
public password: pulumi.Output<string>;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.
property sagId
public sagId: pulumi.Output<string>;The ID of the SAG instance created for the SAG APP.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
property userMail
public userMail: pulumi.Output<string>;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.
property userName
public userName: pulumi.Output<string>;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.
Resource DnatEntry
class DnatEntry extends CustomResourceProvides 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]
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const defaultDnatEntry = new alicloud.rocketmq.DnatEntry("default", {
externalIp: "1.0.0.2",
externalPort: "1",
internalIp: "10.0.0.2",
internalPort: "20",
ipProtocol: "tcp",
sagId: "sag-3rb1t3iagy3w0zgwy9",
type: "Intranet",
});constructor
new DnatEntry(name: string, args: DnatEntryArgs, opts?: pulumi.CustomResourceOptions)Create a DnatEntry resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DnatEntryState, opts?: pulumi.CustomResourceOptions): DnatEntryGet an existing DnatEntry resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is DnatEntryReturns true if the given object is an instance of DnatEntry. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property externalIp
public externalIp: pulumi.Output<string | undefined>;The external public IP address.when “type” is “Internet”,automatically identify the external ip.
property externalPort
public externalPort: pulumi.Output<string>;The public port.Value range: 1 to 65535 or “any”.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property internalIp
public internalIp: pulumi.Output<string>;The destination private IP address.
property internalPort
public internalPort: pulumi.Output<string>;The destination private port.Value range: 1 to 65535 or “any”.
property ipProtocol
public ipProtocol: pulumi.Output<string>;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.
property sagId
public sagId: pulumi.Output<string>;The ID of the SAG instance.
property type
public type: pulumi.Output<string>;The DNAT type. Valid values: Intranet: DNAT of private IP addresses. Internet: DNAT of public IP addresses
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Resource Group
class Group extends CustomResourceProvides an ONS group resource.
For more information about how to use it, see RocketMQ Group Management API.
NOTE: Available in 1.53.0+
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "onsInstanceName";
const groupId = config.get("groupId") || "GID-onsGroupDatasourceName";
const defaultInstance = new alicloud.rocketmq.Instance("default", {
remark: "defaultOnsInstanceRemark",
});
const defaultGroup = new alicloud.rocketmq.Group("default", {
groupId: groupId,
instanceId: defaultInstance.id,
remark: "dafaultOnsGroupRemark",
});constructor
new Group(name: string, args: GroupArgs, opts?: pulumi.CustomResourceOptions)Create a Group resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GroupState, opts?: pulumi.CustomResourceOptions): GroupGet an existing Group resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is GroupReturns true if the given object is an instance of Group. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property groupId
public groupId: pulumi.Output<string>;Name of the group. Two groups on a single instance cannot have the same name. A groupId starts with “GID” or “GID-”, and contains letters, numbers, hyphens (-), and underscores ().
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property instanceId
public instanceId: pulumi.Output<string>;ID of the ONS Instance that owns the groups.
property readEnable
public readEnable: pulumi.Output<boolean | undefined>;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.
property remark
public remark: pulumi.Output<string | undefined>;This attribute is a concise description of group. The length cannot exceed 256.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Resource Instance
class Instance extends CustomResourceProvides 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+
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const example = new alicloud.rocketmq.Instance("example", {
remark: "tf-example-ons-instance-remark",
});constructor
new Instance(name: string, args?: InstanceArgs, opts?: pulumi.CustomResourceOptions)Create a Instance resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceState, opts?: pulumi.CustomResourceOptions): InstanceGet an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is InstanceReturns true if the given object is an instance of Instance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property instanceStatus
public instanceStatus: pulumi.Output<number>;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.
property instanceType
public instanceType: pulumi.Output<number>;The edition of instance. 1 represents the postPaid edition, and 2 represents the platinum edition.
property name
public name: pulumi.Output<string>;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.
property releaseTime
public releaseTime: pulumi.Output<string>;Platinum edition instance expiration time.
property remark
public remark: pulumi.Output<string | undefined>;This attribute is a concise description of instance. The length cannot exceed 128.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Resource Qos
class Qos extends CustomResourceProvides 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]
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const defaultQos = new alicloud.rocketmq.Qos("default", {});constructor
new Qos(name: string, args?: QosArgs, opts?: pulumi.CustomResourceOptions)Create a Qos resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: QosState, opts?: pulumi.CustomResourceOptions): QosGet an existing Qos resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is QosReturns true if the given object is an instance of Qos. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property name
public name: pulumi.Output<string>;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://.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Resource QosCar
class QosCar extends CustomResourceProvides 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]
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const defaultQos = new alicloud.rocketmq.Qos("default", {});
const defaultQosCar = new alicloud.rocketmq.QosCar("default", {
description: "tf-testSagQosCarDescription",
limitType: "Absolute",
maxBandwidthAbs: 20,
maxBandwidthPercent: 20,
minBandwidthAbs: 10,
minBandwidthPercent: 10,
percentSourceType: "InternetUpBandwidth",
priority: 1,
qosId: defaultQos.id,
});constructor
new QosCar(name: string, args: QosCarArgs, opts?: pulumi.CustomResourceOptions)Create a QosCar resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: QosCarState, opts?: pulumi.CustomResourceOptions): QosCarGet an existing QosCar resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is QosCarReturns true if the given object is an instance of QosCar. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property description
public description: pulumi.Output<string | undefined>;The description of the QoS speed limiting rule.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property limitType
public limitType: pulumi.Output<string>;The speed limiting method. Valid values: Absolute, Percent.
property maxBandwidthAbs
public maxBandwidthAbs: pulumi.Output<number | undefined>;The maximum bandwidth allowed for the stream specified in the quintuple rule. This parameter is required when the value of the LimitType is Absolute.
property maxBandwidthPercent
public maxBandwidthPercent: pulumi.Output<number | undefined>;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.
property minBandwidthAbs
public minBandwidthAbs: pulumi.Output<number | undefined>;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.
property minBandwidthPercent
public minBandwidthPercent: pulumi.Output<number | undefined>;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.
property name
public name: pulumi.Output<string>;The name of the QoS speed limiting rule..
property percentSourceType
public percentSourceType: pulumi.Output<string | undefined>;The bandwidth type when the speed is limited based on percentage. Valid values: CcnBandwidth, InternetUpBandwidth.The default value is InternetUpBandwidth.
property priority
public priority: pulumi.Output<number>;The priority of the specified stream.
property qosId
public qosId: pulumi.Output<string>;The instance ID of the QoS.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Resource QosPolicy
class QosPolicy extends CustomResourceProvides 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]
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const defaultQos = new alicloud.rocketmq.Qos("default", {});
const defaultQosPolicy = new alicloud.rocketmq.QosPolicy("default", {
description: "tf-testSagQosPolicyDescription",
destCidr: "10.10.0.0/24",
destPortRange: "-1/-1",
endTime: "2019-10-26T16:41:33+0800",
ipProtocol: "ALL",
priority: 1,
qosId: defaultQos.id,
sourceCidr: "192.168.0.0/24",
sourcePortRange: "-1/-1",
startTime: "2019-10-25T16:41:33+0800",
});constructor
new QosPolicy(name: string, args: QosPolicyArgs, opts?: pulumi.CustomResourceOptions)Create a QosPolicy resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: QosPolicyState, opts?: pulumi.CustomResourceOptions): QosPolicyGet an existing QosPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is QosPolicyReturns true if the given object is an instance of QosPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property description
public description: pulumi.Output<string | undefined>;The description of the QoS policy.
property destCidr
public destCidr: pulumi.Output<string>;The destination CIDR block.
property destPortRange
public destPortRange: pulumi.Output<string>;The destination port range.
property endTime
public endTime: pulumi.Output<string | undefined>;The expiration time of the quintuple rule.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property ipProtocol
public ipProtocol: pulumi.Output<string>;The transport layer protocol.
property name
public name: pulumi.Output<string>;The name of the QoS policy.
property priority
public priority: pulumi.Output<number>;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.
property qosId
public qosId: pulumi.Output<string>;The instance ID of the QoS policy to which the quintuple rule is created.
property sourceCidr
public sourceCidr: pulumi.Output<string>;The source CIDR block.
property sourcePortRange
public sourcePortRange: pulumi.Output<string>;The source port range of the transport layer.
property startTime
public startTime: pulumi.Output<string | undefined>;The time when the quintuple rule takes effect.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Resource SnatEntry
class SnatEntry extends CustomResourceProvides 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]
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const defaultSnatEntry = new alicloud.rocketmq.SnatEntry("default", {
cidrBlock: "192.168.7.0/24",
sagId: "sag-3rb1t3iagy3w0zgwy9",
snatIp: "192.0.0.2",
});constructor
new SnatEntry(name: string, args: SnatEntryArgs, opts?: pulumi.CustomResourceOptions)Create a SnatEntry resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SnatEntryState, opts?: pulumi.CustomResourceOptions): SnatEntryGet an existing SnatEntry resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is SnatEntryReturns true if the given object is an instance of SnatEntry. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property cidrBlock
public cidrBlock: pulumi.Output<string>;The destination CIDR block.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property sagId
public sagId: pulumi.Output<string>;The ID of the SAG instance.
property snatIp
public snatIp: pulumi.Output<string>;The public IP address.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Resource Topic
class Topic extends CustomResourceProvides an ONS topic resource.
For more information about how to use it, see RocketMQ Topic Management API.
NOTE: Available in 1.53.0+
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "onsInstanceName";
const topic = config.get("topic") || "onsTopicName";
const defaultInstance = new alicloud.rocketmq.Instance("default", {
remark: "defaultOnsInstanceRemark",
});
const defaultTopic = new alicloud.rocketmq.Topic("default", {
instanceId: defaultInstance.id,
messageType: 0,
remark: "dafaultOnsTopicRemark",
topic: topic,
});constructor
new Topic(name: string, args: TopicArgs, opts?: pulumi.CustomResourceOptions)Create a Topic resource with the given unique name, arguments, and options.
nameThe unique name of the resource.argsThe arguments to use to populate this resource's properties.optsA bag of options that control this resource's behavior.
method get
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TopicState, opts?: pulumi.CustomResourceOptions): TopicGet an existing Topic resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
method getProvider
getProvider(moduleMember: string): ProviderResource | undefinedmethod isInstance
public static isInstance(obj: any): obj is TopicReturns true if the given object is an instance of Topic. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.
property id
id: Output<ID>;id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.
property instanceId
public instanceId: pulumi.Output<string>;ID of the ONS Instance that owns the topics.
property messageType
public messageType: pulumi.Output<number>;The type of the message. Read Ons Topic Create for further details.
property perm
public perm: pulumi.Output<number | undefined>;This attribute is used to set the read-write mode for the topic. Read Request parameters for further details.
property remark
public remark: pulumi.Output<string | undefined>;This attribute is a concise description of topic. The length cannot exceed 128.
property topic
public topic: pulumi.Output<string>;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.
property urn
urn: Output<URN>;urn is the stable logical URN used to distinctly address a resource, both before and after deployments.
Functions
Function getGroups
getGroups(args: GetGroupsArgs, opts?: pulumi.InvokeOptions): Promise<GetGroupsResult>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+
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "onsInstanceName";
const groupId = config.get("groupId") || "GID-onsGroupDatasourceName";
const defaultInstance = new alicloud.rocketmq.Instance("default", {
remark: "defaultOnsInstanceRemark",
});
const defaultGroup = new alicloud.rocketmq.Group("default", {
groupId: groupId,
instanceId: defaultInstance.id,
remark: "dafaultOnsGroupRemark",
});
const groupsDs = defaultGroup.instanceId.apply(instanceId => alicloud.rocketmq.getGroups({
groupIdRegex: groupId,
instanceId: instanceId,
outputFile: "groups.txt",
}, { async: true }));
export const firstGroupName = groupsDs.groups[0].groupId;Function getInstances
getInstances(args?: GetInstancesArgs, opts?: pulumi.InvokeOptions): Promise<GetInstancesResult>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+
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "onsInstanceDatasourceName";
const defaultInstance = new alicloud.rocketmq.Instance("default", {
remark: "defaultOnsInstanceRemark",
});
const instancesDs = pulumi.all([defaultInstance.id, defaultInstance.name]).apply(([id, name]) => alicloud.rocketmq.getInstances({
ids: [id],
nameRegex: name,
outputFile: "instances.txt",
}, { async: true }));
export const firstInstanceId = instancesDs.instances[0].instanceId;Function getTopics
getTopics(args: GetTopicsArgs, opts?: pulumi.InvokeOptions): Promise<GetTopicsResult>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+
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "onsInstanceName";
const topic = config.get("topic") || "onsTopicDatasourceName";
const defaultInstance = new alicloud.rocketmq.Instance("default", {
remark: "defaultOnsInstanceRemark",
});
const defaultTopic = new alicloud.rocketmq.Topic("default", {
instanceId: defaultInstance.id,
messageType: 0,
remark: "dafaultOnsTopicRemark",
topic: topic,
});
const topicsDs = defaultTopic.instanceId.apply(instanceId => alicloud.rocketmq.getTopics({
instanceId: instanceId,
nameRegex: topic,
outputFile: "topics.txt",
}, { async: true }));
export const firstTopicName = topicsDs.topics[0].topic;Others
interface AclArgs
interface AclArgsThe set of arguments for constructing a Acl resource.
property name
name?: pulumi.Input<string>;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://.
interface AclRuleArgs
interface AclRuleArgsThe set of arguments for constructing a AclRule resource.
property aclId
aclId: pulumi.Input<string>;The ID of the ACL.
property description
description?: pulumi.Input<string>;The description of the ACL rule. It must be 1 to 512 characters in length.
property destCidr
destCidr: pulumi.Input<string>;The destination address. It is an IPv4 address range in CIDR format. Default value: 0.0.0.0/0.
property destPortRange
destPortRange: pulumi.Input<string>;The range of the destination port. Valid value: 80/80.
property direction
direction: pulumi.Input<string>;The direction of the ACL rule. Valid values: in|out.
property ipProtocol
ipProtocol: pulumi.Input<string>;The protocol used by the ACL rule. The value is not case sensitive.
property policy
policy: pulumi.Input<string>;The policy used by the ACL rule. Valid values: accept|drop.
property priority
priority?: pulumi.Input<number>;The priority of the ACL rule. Value range: 1 to 100.
property sourceCidr
sourceCidr: pulumi.Input<string>;The source address. It is an IPv4 address range in the CIDR format. Default value: 0.0.0.0/0.
property sourcePortRange
sourcePortRange: pulumi.Input<string>;The range of the source port. Valid value: 80/80.
interface AclRuleState
interface AclRuleStateInput properties used for looking up and filtering AclRule resources.
property aclId
aclId?: pulumi.Input<string>;The ID of the ACL.
property description
description?: pulumi.Input<string>;The description of the ACL rule. It must be 1 to 512 characters in length.
property destCidr
destCidr?: pulumi.Input<string>;The destination address. It is an IPv4 address range in CIDR format. Default value: 0.0.0.0/0.
property destPortRange
destPortRange?: pulumi.Input<string>;The range of the destination port. Valid value: 80/80.
property direction
direction?: pulumi.Input<string>;The direction of the ACL rule. Valid values: in|out.
property ipProtocol
ipProtocol?: pulumi.Input<string>;The protocol used by the ACL rule. The value is not case sensitive.
property policy
policy?: pulumi.Input<string>;The policy used by the ACL rule. Valid values: accept|drop.
property priority
priority?: pulumi.Input<number>;The priority of the ACL rule. Value range: 1 to 100.
property sourceCidr
sourceCidr?: pulumi.Input<string>;The source address. It is an IPv4 address range in the CIDR format. Default value: 0.0.0.0/0.
property sourcePortRange
sourcePortRange?: pulumi.Input<string>;The range of the source port. Valid value: 80/80.
interface AclState
interface AclStateInput properties used for looking up and filtering Acl resources.
property name
name?: pulumi.Input<string>;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://.
interface ClientUserArgs
interface ClientUserArgsThe set of arguments for constructing a ClientUser resource.
property bandwidth
bandwidth: pulumi.Input<number>;The SAG APP bandwidth that the user can use. Unit: Kbit/s. Maximum value: 2000 Kbit/s.
property clientIp
clientIp?: pulumi.Input<string>;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.
property kmsEncryptedPassword
kmsEncryptedPassword?: pulumi.Input<string>;property kmsEncryptionContext
kmsEncryptionContext?: pulumi.Input<{[key: string]: any}>;property password
password?: pulumi.Input<string>;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.
property sagId
sagId: pulumi.Input<string>;The ID of the SAG instance created for the SAG APP.
property userMail
userMail: pulumi.Input<string>;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.
property userName
userName?: pulumi.Input<string>;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.
interface ClientUserState
interface ClientUserStateInput properties used for looking up and filtering ClientUser resources.
property bandwidth
bandwidth?: pulumi.Input<number>;The SAG APP bandwidth that the user can use. Unit: Kbit/s. Maximum value: 2000 Kbit/s.
property clientIp
clientIp?: pulumi.Input<string>;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.
property kmsEncryptedPassword
kmsEncryptedPassword?: pulumi.Input<string>;property kmsEncryptionContext
kmsEncryptionContext?: pulumi.Input<{[key: string]: any}>;property password
password?: pulumi.Input<string>;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.
property sagId
sagId?: pulumi.Input<string>;The ID of the SAG instance created for the SAG APP.
property userMail
userMail?: pulumi.Input<string>;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.
property userName
userName?: pulumi.Input<string>;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.
interface DnatEntryArgs
interface DnatEntryArgsThe set of arguments for constructing a DnatEntry resource.
property externalIp
externalIp?: pulumi.Input<string>;The external public IP address.when “type” is “Internet”,automatically identify the external ip.
property externalPort
externalPort: pulumi.Input<string>;The public port.Value range: 1 to 65535 or “any”.
property internalIp
internalIp: pulumi.Input<string>;The destination private IP address.
property internalPort
internalPort: pulumi.Input<string>;The destination private port.Value range: 1 to 65535 or “any”.
property ipProtocol
ipProtocol: pulumi.Input<string>;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.
property sagId
sagId: pulumi.Input<string>;The ID of the SAG instance.
property type
type: pulumi.Input<string>;The DNAT type. Valid values: Intranet: DNAT of private IP addresses. Internet: DNAT of public IP addresses
interface DnatEntryState
interface DnatEntryStateInput properties used for looking up and filtering DnatEntry resources.
property externalIp
externalIp?: pulumi.Input<string>;The external public IP address.when “type” is “Internet”,automatically identify the external ip.
property externalPort
externalPort?: pulumi.Input<string>;The public port.Value range: 1 to 65535 or “any”.
property internalIp
internalIp?: pulumi.Input<string>;The destination private IP address.
property internalPort
internalPort?: pulumi.Input<string>;The destination private port.Value range: 1 to 65535 or “any”.
property ipProtocol
ipProtocol?: pulumi.Input<string>;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.
property sagId
sagId?: pulumi.Input<string>;The ID of the SAG instance.
property type
type?: pulumi.Input<string>;The DNAT type. Valid values: Intranet: DNAT of private IP addresses. Internet: DNAT of public IP addresses
interface GetGroupsArgs
interface GetGroupsArgsA collection of arguments for invoking getGroups.
property groupIdRegex
groupIdRegex?: undefined | string;A regex string to filter results by the group name.
property instanceId
instanceId: string;ID of the ONS Instance that owns the groups.
property outputFile
outputFile?: undefined | string;interface GetGroupsResult
interface GetGroupsResultA collection of values returned by getGroups.
property groupIdRegex
groupIdRegex?: undefined | string;property groups
groups: GetGroupsGroup[];A list of groups. Each element contains the following attributes:
property id
id: string;The provider-assigned unique ID for this managed resource.
property ids
ids: string[];A list of group names.
property instanceId
instanceId: string;property outputFile
outputFile?: undefined | string;interface GetInstancesArgs
interface GetInstancesArgsA collection of arguments for invoking getInstances.
property ids
ids?: string[];A list of instance IDs to filter results.
property nameRegex
nameRegex?: undefined | string;A regex string to filter results by the instance name.
property outputFile
outputFile?: undefined | string;interface GetInstancesResult
interface GetInstancesResultA collection of values returned by getInstances.
property id
id: string;The provider-assigned unique ID for this managed resource.
property ids
ids: string[];A list of instance IDs.
property instances
instances: GetInstancesInstance[];A list of instances. Each element contains the following attributes:
property nameRegex
nameRegex?: undefined | string;property names
names: string[];A list of instance names.
property outputFile
outputFile?: undefined | string;interface GetTopicsArgs
interface GetTopicsArgsA collection of arguments for invoking getTopics.
property instanceId
instanceId: string;ID of the ONS Instance that owns the topics.
property nameRegex
nameRegex?: undefined | string;A regex string to filter results by the topic name.
property outputFile
outputFile?: undefined | string;interface GetTopicsResult
interface GetTopicsResultA collection of values returned by getTopics.
property id
id: string;The provider-assigned unique ID for this managed resource.
property instanceId
instanceId: string;property nameRegex
nameRegex?: undefined | string;property names
names: string[];A list of topic names.
property outputFile
outputFile?: undefined | string;property topics
topics: GetTopicsTopic[];A list of topics. Each element contains the following attributes:
interface GroupArgs
interface GroupArgsThe set of arguments for constructing a Group resource.
property groupId
groupId: pulumi.Input<string>;Name of the group. Two groups on a single instance cannot have the same name. A groupId starts with “GID” or “GID-”, and contains letters, numbers, hyphens (-), and underscores ().
property instanceId
instanceId: pulumi.Input<string>;ID of the ONS Instance that owns the groups.
property readEnable
readEnable?: pulumi.Input<boolean>;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.
property remark
remark?: pulumi.Input<string>;This attribute is a concise description of group. The length cannot exceed 256.
interface GroupState
interface GroupStateInput properties used for looking up and filtering Group resources.
property groupId
groupId?: pulumi.Input<string>;Name of the group. Two groups on a single instance cannot have the same name. A groupId starts with “GID” or “GID-”, and contains letters, numbers, hyphens (-), and underscores ().
property instanceId
instanceId?: pulumi.Input<string>;ID of the ONS Instance that owns the groups.
property readEnable
readEnable?: pulumi.Input<boolean>;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.
property remark
remark?: pulumi.Input<string>;This attribute is a concise description of group. The length cannot exceed 256.
interface InstanceArgs
interface InstanceArgsThe set of arguments for constructing a Instance resource.
property name
name?: pulumi.Input<string>;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.
property remark
remark?: pulumi.Input<string>;This attribute is a concise description of instance. The length cannot exceed 128.
interface InstanceState
interface InstanceStateInput properties used for looking up and filtering Instance resources.
property instanceStatus
instanceStatus?: pulumi.Input<number>;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.
property instanceType
instanceType?: pulumi.Input<number>;The edition of instance. 1 represents the postPaid edition, and 2 represents the platinum edition.
property name
name?: pulumi.Input<string>;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.
property releaseTime
releaseTime?: pulumi.Input<string>;Platinum edition instance expiration time.
property remark
remark?: pulumi.Input<string>;This attribute is a concise description of instance. The length cannot exceed 128.
interface QosArgs
interface QosArgsThe set of arguments for constructing a Qos resource.
property name
name?: pulumi.Input<string>;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://.
interface QosCarArgs
interface QosCarArgsThe set of arguments for constructing a QosCar resource.
property description
description?: pulumi.Input<string>;The description of the QoS speed limiting rule.
property limitType
limitType: pulumi.Input<string>;The speed limiting method. Valid values: Absolute, Percent.
property maxBandwidthAbs
maxBandwidthAbs?: pulumi.Input<number>;The maximum bandwidth allowed for the stream specified in the quintuple rule. This parameter is required when the value of the LimitType is Absolute.
property maxBandwidthPercent
maxBandwidthPercent?: pulumi.Input<number>;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.
property minBandwidthAbs
minBandwidthAbs?: pulumi.Input<number>;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.
property minBandwidthPercent
minBandwidthPercent?: pulumi.Input<number>;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.
property name
name?: pulumi.Input<string>;The name of the QoS speed limiting rule..
property percentSourceType
percentSourceType?: pulumi.Input<string>;The bandwidth type when the speed is limited based on percentage. Valid values: CcnBandwidth, InternetUpBandwidth.The default value is InternetUpBandwidth.
property priority
priority: pulumi.Input<number>;The priority of the specified stream.
property qosId
qosId: pulumi.Input<string>;The instance ID of the QoS.
interface QosCarState
interface QosCarStateInput properties used for looking up and filtering QosCar resources.
property description
description?: pulumi.Input<string>;The description of the QoS speed limiting rule.
property limitType
limitType?: pulumi.Input<string>;The speed limiting method. Valid values: Absolute, Percent.
property maxBandwidthAbs
maxBandwidthAbs?: pulumi.Input<number>;The maximum bandwidth allowed for the stream specified in the quintuple rule. This parameter is required when the value of the LimitType is Absolute.
property maxBandwidthPercent
maxBandwidthPercent?: pulumi.Input<number>;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.
property minBandwidthAbs
minBandwidthAbs?: pulumi.Input<number>;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.
property minBandwidthPercent
minBandwidthPercent?: pulumi.Input<number>;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.
property name
name?: pulumi.Input<string>;The name of the QoS speed limiting rule..
property percentSourceType
percentSourceType?: pulumi.Input<string>;The bandwidth type when the speed is limited based on percentage. Valid values: CcnBandwidth, InternetUpBandwidth.The default value is InternetUpBandwidth.
property priority
priority?: pulumi.Input<number>;The priority of the specified stream.
property qosId
qosId?: pulumi.Input<string>;The instance ID of the QoS.
interface QosPolicyArgs
interface QosPolicyArgsThe set of arguments for constructing a QosPolicy resource.
property description
description?: pulumi.Input<string>;The description of the QoS policy.
property destCidr
destCidr: pulumi.Input<string>;The destination CIDR block.
property destPortRange
destPortRange: pulumi.Input<string>;The destination port range.
property endTime
endTime?: pulumi.Input<string>;The expiration time of the quintuple rule.
property ipProtocol
ipProtocol: pulumi.Input<string>;The transport layer protocol.
property name
name?: pulumi.Input<string>;The name of the QoS policy.
property priority
priority: pulumi.Input<number>;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.
property qosId
qosId: pulumi.Input<string>;The instance ID of the QoS policy to which the quintuple rule is created.
property sourceCidr
sourceCidr: pulumi.Input<string>;The source CIDR block.
property sourcePortRange
sourcePortRange: pulumi.Input<string>;The source port range of the transport layer.
property startTime
startTime?: pulumi.Input<string>;The time when the quintuple rule takes effect.
interface QosPolicyState
interface QosPolicyStateInput properties used for looking up and filtering QosPolicy resources.
property description
description?: pulumi.Input<string>;The description of the QoS policy.
property destCidr
destCidr?: pulumi.Input<string>;The destination CIDR block.
property destPortRange
destPortRange?: pulumi.Input<string>;The destination port range.
property endTime
endTime?: pulumi.Input<string>;The expiration time of the quintuple rule.
property ipProtocol
ipProtocol?: pulumi.Input<string>;The transport layer protocol.
property name
name?: pulumi.Input<string>;The name of the QoS policy.
property priority
priority?: pulumi.Input<number>;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.
property qosId
qosId?: pulumi.Input<string>;The instance ID of the QoS policy to which the quintuple rule is created.
property sourceCidr
sourceCidr?: pulumi.Input<string>;The source CIDR block.
property sourcePortRange
sourcePortRange?: pulumi.Input<string>;The source port range of the transport layer.
property startTime
startTime?: pulumi.Input<string>;The time when the quintuple rule takes effect.
interface QosState
interface QosStateInput properties used for looking up and filtering Qos resources.
property name
name?: pulumi.Input<string>;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://.
interface SnatEntryArgs
interface SnatEntryArgsThe set of arguments for constructing a SnatEntry resource.
property cidrBlock
cidrBlock: pulumi.Input<string>;The destination CIDR block.
property sagId
sagId: pulumi.Input<string>;The ID of the SAG instance.
property snatIp
snatIp: pulumi.Input<string>;The public IP address.
interface SnatEntryState
interface SnatEntryStateInput properties used for looking up and filtering SnatEntry resources.
property cidrBlock
cidrBlock?: pulumi.Input<string>;The destination CIDR block.
property sagId
sagId?: pulumi.Input<string>;The ID of the SAG instance.
property snatIp
snatIp?: pulumi.Input<string>;The public IP address.
interface TopicArgs
interface TopicArgsThe set of arguments for constructing a Topic resource.
property instanceId
instanceId: pulumi.Input<string>;ID of the ONS Instance that owns the topics.
property messageType
messageType: pulumi.Input<number>;The type of the message. Read Ons Topic Create for further details.
property perm
perm?: pulumi.Input<number>;This attribute is used to set the read-write mode for the topic. Read Request parameters for further details.
property remark
remark?: pulumi.Input<string>;This attribute is a concise description of topic. The length cannot exceed 128.
property topic
topic: pulumi.Input<string>;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.
interface TopicState
interface TopicStateInput properties used for looking up and filtering Topic resources.
property instanceId
instanceId?: pulumi.Input<string>;ID of the ONS Instance that owns the topics.
property messageType
messageType?: pulumi.Input<number>;The type of the message. Read Ons Topic Create for further details.
property perm
perm?: pulumi.Input<number>;This attribute is used to set the read-write mode for the topic. Read Request parameters for further details.
property remark
remark?: pulumi.Input<string>;This attribute is a concise description of topic. The length cannot exceed 128.
property topic
topic?: pulumi.Input<string>;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.