Skip to content

TrafficQosRule

This class encapsulates and extends the ROS resource type ALIYUN::VPC::TrafficQosRule.

Initializers

import ros_cdk_vpc
ros_cdk_vpc.TrafficQosRule(
  scope: Construct,
  id: str,
  priority: typing.Union[typing.Union[int, float], IResolvable],
  protocol: typing.Union[str, IResolvable],
  qos_id: typing.Union[str, IResolvable],
  queue_id: typing.Union[str, IResolvable],
  dst_cidr: typing.Union[str, IResolvable] = None,
  dst_ipv6_cidr: typing.Union[str, IResolvable] = None,
  dst_port_range: typing.Union[str, IResolvable] = None,
  match_dscp: typing.Union[typing.Union[int, float], IResolvable] = None,
  remarking_dscp: typing.Union[typing.Union[int, float], IResolvable] = None,
  rule_description: typing.Union[str, IResolvable] = None,
  rule_name: typing.Union[str, IResolvable] = None,
  src_cidr: typing.Union[str, IResolvable] = None,
  src_ipv6_cidr: typing.Union[str, IResolvable] = None,
  src_port_range: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
priority typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property priority: The priority of the QoS rule.
protocol typing.Union[str, ros_cdk_core.IResolvable] Property protocol: QoS rule protocol type, value: - ALL - ICMP(IPv4) - ICMPv6(IPv6)* * - TCP - UDP - GRE - SSH - Telnet - HTTP - HTTPS - MS SQL - Oracle - MySql - RDP - PostgreSQL - Redis**.
qos_id typing.Union[str, ros_cdk_core.IResolvable] Property qosId: The QoS policy ID.
queue_id typing.Union[str, ros_cdk_core.IResolvable] Property queueId: The QoS queue ID.
dst_cidr typing.Union[str, ros_cdk_core.IResolvable] Property dstCidr: The destination IPv4 CIDR block that matches the QoS rule traffic.
dst_ipv6_cidr typing.Union[str, ros_cdk_core.IResolvable] Property dstIpv6Cidr: The QoS rule traffic matches the Destination IPv6 network segment.
dst_port_range typing.Union[str, ros_cdk_core.IResolvable] Property dstPortRange: QoS rule traffic matches the destination port number range.
match_dscp typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property matchDscp: The DSCP value that matches the QoS rule traffic.
remarking_dscp typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property remarkingDscp: The new DSCP value.
rule_description typing.Union[str, ros_cdk_core.IResolvable] Property ruleDescription: The description of the QoS rule.
rule_name typing.Union[str, ros_cdk_core.IResolvable] Property ruleName: The name of the QoS rule.
src_cidr typing.Union[str, ros_cdk_core.IResolvable] Property srcCidr: The source IPv4 CIDR block that matches the QoS rule traffic.
src_ipv6_cidr typing.Union[str, ros_cdk_core.IResolvable] Property srcIpv6Cidr: The QoS rule traffic matches the source IPv6 network segment.
src_port_range typing.Union[str, ros_cdk_core.IResolvable] Property srcPortRange: The source port number of the QoS rule traffic matching.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

priorityRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property priority: The priority of the QoS rule.

Valid values: 1 to 9000. A larger value indicates a higher priority. The priority of each QoS rule must be unique in the same QoS policy.


protocolRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property protocol: QoS rule protocol type, value: - ALL - ICMP(IPv4) - ICMPv6(IPv6)* * - TCP - UDP - GRE - SSH - Telnet - HTTP - HTTPS - MS SQL - Oracle - MySql - RDP - PostgreSQL - Redis**.


qos_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property qosId: The QoS policy ID.


queue_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property queueId: The QoS queue ID.


dst_cidrOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dstCidr: The destination IPv4 CIDR block that matches the QoS rule traffic.

If this parameter is not supported, enter SrcIPv6Cidr or *DstIPv6Cidr * .


dst_ipv6_cidrOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dstIpv6Cidr: The QoS rule traffic matches the Destination IPv6 network segment.

If this parameter is not supported, enter SrcCidr or *DstCidr * .


dst_port_rangeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dstPortRange: QoS rule traffic matches the destination port number range.

Value range: 0 to 65535. If not, the value is -1. Currently, only a single port number is supported, and the start and end of the port number must be the same. The corresponding destination port number range is fixed for different protocol types. The values are as follows:

  • ALL:-1/-1, not editable.
  • ICMP(IPv4):-1/-1, non-editable.
  • ICMPv6(IPv6):-1/-1, non-editable.
  • TCP:-1/-1, editable.
  • UDP:-1/-1, editable.
  • GRE:-1/-1, not editable.
  • SSH:22/22, not editable.
  • Telnet:23/23, not editable.
  • HTTP:80/80, non-editable.
  • HTTPS:443/443, which cannot be edited.
  • MS SQL:1443/1443, which cannot be edited.
  • Oracle:1521/1521, non-editable.
  • MySql:3306/3306, non-editable.
  • RDP:3389/3389, non-editable.
  • PostgreSQL:5432/5432, non-editable.
  • Redis:6379/6379, non-editable.

match_dscpOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property matchDscp: The DSCP value that matches the QoS rule traffic.

Valid values: 0 to 63. If no value is matched, the value is -1.


remarking_dscpOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property remarkingDscp: The new DSCP value.

Valid values: 0 to 63. If you do not change the value, set the value to -1.


rule_descriptionOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ruleDescription: The description of the QoS rule.

The length is 0 to 256 characters and cannot start with 'http:// 'or 'https.


rule_nameOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property ruleName: The name of the QoS rule.

The length is 0 to 128 characters and cannot start with 'http:// 'or 'https.


src_cidrOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property srcCidr: The source IPv4 CIDR block that matches the QoS rule traffic.

If this parameter is not supported, enter SrcIPv6Cidr or *DstIPv6Cidr * .


src_ipv6_cidrOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property srcIpv6Cidr: The QoS rule traffic matches the source IPv6 network segment.

If this parameter is not supported, enter SrcCidr or *DstCidr * .


src_port_rangeOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property srcPortRange: The source port number of the QoS rule traffic matching.

The value range is 0 to 65535. If the traffic does not match, the value is -1. Currently, only a single port number is supported, and the start and end of the port number must be the same.


enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
fetch_condition No description.
fetch_dependency No description.
fetch_resource_desc No description.
get_att No description.
set_metadata No description.

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct

import ros_cdk_vpc
ros_cdk_vpc.TrafficQosRule.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_dst_cidr typing.Union[str, ros_cdk_core.IResolvable] Attribute DstCidr: The destination IPv4 CIDR block that matches the QoS rule traffic.
attr_dst_ipv6_cidr typing.Union[str, ros_cdk_core.IResolvable] Attribute DstIpv6Cidr: The QoS rule traffic matches the Destination IPv6 network segment.
attr_dst_port_range typing.Union[str, ros_cdk_core.IResolvable] Attribute DstPortRange: QoS rule traffic matches the destination port number range.
attr_match_dscp typing.Union[str, ros_cdk_core.IResolvable] Attribute MatchDscp: The DSCP value of the traffic matched by the QoS rule.
attr_priority typing.Union[str, ros_cdk_core.IResolvable] Attribute Priority: QoS rule priority.
attr_protocol typing.Union[str, ros_cdk_core.IResolvable] Attribute Protocol: QoS rule protocol type.
attr_qos_id typing.Union[str, ros_cdk_core.IResolvable] Attribute QosId: The QoS policy ID.
attr_queue_id typing.Union[str, ros_cdk_core.IResolvable] Attribute QueueId: The QoS queue ID.
attr_remarking_dscp typing.Union[str, ros_cdk_core.IResolvable] Attribute RemarkingDscp: Modify The DSCP value in the flow.
attr_rule_description typing.Union[str, ros_cdk_core.IResolvable] Attribute RuleDescription: The description of the QoS rule.
attr_rule_id typing.Union[str, ros_cdk_core.IResolvable] Attribute RuleId: The ID of the QoS rule.
attr_rule_name typing.Union[str, ros_cdk_core.IResolvable] Attribute RuleName: The name of the QoS rule.
attr_src_cidr typing.Union[str, ros_cdk_core.IResolvable] Attribute SrcCidr: The source IPv4 CIDR block that matches the QoS rule traffic.
attr_src_ipv6_cidr typing.Union[str, ros_cdk_core.IResolvable] Attribute SrcIpv6Cidr: The QoS rule traffic matches the source IPv6 network segment.
attr_src_port_range typing.Union[str, ros_cdk_core.IResolvable] Attribute SrcPortRange: The source port number of the QoS rule traffic matching.
props TrafficQosRuleProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


envRequired

env: IResourceEnvironment
  • Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


refRequired

ref: str
  • Type: str

stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


resourceOptional

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_dst_cidrRequired

attr_dst_cidr: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute DstCidr: The destination IPv4 CIDR block that matches the QoS rule traffic.


attr_dst_ipv6_cidrRequired

attr_dst_ipv6_cidr: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute DstIpv6Cidr: The QoS rule traffic matches the Destination IPv6 network segment.


attr_dst_port_rangeRequired

attr_dst_port_range: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute DstPortRange: QoS rule traffic matches the destination port number range.

Value range: 0 to 65535. If not, the value is -1. Currently, only a single port number is supported, and the start and end of the port number must be the same. The corresponding destination port number range is fixed for different protocol types.


attr_match_dscpRequired

attr_match_dscp: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute MatchDscp: The DSCP value of the traffic matched by the QoS rule.

Value range: 0 to 63. If not, the value is -1.


attr_priorityRequired

attr_priority: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Priority: QoS rule priority.

Value range: 1 to 9000. The larger the number, the higher the priority. The priority of a QoS rule cannot be repeated in the same QoS policy.


attr_protocolRequired

attr_protocol: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Protocol: QoS rule protocol type.


attr_qos_idRequired

attr_qos_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute QosId: The QoS policy ID.


attr_queue_idRequired

attr_queue_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute QueueId: The QoS queue ID.


attr_remarking_dscpRequired

attr_remarking_dscp: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RemarkingDscp: Modify The DSCP value in the flow.

Value range: 0 to 63. If the value is not modified, the value is -1.


attr_rule_descriptionRequired

attr_rule_description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RuleDescription: The description of the QoS rule.


attr_rule_idRequired

attr_rule_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RuleId: The ID of the QoS rule.


attr_rule_nameRequired

attr_rule_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RuleName: The name of the QoS rule.


attr_src_cidrRequired

attr_src_cidr: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute SrcCidr: The source IPv4 CIDR block that matches the QoS rule traffic.


attr_src_ipv6_cidrRequired

attr_src_ipv6_cidr: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute SrcIpv6Cidr: The QoS rule traffic matches the source IPv6 network segment.


attr_src_port_rangeRequired

attr_src_port_range: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute SrcPortRange: The source port number of the QoS rule traffic matching.

The value range is 0 to 65535. If the traffic does not match, the value is -1. Currently, only a single port number is supported, and the start and end of the port number must be the same.


propsRequired

props: TrafficQosRuleProps