TrafficControl

This class encapsulates and extends the ROS resource type ALIYUN::ApiGateway::TrafficControl, which is used to create a custom throttling policy.

Initializers

import com.aliyun.ros.cdk.apigateway.TrafficControl;
TrafficControl.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .apiDefault(java.lang.Number)
    .apiDefault(IResolvable)
    .trafficControlName(java.lang.String)
    .trafficControlName(IResolvable)
    .trafficControlUnit(java.lang.String)
    .trafficControlUnit(IResolvable)
//  .appDefault(java.lang.String)
//  .appDefault(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .special(IResolvable)
//  .special(java.util.List<IResolvable)
//  .special(SpecialProperty>)
//  .userDefault(java.lang.String)
//  .userDefault(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.
apiDefault	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property apiDefault: Default API traffic value.
trafficControlName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property trafficControlName: The name of the traffic control.It must be 4 to 128 characters in length, and can contain letters, digits, underscores (_), dashes (-), spaces and dots (.), It must start with a letter.
trafficControlUnit	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property trafficControlUnit: Traffic control unit, DAY\/HOUR\/MINUTE.
appDefault	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property appDefault: Default APP traffic value.
description	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property description: Description of the traffic control, less than 180 characters.
special	com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSpecialProperty>	Property special: Special traffic controls.
userDefault	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property userDefault: Default user traffic value.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

apiDefault^Required

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

Property apiDefault: Default API traffic value.

---

trafficControlName^Required

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

Property trafficControlName: The name of the traffic control.It must be 4 to 128 characters in length, and can contain letters, digits, underscores (_), dashes (-), spaces and dots (.), It must start with a letter.

---

trafficControlUnit^Required

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

Property trafficControlUnit: Traffic control unit, DAY\/HOUR\/MINUTE.

---

appDefault^Optional

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

Property appDefault: Default APP traffic value.

---

description^Optional

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

Property description: Description of the traffic control, less than 180 characters.

---

special^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSpecialProperty>

Property special: Special traffic controls.

---

userDefault^Optional

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

Property userDefault: Default user traffic value.

---

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.apigateway.TrafficControl;
TrafficControl.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.
attrTrafficControlId	com.aliyun.ros.cdk.core.IResolvable	Attribute TrafficControlId: The id of the traffic control.

---

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

---

attrTrafficControlId^Required

public IResolvable getAttrTrafficControlId();

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

Attribute TrafficControlId: The id of the traffic control.

---