CommonBandwidthPackage

This class encapsulates and extends the ROS resource type ALIYUN::VPC::CommonBandwidthPackage, which is used to create an elastic IP address (EIP) bandwidth plan.

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

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No description.
bandwidth	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property bandwidth: The peak bandwidth of the Internet Shared Bandwidth instance.
deletionProtection	java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable	Property deletionProtection: Whether to enable deletion protection.
description	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property description: The description of the Internet Shared Bandwidth instance.
internetChargeType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property internetChargeType: The billing model of the Internet Shared Bandwidth instance.
isp	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property isp: Line type of EIP, value: BGP (multi-line).
name	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property name: The name of the Internet Shared Bandwidth instance.
ratio	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property ratio: The minimum consumption ratio of the Internet Shared Bandwidth instance.
resourceGroupId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property resourceGroupId: The ID of the resource group.
tags	java.util.List<TagsProperty>	Property tags: Tags to attach to instance.
zone	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property zone: Zone Id.

---

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 peak bandwidth of the Internet Shared Bandwidth instance.

Unit: Mbit/s.

---

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 2 to 256 characters in length. It must start with a letter, and cannot start with http:// or https://.

---

internetChargeType^Optional

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

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

Allowed values: PayByBandwidth (default): Billed by bandwidth. PayBy95: Charged at Enhanced 95.

---

isp^Optional

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

Property isp: Line type of EIP, value: BGP (multi-line).

---

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 2 to 128 characters in length and can contain letters, numbers, periods (.), underscores (_), and hyphens (-). The name must start with a letter, and cannot start with http:// or https://.

---

ratio^Optional

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

Property ratio: The minimum consumption ratio of the Internet Shared Bandwidth instance.

Default to 100. Note This parameter is only supported on the China site.

---

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: Zone Id.

---

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.vpc.CommonBandwidthPackage;
CommonBandwidthPackage.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.
attrBandwidthPackageId	com.aliyun.ros.cdk.core.IResolvable	Attribute BandwidthPackageId: The ID of the Internet Shared Bandwidth instance.

---

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

---

attrBandwidthPackageId^Required

public IResolvable getAttrBandwidthPackageId();

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

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

---