Skip to content

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.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

bandwidthRequired

  • 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.

deletionProtectionOptional

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

Property deletionProtection: Whether to enable deletion protection.

Default to False.

descriptionOptional

  • 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://.

internetChargeTypeOptional

  • 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.

ispOptional

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

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

nameOptional

  • 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://.

ratioOptional

  • 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.

resourceGroupIdOptional

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

Property resourceGroupId: The ID of the resource group.

tagsOptional

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.

zoneOptional

  • 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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • 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.

xRequired

  • 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.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

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

attrBandwidthPackageIdRequired 

public IResolvable getAttrBandwidthPackageId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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