Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. sag
  5. QosPolicy
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.sag.QosPolicy

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

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 since v1.60.0.

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

Create QosPolicy Resource

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

Constructor syntax

new QosPolicy(name: string, args: QosPolicyArgs, opts?: CustomResourceOptions);
@overload
def QosPolicy(resource_name: str,
              args: QosPolicyArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def QosPolicy(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              dest_cidr: Optional[str] = None,
              dest_port_range: Optional[str] = None,
              ip_protocol: Optional[str] = None,
              priority: Optional[int] = None,
              qos_id: Optional[str] = None,
              source_cidr: Optional[str] = None,
              source_port_range: Optional[str] = None,
              description: Optional[str] = None,
              end_time: Optional[str] = None,
              name: Optional[str] = None,
              start_time: Optional[str] = None)
func NewQosPolicy(ctx *Context, name string, args QosPolicyArgs, opts ...ResourceOption) (*QosPolicy, error)
public QosPolicy(string name, QosPolicyArgs args, CustomResourceOptions? opts = null)
public QosPolicy(String name, QosPolicyArgs args)
public QosPolicy(String name, QosPolicyArgs args, CustomResourceOptions options)

type: alicloud:sag:QosPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. QosPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. QosPolicyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. QosPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. QosPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. QosPolicyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var qosPolicyResource = new AliCloud.Sag.QosPolicy("qosPolicyResource", new()
{
    DestCidr = "string",
    DestPortRange = "string",
    IpProtocol = "string",
    Priority = 0,
    QosId = "string",
    SourceCidr = "string",
    SourcePortRange = "string",
    Description = "string",
    EndTime = "string",
    Name = "string",
    StartTime = "string",
});
Copy
example, err := sag.NewQosPolicy(ctx, "qosPolicyResource", &sag.QosPolicyArgs{
	DestCidr:        pulumi.String("string"),
	DestPortRange:   pulumi.String("string"),
	IpProtocol:      pulumi.String("string"),
	Priority:        pulumi.Int(0),
	QosId:           pulumi.String("string"),
	SourceCidr:      pulumi.String("string"),
	SourcePortRange: pulumi.String("string"),
	Description:     pulumi.String("string"),
	EndTime:         pulumi.String("string"),
	Name:            pulumi.String("string"),
	StartTime:       pulumi.String("string"),
})
Copy
var qosPolicyResource = new QosPolicy("qosPolicyResource", QosPolicyArgs.builder()
    .destCidr("string")
    .destPortRange("string")
    .ipProtocol("string")
    .priority(0)
    .qosId("string")
    .sourceCidr("string")
    .sourcePortRange("string")
    .description("string")
    .endTime("string")
    .name("string")
    .startTime("string")
    .build());
Copy
qos_policy_resource = alicloud.sag.QosPolicy("qosPolicyResource",
    dest_cidr="string",
    dest_port_range="string",
    ip_protocol="string",
    priority=0,
    qos_id="string",
    source_cidr="string",
    source_port_range="string",
    description="string",
    end_time="string",
    name="string",
    start_time="string")
Copy
const qosPolicyResource = new alicloud.sag.QosPolicy("qosPolicyResource", {
    destCidr: "string",
    destPortRange: "string",
    ipProtocol: "string",
    priority: 0,
    qosId: "string",
    sourceCidr: "string",
    sourcePortRange: "string",
    description: "string",
    endTime: "string",
    name: "string",
    startTime: "string",
});
Copy
type: alicloud:sag:QosPolicy
properties:
    description: string
    destCidr: string
    destPortRange: string
    endTime: string
    ipProtocol: string
    name: string
    priority: 0
    qosId: string
    sourceCidr: string
    sourcePortRange: string
    startTime: string
Copy

QosPolicy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The QosPolicy resource accepts the following input properties:

DestCidr This property is required. string
The destination CIDR block.
DestPortRange This property is required. string
The destination port range.
IpProtocol This property is required. string
The transport layer protocol.
Priority This property is required. int
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.
QosId This property is required. string
The instance ID of the QoS policy to which the quintuple rule is created.
SourceCidr This property is required. string
The source CIDR block.
SourcePortRange This property is required. string
The source port range of the transport layer.
Description string
The description of the QoS policy.
EndTime string
The expiration time of the quintuple rule.
Name string
The name of the QoS policy.
StartTime string
The time when the quintuple rule takes effect.
DestCidr This property is required. string
The destination CIDR block.
DestPortRange This property is required. string
The destination port range.
IpProtocol This property is required. string
The transport layer protocol.
Priority This property is required. int
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.
QosId This property is required. string
The instance ID of the QoS policy to which the quintuple rule is created.
SourceCidr This property is required. string
The source CIDR block.
SourcePortRange This property is required. string
The source port range of the transport layer.
Description string
The description of the QoS policy.
EndTime string
The expiration time of the quintuple rule.
Name string
The name of the QoS policy.
StartTime string
The time when the quintuple rule takes effect.
destCidr This property is required. String
The destination CIDR block.
destPortRange This property is required. String
The destination port range.
ipProtocol This property is required. String
The transport layer protocol.
priority This property is required. Integer
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.
qosId This property is required. String
The instance ID of the QoS policy to which the quintuple rule is created.
sourceCidr This property is required. String
The source CIDR block.
sourcePortRange This property is required. String
The source port range of the transport layer.
description String
The description of the QoS policy.
endTime String
The expiration time of the quintuple rule.
name String
The name of the QoS policy.
startTime String
The time when the quintuple rule takes effect.
destCidr This property is required. string
The destination CIDR block.
destPortRange This property is required. string
The destination port range.
ipProtocol This property is required. string
The transport layer protocol.
priority This property is required. 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.
qosId This property is required. string
The instance ID of the QoS policy to which the quintuple rule is created.
sourceCidr This property is required. string
The source CIDR block.
sourcePortRange This property is required. string
The source port range of the transport layer.
description string
The description of the QoS policy.
endTime string
The expiration time of the quintuple rule.
name string
The name of the QoS policy.
startTime string
The time when the quintuple rule takes effect.
dest_cidr This property is required. str
The destination CIDR block.
dest_port_range This property is required. str
The destination port range.
ip_protocol This property is required. str
The transport layer protocol.
priority This property is required. int
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 This property is required. str
The instance ID of the QoS policy to which the quintuple rule is created.
source_cidr This property is required. str
The source CIDR block.
source_port_range This property is required. str
The source port range of the transport layer.
description str
The description of the QoS policy.
end_time str
The expiration time of the quintuple rule.
name str
The name of the QoS policy.
start_time str
The time when the quintuple rule takes effect.
destCidr This property is required. String
The destination CIDR block.
destPortRange This property is required. String
The destination port range.
ipProtocol This property is required. String
The transport layer protocol.
priority This property is required. 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.
qosId This property is required. String
The instance ID of the QoS policy to which the quintuple rule is created.
sourceCidr This property is required. String
The source CIDR block.
sourcePortRange This property is required. String
The source port range of the transport layer.
description String
The description of the QoS policy.
endTime String
The expiration time of the quintuple rule.
name String
The name of the QoS policy.
startTime String
The time when the quintuple rule takes effect.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing QosPolicy Resource

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

public static get(name: string, id: Input<ID>, state?: QosPolicyState, opts?: CustomResourceOptions): QosPolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        dest_cidr: Optional[str] = None,
        dest_port_range: Optional[str] = None,
        end_time: Optional[str] = None,
        ip_protocol: Optional[str] = None,
        name: Optional[str] = None,
        priority: Optional[int] = None,
        qos_id: Optional[str] = None,
        source_cidr: Optional[str] = None,
        source_port_range: Optional[str] = None,
        start_time: Optional[str] = None) -> QosPolicy
func GetQosPolicy(ctx *Context, name string, id IDInput, state *QosPolicyState, opts ...ResourceOption) (*QosPolicy, error)
public static QosPolicy Get(string name, Input<string> id, QosPolicyState? state, CustomResourceOptions? opts = null)
public static QosPolicy get(String name, Output<String> id, QosPolicyState state, CustomResourceOptions options)
resources:  _:    type: alicloud:sag:QosPolicy    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Description string
The description of the QoS policy.
DestCidr string
The destination CIDR block.
DestPortRange string
The destination port range.
EndTime string
The expiration time of the quintuple rule.
IpProtocol string
The transport layer protocol.
Name string
The name of the QoS policy.
Priority int
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.
QosId string
The instance ID of the QoS policy to which the quintuple rule is created.
SourceCidr string
The source CIDR block.
SourcePortRange string
The source port range of the transport layer.
StartTime string
The time when the quintuple rule takes effect.
Description string
The description of the QoS policy.
DestCidr string
The destination CIDR block.
DestPortRange string
The destination port range.
EndTime string
The expiration time of the quintuple rule.
IpProtocol string
The transport layer protocol.
Name string
The name of the QoS policy.
Priority int
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.
QosId string
The instance ID of the QoS policy to which the quintuple rule is created.
SourceCidr string
The source CIDR block.
SourcePortRange string
The source port range of the transport layer.
StartTime string
The time when the quintuple rule takes effect.
description String
The description of the QoS policy.
destCidr String
The destination CIDR block.
destPortRange String
The destination port range.
endTime String
The expiration time of the quintuple rule.
ipProtocol String
The transport layer protocol.
name String
The name of the QoS policy.
priority Integer
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.
qosId String
The instance ID of the QoS policy to which the quintuple rule is created.
sourceCidr String
The source CIDR block.
sourcePortRange String
The source port range of the transport layer.
startTime String
The time when the quintuple rule takes effect.
description string
The description of the QoS policy.
destCidr string
The destination CIDR block.
destPortRange string
The destination port range.
endTime string
The expiration time of the quintuple rule.
ipProtocol string
The transport layer protocol.
name string
The name of the QoS policy.
priority 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.
qosId string
The instance ID of the QoS policy to which the quintuple rule is created.
sourceCidr string
The source CIDR block.
sourcePortRange string
The source port range of the transport layer.
startTime string
The time when the quintuple rule takes effect.
description str
The description of the QoS policy.
dest_cidr str
The destination CIDR block.
dest_port_range str
The destination port range.
end_time str
The expiration time of the quintuple rule.
ip_protocol str
The transport layer protocol.
name str
The name of the QoS policy.
priority int
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 str
The instance ID of the QoS policy to which the quintuple rule is created.
source_cidr str
The source CIDR block.
source_port_range str
The source port range of the transport layer.
start_time str
The time when the quintuple rule takes effect.
description String
The description of the QoS policy.
destCidr String
The destination CIDR block.
destPortRange String
The destination port range.
endTime String
The expiration time of the quintuple rule.
ipProtocol String
The transport layer protocol.
name String
The name of the QoS policy.
priority 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.
qosId String
The instance ID of the QoS policy to which the quintuple rule is created.
sourceCidr String
The source CIDR block.
sourcePortRange String
The source port range of the transport layer.
startTime String
The time when the quintuple rule takes effect.

Import

The Sag Qos Policy can be imported using the id, e.g.

$ pulumi import alicloud:sag/qosPolicy:QosPolicy example qos-abc123456:qospy-abc123456
Copy

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

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud