Skip to content

QosCar

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

Initializers 

import ros_cdk_sag
ros_cdk_sag.QosCar(
  scope: Construct,
  id: str,
  limit_type: typing.Union[str, IResolvable],
  priority: typing.Union[typing.Union[int, float], IResolvable],
  qos_id: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  max_bandwidth_abs: typing.Union[typing.Union[int, float], IResolvable] = None,
  max_bandwidth_percent: typing.Union[typing.Union[int, float], IResolvable] = None,
  min_bandwidth_abs: typing.Union[typing.Union[int, float], IResolvable] = None,
  min_bandwidth_percent: typing.Union[typing.Union[int, float], IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  percent_source_type: 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.
limit_type typing.Union[str, ros_cdk_core.IResolvable] Property limitType: The type of the traffic throttling policy.
priority typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property priority: The priority of the traffic throttling policy.
qos_id typing.Union[str, ros_cdk_core.IResolvable] Property qosId: The ID of the QoS policy.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the traffic throttling policy.
max_bandwidth_abs typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maxBandwidthAbs: The maximum bandwidth.
max_bandwidth_percent typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maxBandwidthPercent: The maximum percentage that is based on the maximum upstream bandwidth of the SAG instance.
min_bandwidth_abs typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property minBandwidthAbs: The minimum bandwidth.
min_bandwidth_percent typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property minBandwidthPercent: The minimum percentage that is based on the maximum upstream bandwidth of the SAG instance.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the traffic throttling policy.
percent_source_type typing.Union[str, ros_cdk_core.IResolvable] Property percentSourceType: If the policy throttles traffic based on a specified bandwidth percentage, the following options are available: CcnBandwidth: Cloud Enterprise Network (CCN) bandwidth.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

limit_typeRequired

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

Property limitType: The type of the traffic throttling policy.

Valid values: Absolute: throttles traffic by a specific bandwidth range. Percent: throttles traffic by a specific range of bandwidth percentage.

priorityRequired

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

Property priority: The priority of the traffic throttling policy.

A smaller value represents a higher priority. If policies are assigned the same priority, the one applied the earliest prevails. Valid values: 1 to 7.

qos_idRequired

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

Property qosId: The ID of the QoS policy.

descriptionOptional

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

Property description: The description of the traffic throttling policy.

max_bandwidth_absOptional

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

Property maxBandwidthAbs: The maximum bandwidth.

This parameter is required when LimitType is set to Absolute.

max_bandwidth_percentOptional

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

Property maxBandwidthPercent: The maximum percentage that is based on the maximum upstream bandwidth of the SAG instance.

This parameter is required when LimitType is set to Percent.

min_bandwidth_absOptional

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

Property minBandwidthAbs: The minimum bandwidth.

This parameter is required when LimitType is set to Absolute.

min_bandwidth_percentOptional

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

Property minBandwidthPercent: The minimum percentage that is based on the maximum upstream bandwidth of the SAG instance.

This parameter is required when LimitType is set to Percent.

nameOptional

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

Property name: The name of the traffic throttling policy.

The name must be 2 to 128 characters in length, and can contain Chinese characters, letters, digits, periods (.), underscores (_), and hyphens (-).

percent_source_typeOptional

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

Property percentSourceType: If the policy throttles traffic based on a specified bandwidth percentage, the following options are available: CcnBandwidth: Cloud Enterprise Network (CCN) bandwidth.

InternetUpBandwidth: Internet upstream bandwidth.

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.QosCar.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_car_id ros_cdk_core.IResolvable Attribute QosCarId: The ID of the traffic throttling policy.

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_car_idRequired 

attr_qos_car_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute QosCarId: The ID of the traffic throttling policy.