Skip to content

BandwidthPackage

This class encapsulates and extends the ROS resource type DATASOURCE::GA::BandwidthPackage, which is used to query the information about a bandwidth plan.

Initializers 

import com.aliyun.ros.cdk.ga.datasource.BandwidthPackage;
BandwidthPackage.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .bandwidthPackageId(java.lang.String)
    .bandwidthPackageId(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.
bandwidthPackageId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property bandwidthPackageId: The Resource ID of the bandwidth.
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

bandwidthPackageIdRequired

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

Property bandwidthPackageId: The Resource ID of the bandwidth.

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.ga.datasource.BandwidthPackage;
BandwidthPackage.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.
attrAutoRenew com.aliyun.ros.cdk.core.IResolvable Attribute AutoRenew: Whether to enable automatic renewal.
attrAutoRenewDuration com.aliyun.ros.cdk.core.IResolvable Attribute AutoRenewDuration: The duration of automatic renewal.
attrBandwidth com.aliyun.ros.cdk.core.IResolvable Attribute Bandwidth: The bandwidth value of the bandwidth package.
attrBandwidthPackageId com.aliyun.ros.cdk.core.IResolvable Attribute BandwidthPackageId: The Resource ID of the bandwidth.
attrBandwidthPackageName com.aliyun.ros.cdk.core.IResolvable Attribute BandwidthPackageName: The Resource name of the bandwidth.
attrBandwidthType com.aliyun.ros.cdk.core.IResolvable Attribute BandwidthType: Bandwidth type.
attrBillingType com.aliyun.ros.cdk.core.IResolvable Attribute BillingType: Post-payment billing method.
attrCbnGeographicRegionIdA com.aliyun.ros.cdk.core.IResolvable Attribute CbnGeographicRegionIdA: The interworking region A of cross-region acceleration packages.
attrCbnGeographicRegionIdB com.aliyun.ros.cdk.core.IResolvable Attribute CbnGeographicRegionIdB: The interworking Region B of cross-region acceleration packages.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: Bandwidth package creation time.
attrDescription com.aliyun.ros.cdk.core.IResolvable Attribute Description: the description of bandwidth package.
attrExpiredTime com.aliyun.ros.cdk.core.IResolvable Attribute ExpiredTime: Bandwidth package expiration time.
attrPaymentType com.aliyun.ros.cdk.core.IResolvable Attribute PaymentType: Type of payment.
attrRatio com.aliyun.ros.cdk.core.IResolvable Attribute Ratio: 95 Billing guaranteed percentage.
attrRenewalStatus com.aliyun.ros.cdk.core.IResolvable Attribute RenewalStatus: Renewal status.
attrResourceGroupId com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrType com.aliyun.ros.cdk.core.IResolvable Attribute Type: The type of the bandwidth package.

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

attrAutoRenewRequired 

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

Attribute AutoRenew: Whether to enable automatic renewal.

attrAutoRenewDurationRequired 

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

Attribute AutoRenewDuration: The duration of automatic renewal.

Unit: Month.

attrBandwidthRequired 

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

Attribute Bandwidth: The bandwidth value of the bandwidth package.

Unit: Mbps. Value range: 2~2000.

attrBandwidthPackageIdRequired 

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

Attribute BandwidthPackageId: The Resource ID of the bandwidth.

attrBandwidthPackageNameRequired 

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

Attribute BandwidthPackageName: The Resource name of the bandwidth.

attrBandwidthTypeRequired 

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

Attribute BandwidthType: Bandwidth type.

attrBillingTypeRequired 

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

Attribute BillingType: Post-payment billing method.

attrCbnGeographicRegionIdARequired 

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

Attribute CbnGeographicRegionIdA: The interworking region A of cross-region acceleration packages.

The value is China-mainland only.

attrCbnGeographicRegionIdBRequired 

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

Attribute CbnGeographicRegionIdB: The interworking Region B of cross-region acceleration packages.

The value is Global only.

attrCreateTimeRequired 

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

Attribute CreateTime: Bandwidth package creation time.

attrDescriptionRequired 

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

Attribute Description: the description of bandwidth package.

attrExpiredTimeRequired 

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

Attribute ExpiredTime: Bandwidth package expiration time.

attrPaymentTypeRequired 

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

Attribute PaymentType: Type of payment.

attrRatioRequired 

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

Attribute Ratio: 95 Billing guaranteed percentage.

Value range: 30~100.

attrRenewalStatusRequired 

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

Attribute RenewalStatus: Renewal status.

attrResourceGroupIdRequired 

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

Attribute ResourceGroupId: The ID of the resource group.

attrTypeRequired 

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

Attribute Type: The type of the bandwidth package.