CenBandwidthPackage
- Implements: ICenBandwidthPackage
This class encapsulates and extends the ROS resource type ALIYUN::CEN::CenBandwidthPackage.
Initializers
import com.aliyun.ros.cdk.cen.CenBandwidthPackage;
CenBandwidthPackage.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.bandwidth(java.lang.Number)
.bandwidth(IResolvable)
.geographicRegionAId(java.lang.String)
.geographicRegionAId(IResolvable)
.geographicRegionBId(java.lang.String)
.geographicRegionBId(IResolvable)
// .autoPay(java.lang.Boolean)
// .autoPay(IResolvable)
// .autoRenew(java.lang.Boolean)
// .autoRenew(IResolvable)
// .autoRenewDuration(java.lang.Number)
// .autoRenewDuration(IResolvable)
// .bandwidthPackageChargeType(java.lang.String)
// .bandwidthPackageChargeType(IResolvable)
// .description(java.lang.String)
// .description(IResolvable)
// .name(java.lang.String)
// .name(IResolvable)
// .period(java.lang.Number)
// .period(IResolvable)
// .pricingCycle(java.lang.String)
// .pricingCycle(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .tags(java.util.List<TagsProperty>)
.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 maximum bandwidth of the bandwidth plan. |
geographicRegionAId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property geographicRegionAId: The other area A to connect. |
geographicRegionBId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property geographicRegionBId: The other area B to connect. |
autoPay | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property autoPay: Specifies whether to enable automatic payment. |
autoRenew | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property autoRenew: Indicates whether automatic renewal is enabled. |
autoRenewDuration | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property autoRenewDuration: Duration of each automatic renewals. |
bandwidthPackageChargeType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property bandwidthPackageChargeType: The billing method. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The description of the bandwidth plan. |
name | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property name: The name of the bandwidth plan. |
period | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property period: The subscription duration of the bandwidth plan. |
pricingCycle | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property pricingCycle: The pricing cycle. |
resourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceGroupId: Resource group id. |
tags | java.util.List<TagsProperty> | Property tags: Tags to attach to instance. |
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 maximum bandwidth of the bandwidth plan.
Unit: Mbps. Valid values: 2 to 10000.
geographicRegionAIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property geographicRegionAId: The other area A to connect.
Valid value: China | North-America | Asia-Pacific | Europe | Australia
geographicRegionBIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property geographicRegionBId: The other area B to connect.
Valid value: China | North-America | Asia-Pacific | Europe | Australia
autoPayOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property autoPay: Specifies whether to enable automatic payment.
Valid values:
- true: yes.
- false (default): no. If you disable automatic payment, you must go to the Order Hub in the console to complete the payment after you call this operation. Otherwise, the instance cannot be created.
autoRenewOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property autoRenew: Indicates whether automatic renewal is enabled.
Valid values:true: Automatic renewal is enabled.false: Automatic renewal is not enabled. You must renew the instance manually.Default value: false.
autoRenewDurationOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property autoRenewDuration: Duration of each automatic renewals.
It takes effect when AutoRenew is true.
bandwidthPackageChargeTypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property bandwidthPackageChargeType: The billing method.
Valid value: PREPAY, POSTPAY (Default)
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of the bandwidth plan.
The description can be empty or 1 to 256 characters in length. It cannot start with http:// or https://.
nameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property name: The name of the bandwidth plan.
The name can be empty or 1 to 128 characters in length. It cannot start with http:// or https://.
periodOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property period: The subscription duration of the bandwidth plan.
Default value: 1.
- If you set PricingCycle to Month, valid values for Period are 1 to 3 and 6.
- If you set PricingCycle to Year, valid values for Period are 1 to 3.
This parameter is required if you set BandwidthPackageChargeType to PREPAY.
pricingCycleOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property pricingCycle: The pricing cycle.
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: Resource group id.
tagsOptional
- 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.
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.cen.CenBandwidthPackage;
CenBandwidthPackage.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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. |
attrArn | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Arn: The Alibaba Cloud Resource Name (ARN). |
attrCenBandwidthPackageId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CenBandwidthPackageId: The ID of the bandwidth package. |
props | CenBandwidthPackageProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
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
attrArnRequired
public java.lang.Object getAttrArn();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Arn: The Alibaba Cloud Resource Name (ARN).
attrCenBandwidthPackageIdRequired
public java.lang.Object getAttrCenBandwidthPackageId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CenBandwidthPackageId: The ID of the bandwidth package.
propsRequired
public CenBandwidthPackageProps getProps();
- Type: CenBandwidthPackageProps