QosCar

• Implements: IQosCar

This class encapsulates and extends the ROS resource type ALIYUN::SAG::QosCar.

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
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

limit_type^Required

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

priority^Required

• 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_id^Required

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

Property qosId: The ID of the QoS policy.

description^Optional

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

Property description: The description of the traffic throttling policy.

max_bandwidth_abs^Optional

• 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_percent^Optional

• 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_abs^Optional

• 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_percent^Optional

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

name^Optional

• 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_type^Optional

• 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_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• 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

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_sag
ros_cdk_sag.QosCar.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_qos_car_id^Required

attr_qos_car_id: typing.Union[str, IResolvable]

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

Attribute QosCarId: The ID of the traffic throttling policy.

props^Required

props: QosCarProps

• Type: QosCarProps