Skip to content

QosPolicy

This class encapsulates and extends the ROS resource type ALIYUN::SAG::QosPolicy, which is used to create a traffic classification rule for a quality of service (QoS) policy.

Initializers 

import ros_cdk_sag
ros_cdk_sag.QosPolicy(
  scope: Construct,
  id: str,
  dest_cidr: typing.Union[str, IResolvable],
  dest_port_range: typing.Union[str, IResolvable],
  ip_protocol: typing.Union[str, IResolvable],
  priority: typing.Union[typing.Union[int, float], IResolvable],
  qos_id: typing.Union[str, IResolvable],
  source_cidr: typing.Union[str, IResolvable],
  source_port_range: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  dpi_group_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  dpi_signature_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  end_time: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  start_time: 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.
dest_cidr typing.Union[str, ros_cdk_core.IResolvable] Property destCidr: The range of the destination IP addresses.
dest_port_range typing.Union[str, ros_cdk_core.IResolvable] Property destPortRange: The range of destination ports.
ip_protocol typing.Union[str, ros_cdk_core.IResolvable] Property ipProtocol: The type of the protocol that applies to the traffic classification rule.
priority typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property priority: The priority of the traffic throttling policy to which the traffic classification rule belongs.
qos_id typing.Union[str, ros_cdk_core.IResolvable] Property qosId: The ID of the QoS policy.
source_cidr typing.Union[str, ros_cdk_core.IResolvable] Property sourceCidr: The range of the source IP addresses.
source_port_range typing.Union[str, ros_cdk_core.IResolvable] Property sourcePortRange: The range of source ports.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the traffic classification rule.
dpi_group_ids typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property dpiGroupIds: The ID of the application group.
dpi_signature_ids typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property dpiSignatureIds: The ID of the application.
end_time typing.Union[str, ros_cdk_core.IResolvable] Property endTime: The time when the traffic classification rule becomes invalid.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the traffic classification rule.
start_time typing.Union[str, ros_cdk_core.IResolvable] Property startTime: The time when the traffic classification rule takes effect.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

dest_cidrRequired

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

Property destCidr: The range of the destination IP addresses.

Specify the value of this parameter in CIDR notation. Example: 192.168.10.0/24.

dest_port_rangeRequired

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

Property destPortRange: The range of destination ports.

Valid values: 1 to 65535 and -1. Set this parameter in one of the following formats: 1/200: a port range from 1 to 200 80/80: port 80 -1/-1: all ports

ip_protocolRequired

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

Property ipProtocol: The type of the protocol that applies to the traffic classification rule.

The supported protocols provided in this topic are for reference only. The actual protocols in the console shall prevail.

priorityRequired

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

Property priority: The priority of the traffic throttling policy to which the traffic classification rule belongs.

qos_idRequired

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

Property qosId: The ID of the QoS policy.

source_cidrRequired

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

Property sourceCidr: The range of the source IP addresses.

Specify the value of this parameter in CIDR notation. Example: 192.168.1.0/24.

source_port_rangeRequired

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

Property sourcePortRange: The range of source ports.

Valid values: 1 to 65535 and -1. Set this parameter in one of the following formats: 1/200: a port range from 1 to 200 80/80: port 80 -1/-1: all ports

descriptionOptional

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

Property description: The description of the traffic classification rule.

The description must be 1 to 512 characters in length and can contain letters, digits, underscores (_), and hyphens (-). It must start with a letter.

dpi_group_idsOptional

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

Property dpiGroupIds: The ID of the application group.

You can enter at most 100 application group IDs at a time. You can call the ListDpiGroups operation to query application group IDs and information about the applications.

dpi_signature_idsOptional

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

Property dpiSignatureIds: The ID of the application.

You can enter at most 100 application IDs at a time. You can call the ListDpiSignatures operation to query application IDs and information about the applications.

end_timeOptional

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

Property endTime: The time when the traffic classification rule becomes invalid.

Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss+0800 format. The time must be in UTC+8.

nameOptional

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

Property name: The name of the traffic classification rule.

The name must be 2 to 100 characters in length, and can contain digits, underscores (_), and hyphens (-). It must start with a letter.

start_timeOptional

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

Property startTime: The time when the traffic classification rule takes effect.

Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss+0800 format. The time must be in UTC+8.

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.
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

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_sag
ros_cdk_sag.QosPolicy.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.
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_qos_policy_id ros_cdk_core.IResolvable Attribute QosPolicyId: The ID of the traffic classification rule.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

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_qos_policy_idRequired 

attr_qos_policy_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute QosPolicyId: The ID of the traffic classification rule.