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 com.aliyun.ros.cdk.sag.QosCar;
QosCar.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .limitType(java.lang.String)
    .limitType(IResolvable)
    .priority(java.lang.Number)
    .priority(IResolvable)
    .qosId(java.lang.String)
    .qosId(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .maxBandwidthAbs(java.lang.Number)
//  .maxBandwidthAbs(IResolvable)
//  .maxBandwidthPercent(java.lang.Number)
//  .maxBandwidthPercent(IResolvable)
//  .minBandwidthAbs(java.lang.Number)
//  .minBandwidthAbs(IResolvable)
//  .minBandwidthPercent(java.lang.Number)
//  .minBandwidthPercent(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .percentSourceType(java.lang.String)
//  .percentSourceType(IResolvable)
    .build();

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No description.
limitType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property limitType: The type of the traffic throttling policy.
priority	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property priority: The priority of the traffic throttling policy.
qosId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property qosId: The ID of the QoS policy.
description	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property description: The description of the traffic throttling policy.
maxBandwidthAbs	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property maxBandwidthAbs: The maximum bandwidth.
maxBandwidthPercent	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property maxBandwidthPercent: The maximum percentage that is based on the maximum upstream bandwidth of the SAG instance.
minBandwidthAbs	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property minBandwidthAbs: The minimum bandwidth.
minBandwidthPercent	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property minBandwidthPercent: The minimum percentage that is based on the maximum upstream bandwidth of the SAG instance.
name	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property name: The name of the traffic throttling policy.
percentSourceType	java.lang.String OR com.aliyun.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.

---

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

limitType^Required

• Type: java.lang.String OR com.aliyun.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: java.lang.Number OR com.aliyun.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.

---

qosId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property qosId: The ID of the QoS policy.

---

description^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of the traffic throttling policy.

---

maxBandwidthAbs^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property maxBandwidthAbs: The maximum bandwidth.

This parameter is required when LimitType is set to Absolute.

---

maxBandwidthPercent^Optional

• Type: java.lang.Number OR com.aliyun.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.

---

minBandwidthAbs^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property minBandwidthAbs: The minimum bandwidth.

This parameter is required when LimitType is set to Absolute.

---

minBandwidthPercent^Optional

• Type: java.lang.Number OR com.aliyun.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: java.lang.String OR com.aliyun.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 (-).

---

percentSourceType^Optional

• Type: java.lang.String OR com.aliyun.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.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.

---

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

---

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

---

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

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

---

isConstruct

import com.aliyun.ros.cdk.sag.QosCar;
QosCar.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

---

Properties

Name	Type	Description
node	com.aliyun.ros.cdk.core.ConstructNode	The construct tree node associated with this construct.
ref	java.lang.String	No description.
stack	com.aliyun.ros.cdk.core.Stack	The stack in which this resource is defined.
resource	com.aliyun.ros.cdk.core.RosResource	No description.
attrQosCarId	com.aliyun.ros.cdk.core.IResolvable	Attribute QosCarId: The ID of the traffic throttling policy.

---

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

---

attrQosCarId^Required

public IResolvable getAttrQosCarId();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute QosCarId: The ID of the traffic throttling policy.

---