Skip to content

BandwidthPackage

This class encapsulates and extends the ROS resource type ALIYUN::GA::BandwidthPackage, which is used to create a bandwidth plan.

Initializers

import { BandwidthPackage } from '@alicloud/ros-cdk-ga'
new BandwidthPackage(scope: Construct, id: string, props: BandwidthPackageProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props BandwidthPackageProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: boolean

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import { BandwidthPackage } from '@alicloud/ros-cdk-ga'
BandwidthPackage.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrAutoPay string | @alicloud/ros-cdk-core.IResolvable Attribute AutoPay: The AutoPay of the bandwidth.
attrAutoUseCoupon string | @alicloud/ros-cdk-core.IResolvable Attribute AutoUseCoupon: The AutoUseCoupon of the bandwidth.
attrBandwidth string | @alicloud/ros-cdk-core.IResolvable Attribute Bandwidth: The bandwidth provided by the bandwidth plan.
attrBandwidthPackageId string | @alicloud/ros-cdk-core.IResolvable Attribute BandwidthPackageId: The Resource ID of the bandwidth.
attrBandwidthPackageName string | @alicloud/ros-cdk-core.IResolvable Attribute BandwidthPackageName: The Resource name of the bandwidth.
attrBandwidthType string | @alicloud/ros-cdk-core.IResolvable Attribute BandwidthType: the bandwidth BandwidthType of the bandwidth.
attrBillingType string | @alicloud/ros-cdk-core.IResolvable Attribute BillingType: The BillingType of the bandwidth.
attrCbnGeographicRegionIdA string | @alicloud/ros-cdk-core.IResolvable Attribute CbnGeographicRegionIdA: The CbnGeographicRegionIdA of the bandwidth.
attrCbnGeographicRegionIdB string | @alicloud/ros-cdk-core.IResolvable Attribute CbnGeographicRegionIdB: The CbnGeographicRegionIdB of the bandwidth.
attrChargeType string | @alicloud/ros-cdk-core.IResolvable Attribute ChargeType: The ChargeType of the bandwidth.
attrPaymentType string | @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: The Payment Type of the bandwidth.
attrRatio string | @alicloud/ros-cdk-core.IResolvable Attribute Ratio: The Ratio of the bandwidth.
attrType string | @alicloud/ros-cdk-core.IResolvable Attribute Type: The type of the bandwidth plan.
props BandwidthPackageProps No description.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


envRequired

public readonly env: IResourceEnvironment;
  • Type: @alicloud/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 readonly ref: string;
  • Type: string

stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrAutoPayRequired

public readonly attrAutoPay: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AutoPay: The AutoPay of the bandwidth.


attrAutoUseCouponRequired

public readonly attrAutoUseCoupon: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AutoUseCoupon: The AutoUseCoupon of the bandwidth.


attrBandwidthRequired

public readonly attrBandwidth: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Bandwidth: The bandwidth provided by the bandwidth plan.


attrBandwidthPackageIdRequired

public readonly attrBandwidthPackageId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute BandwidthPackageId: The Resource ID of the bandwidth.


attrBandwidthPackageNameRequired

public readonly attrBandwidthPackageName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute BandwidthPackageName: The Resource name of the bandwidth.


attrBandwidthTypeRequired

public readonly attrBandwidthType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute BandwidthType: the bandwidth BandwidthType of the bandwidth.


attrBillingTypeRequired

public readonly attrBillingType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute BillingType: The BillingType of the bandwidth.


attrCbnGeographicRegionIdARequired

public readonly attrCbnGeographicRegionIdA: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute CbnGeographicRegionIdA: The CbnGeographicRegionIdA of the bandwidth.


attrCbnGeographicRegionIdBRequired

public readonly attrCbnGeographicRegionIdB: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute CbnGeographicRegionIdB: The CbnGeographicRegionIdB of the bandwidth.


attrChargeTypeRequired

public readonly attrChargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ChargeType: The ChargeType of the bandwidth.


attrPaymentTypeRequired

public readonly attrPaymentType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PaymentType: The Payment Type of the bandwidth.


attrRatioRequired

public readonly attrRatio: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Ratio: The Ratio of the bandwidth.


attrTypeRequired

public readonly attrType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Type: The type of the bandwidth plan.


propsRequired

public readonly props: BandwidthPackageProps;