Skip to content

BandwidthPackage

  • Implements: com.aliyun.ros.cdk.ga.datasource.IBandwidthPackage

This class encapsulates and extends the ROS resource type DATASOURCE::GA::BandwidthPackage.

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

attrAutoRenewRequired

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

Attribute AutoRenew: Whether to enable automatic renewal.


attrAutoRenewDurationRequired

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

Attribute AutoRenewDuration: The duration of automatic renewal.

Unit: Month.


attrBandwidthRequired

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

Attribute Bandwidth: The bandwidth value of the bandwidth package.

Unit: Mbps. Value range: 2~2000.


attrBandwidthPackageIdRequired

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

Attribute BandwidthPackageId: The Resource ID of the bandwidth.


attrBandwidthPackageNameRequired

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

Attribute BandwidthPackageName: The Resource name of the bandwidth.


attrBandwidthTypeRequired

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

Attribute BandwidthType: Bandwidth type.


attrBillingTypeRequired

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

Attribute BillingType: Post-payment billing method.


attrCbnGeographicRegionIdARequired

public java.lang.Object getAttrCbnGeographicRegionIdA();
  • Type: java.lang.String OR 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 java.lang.Object getAttrCbnGeographicRegionIdB();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

The value is Global only.


attrCreateTimeRequired

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

Attribute CreateTime: Bandwidth package creation time.


attrDescriptionRequired

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

Attribute Description: the description of bandwidth package.


attrExpiredTimeRequired

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

Attribute ExpiredTime: Bandwidth package expiration time.


attrPaymentTypeRequired

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

Attribute PaymentType: Type of payment.


attrRatioRequired

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

Attribute Ratio: 95 Billing guaranteed percentage.

Value range: 30~100.


attrRenewalStatusRequired

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

Attribute RenewalStatus: Renewal status.


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.


attrTypeRequired

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

Attribute Type: The type of the bandwidth package.


propsRequired

public BandwidthPackageProps getProps();