Skip to content

CommonBandwidthPackage

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

attrBandwidthRequired 

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

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

Unit: Mbit/s.

attrBusinessStatusRequired 

public IResolvable getAttrBusinessStatus();
  • Type: 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 IResolvable getAttrCommonBandwidthPackageId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CommonBandwidthPackageId: The ID of the Internet shared bandwidth.

attrCommonBandwidthPackageNameRequired 

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

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

attrCreationTimeRequired 

public IResolvable getAttrCreationTime();
  • Type: 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 IResolvable getAttrDeletionProtection();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DeletionProtection: Indicates whether deletion protection is enabled.

Valid values: false true

attrDescriptionRequired 

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

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

attrExpiredTimeRequired 

public IResolvable getAttrExpiredTime();
  • Type: 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 IResolvable getAttrHasReservationData();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

Valid values: false true

attrInstanceChargeTypeRequired 

public IResolvable getAttrInstanceChargeType();
  • Type: 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 IResolvable getAttrInternetChargeType();
  • Type: 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 IResolvable getAttrIsp();
  • Type: 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 IResolvable getAttrPublicIpAddresses();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrRatioRequired 

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

Attribute Ratio: The percentage of the minimum bandwidth commitment.

Only 20 is returned.

attrReservationActiveTimeRequired 

public IResolvable getAttrReservationActiveTime();
  • Type: 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 IResolvable getAttrReservationBandwidth();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

Unit: Mbit/s.

attrReservationInternetChargeTypeRequired 

public IResolvable getAttrReservationInternetChargeType();
  • Type: 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 IResolvable getAttrReservationOrderType();
  • Type: 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 IResolvable getAttrResourceGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrServiceManagedRequired 

public IResolvable getAttrServiceManaged();
  • Type: 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 IResolvable getAttrStatus();
  • Type: 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.