Skip to content

CommonBandwidthPackage

  • Implements: com.aliyun.ros.cdk.vpc.datasource.ICommonBandwidthPackage

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::CommonBandwidthPackage.

Initializers

import com.aliyun.ros.cdk.vpc.datasource.CommonBandwidthPackage;
CommonBandwidthPackage.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .commonBandwidthPackageId(java.lang.String)
//  .commonBandwidthPackageId(IResolvable)
//  .commonBandwidthPackageName(java.lang.String)
//  .commonBandwidthPackageName(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
commonBandwidthPackageId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property commonBandwidthPackageId: The ID of the Internet shared bandwidth.
commonBandwidthPackageName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property commonBandwidthPackageName: The name of the Internet Shared Bandwidth instance.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

commonBandwidthPackageIdOptional

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

Property commonBandwidthPackageId: The ID of the Internet shared bandwidth.


commonBandwidthPackageNameOptional

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

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


refreshOptionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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.

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

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)

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.datasource.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.
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.
attrBandwidth java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Bandwidth: The maximum bandwidth of the Internet Shared Bandwidth instance.
attrBusinessStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute BusinessStatus: The service status of the Internet Shared Bandwidth instance.
attrCommonBandwidthPackageId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CommonBandwidthPackageId: The ID of the Internet shared bandwidth.
attrCommonBandwidthPackageName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CommonBandwidthPackageName: The name of the Internet Shared Bandwidth instance.
attrCreationTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CreationTime: The time when the Internet Shared Bandwidth instance was created.
attrDeletionProtection java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DeletionProtection: Indicates whether deletion protection is enabled.
attrDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Description: The description of the Internet Shared Bandwidth instance.
attrExpiredTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ExpiredTime: The time when the Internet Shared Bandwidth instance expired.
attrHasReservationData java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HasReservationData: Indicates whether the information about pending orders is returned.
attrInstanceChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InstanceChargeType: The billing method of the Internet Shared Bandwidth instance.
attrInternetChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute InternetChargeType: The metering method of the Internet Shared Bandwidth instance.
attrIsp java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Isp: The line type.
attrPublicIpAddresses java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PublicIpAddresses: The elastic IP addresses (EIPs) that are associated with the Internet Shared Bandwidth instance.
attrRatio java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Ratio: The percentage of the minimum bandwidth commitment.
attrReservationActiveTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ReservationActiveTime: The time when the renewal took effect.
attrReservationBandwidth java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ReservationBandwidth: The new maximum bandwidth after the configurations are changed.
attrReservationInternetChargeType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ReservationInternetChargeType: The metering method after the configurations are changed.
attrReservationOrderType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ReservationOrderType: The renewal method.
attrResourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrServiceManaged java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ServiceManaged: Indicates whether the resource is created by the service account.
attrStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Status: The status of the Internet Shared Bandwidth instance.
props CommonBandwidthPackageProps 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

attrBandwidthRequired

public java.lang.Object getAttrBandwidth();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Unit: Mbit/s.


attrBusinessStatusRequired

public java.lang.Object getAttrBusinessStatus();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute BusinessStatus: The service status of the Internet Shared Bandwidth instance.

Valid values: Normal: The Internet Shared Bandwidth instance runs as expected. FinancialLocked: An overdue payment occurs in the Internet Shared Bandwidth instance Unactivated: The Internet Shared Bandwidth instance is not activated.


attrCommonBandwidthPackageIdRequired

public java.lang.Object getAttrCommonBandwidthPackageId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CommonBandwidthPackageId: The ID of the Internet shared bandwidth.


attrCommonBandwidthPackageNameRequired

public java.lang.Object getAttrCommonBandwidthPackageName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CommonBandwidthPackageName: The name of the Internet Shared Bandwidth instance.


attrCreationTimeRequired

public java.lang.Object getAttrCreationTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CreationTime: The time when the Internet Shared Bandwidth instance was created.

The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.


attrDeletionProtectionRequired

public java.lang.Object getAttrDeletionProtection();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DeletionProtection: Indicates whether deletion protection is enabled.

Valid values: false true


attrDescriptionRequired

public java.lang.Object getAttrDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Description: The description of the Internet Shared Bandwidth instance.


attrExpiredTimeRequired

public java.lang.Object getAttrExpiredTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ExpiredTime: The time when the Internet Shared Bandwidth instance expired.

The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.


attrHasReservationDataRequired

public java.lang.Object getAttrHasReservationData();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute HasReservationData: Indicates whether the information about pending orders is returned.

Valid values: false true


attrInstanceChargeTypeRequired

public java.lang.Object getAttrInstanceChargeType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceChargeType: The billing method of the Internet Shared Bandwidth instance.

Valid value: PostPaid: pay-as-you-go PrePaid: subscription


attrInternetChargeTypeRequired

public java.lang.Object getAttrInternetChargeType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InternetChargeType: The metering method of the Internet Shared Bandwidth instance.

Valid value: PayBy95: Charged by Enhanced 95th Percentile. PayByBandwidth: Charged by Bandwidth. PayByDominantTraffic: Charged by Dominant Traffic.


attrIspRequired

public java.lang.Object getAttrIsp();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Isp: The line type.

Valid values: BGP (default): BGP (Multi-ISP) lines. BGP_PRO: BGP (Multi-ISP) Pro lines. Valid values if you are allowed to use single-ISP bandwidth: ChinaTelecom ChinaUnicom ChinaMobile ChinaTelecom_L2 ChinaUnicom_L2 ChinaMobile_L2


attrPublicIpAddressesRequired

public java.lang.Object getAttrPublicIpAddresses();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PublicIpAddresses: The elastic IP addresses (EIPs) that are associated with the Internet Shared Bandwidth instance.


attrRatioRequired

public java.lang.Object getAttrRatio();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Ratio: The percentage of the minimum bandwidth commitment.

Only 20 is returned.


attrReservationActiveTimeRequired

public java.lang.Object getAttrReservationActiveTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ReservationActiveTime: The time when the renewal took effect.

The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.


attrReservationBandwidthRequired

public java.lang.Object getAttrReservationBandwidth();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ReservationBandwidth: The new maximum bandwidth after the configurations are changed.

Unit: Mbit/s.


attrReservationInternetChargeTypeRequired

public java.lang.Object getAttrReservationInternetChargeType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ReservationInternetChargeType: The metering method after the configurations are changed.

Valid value: PayBy95: Charged by Enhanced 95th Percentile. PayByBandwidth: Charged by Bandwidth. PayByDominantTraffic: Charged by Dominant Traffic.


attrReservationOrderTypeRequired

public java.lang.Object getAttrReservationOrderType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ReservationOrderType: The renewal method.

Valid values: RENEWCHANGE: renewal with a specification change TEMP_UPGRADE: renewal with a temporary upgrade UPGRADE: renewal with an upgrade


attrResourceGroupIdRequired

public java.lang.Object getAttrResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.


attrServiceManagedRequired

public java.lang.Object getAttrServiceManaged();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ServiceManaged: Indicates whether the resource is created by the service account.

Valid values: 0: The resource is not created by the service account. 1: The resource is created by the service account.


attrStatusRequired

public java.lang.Object getAttrStatus();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Status: The status of the Internet Shared Bandwidth instance.

Valid values: Available: The Internet Shared Bandwidth instance is available. Modifying: The Internet Shared Bandwidth instance is being modified.


propsRequired

public CommonBandwidthPackageProps getProps();