CommonBandwidthPackage

• Implements: ICommonBandwidthPackage

This class encapsulates and extends the ROS resource type ALIYUN::VPC::CommonBandwidthPackage, which is used to create an Internet Shared Bandwidth instance.

Initializers

import com.aliyun.ros.cdk.vpc.CommonBandwidthPackage;
CommonBandwidthPackage.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .bandwidth(java.lang.Number)
    .bandwidth(IResolvable)
//  .deletionProtection(java.lang.Boolean)
//  .deletionProtection(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .internetChargeType(java.lang.String)
//  .internetChargeType(IResolvable)
//  .isp(java.lang.String)
//  .isp(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .ratio(java.lang.Number)
//  .ratio(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .zone(java.lang.String)
//  .zone(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

bandwidth^Required

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

Property bandwidth: The maximum bandwidth of the Internet Shared Bandwidth instance.

Unit: Mbit/s. Valid values: 1 to 1000. Default value: 1.

deletionProtection^Optional

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

Property deletionProtection: Whether to enable deletion protection.

Default to False.

description^Optional

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

Property description: The description of the Internet Shared Bandwidth instance.

The description must be 0 to 256 characters in length and cannot start with http:\/\/ or https:\/\/.

internetChargeType^Optional

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

Property internetChargeType: The billing method of the Internet Shared Bandwidth instance.

Set the value to PayByTraffic, which specifies the pay-by-data-transfer billing method.

isp^Optional

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

Property isp: The line type.

Valid values:

• BGP (default) All regions support BGP (Multi-ISP).
• BGP_PRO BGP (Multi-ISP) Pro lines are available in the China (Hong Kong), Singapore, Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions. If you are allowed to use single-ISP bandwidth, you can also use one of the following values:
• ChinaTelecom
• ChinaUnicom
• ChinaMobile
• ChinaTelecom_L2
• ChinaUnicom_L2
• ChinaMobile_L2 If your services are deployed in China East 1 Finance, this parameter is required and you must set the value to BGP_FinanceCloud.

name^Optional

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

Property name: The name of the Internet Shared Bandwidth instance.

The name must be 0 to 128 characters in length and cannot start with http:\/\/ or https:\/\/.

ratio^Optional

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

Property ratio: The percentage of the minimum bandwidth commitment.

Set the parameter to 20.

resourceGroupId^Optional

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

Property resourceGroupId: The ID of the resource group.

tags^Optional

• Type: java.util.List<TagsProperty>

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

zone^Optional

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

Property zone: The zone of the Internet Shared Bandwidth instance.

This parameter is required if you create an Internet Shared Bandwidth instance for a cloud box.

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.vpc.CommonBandwidthPackage;
CommonBandwidthPackage.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

attrArn^Required

public java.lang.Object getAttrArn();

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

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attrBandwidthPackageId^Required

public java.lang.Object getAttrBandwidthPackageId();

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

Attribute BandwidthPackageId: The ID of the Internet Shared Bandwidth instance.

props^Required

public CommonBandwidthPackageProps getProps();

• Type: CommonBandwidthPackageProps