QosCar
- Implements: IQosCar
This class encapsulates and extends the ROS resource type ALIYUN::SAG::QosCar.
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 value. |
maxBandwidthPercent | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property maxBandwidthPercent: The maximum bandwidth percentage. |
minBandwidthAbs | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property minBandwidthAbs: The minimum bandwidth value. |
minBandwidthPercent | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property minBandwidthPercent: The minimum bandwidth percentage. |
name | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property name: The name of the traffic throttling rule. |
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. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
limitTypeRequired
- 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.
priorityRequired
- 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.
qosIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property qosId: The ID of the QoS policy.
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of the traffic throttling policy.
maxBandwidthAbsOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property maxBandwidthAbs: The maximum bandwidth value.
The value must be an integer. Unit: Mbit/s. This parameter is returned when LimitType is set to Absolute.
The maximum bandwidth value must be greater than the minimum bandwidth value.
maxBandwidthPercentOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property maxBandwidthPercent: The maximum bandwidth percentage.
Unit: percent (%). Valid values: 1 to 100. This parameter is required when you set LimitType to Percent.
The maximum bandwidth percentage must be greater than the minimum bandwidth percentage.
minBandwidthAbsOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property minBandwidthAbs: The minimum bandwidth value.
The value must be an integer. Unit: Mbit/s. This parameter is returned when LimitType is set to Absolute.
minBandwidthPercentOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property minBandwidthPercent: The minimum bandwidth percentage.
Unit: percent (%). Valid values: 1 to 100. This parameter is required when you set LimitType to Percent.
nameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property name: The name of the traffic throttling rule.
The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
percentSourceTypeOptional
- 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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- 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.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute QosCarId: The ID of the traffic throttling policy. |
props | QosCarProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.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
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrQosCarIdRequired
public java.lang.Object getAttrQosCarId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute QosCarId: The ID of the traffic throttling policy.
propsRequired
public QosCarProps getProps();
- Type: QosCarProps