TrafficControl

• Implements: ITrafficControl

This class encapsulates and extends the ROS resource type ALIYUN::ApiGateway::TrafficControl.

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();

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 throttling policy.

The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (_). It cannot start with an underscore.

trafficControlUnit^Required

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

Property trafficControlUnit: The unit to be used in the throttling policy.

Valid values:

• SECOND
• MINUTE
• HOUR
• DAY

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

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

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)

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

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

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

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.

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 java.lang.Object getAttrTrafficControlId();

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

Attribute TrafficControlId: The id of the traffic control.

props^Required

public TrafficControlProps getProps();

• Type: TrafficControlProps