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 { datasource } from '@alicloud/ros-cdk-ga'
new datasource.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.
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

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

nodeRequired 

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

The construct tree node associated with this construct.

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

attrAutoRenewRequired 

public readonly attrAutoRenew: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AutoRenew: Whether to enable automatic renewal.

attrAutoRenewDurationRequired 

public readonly attrAutoRenewDuration: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AutoRenewDuration: The duration of automatic renewal.

Unit: Month.

attrBandwidthRequired 

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

Attribute Bandwidth: The bandwidth value of the bandwidth package.

Unit: Mbps. Value range: 2~2000.

attrBandwidthPackageIdRequired 

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

Attribute BandwidthPackageId: The Resource ID of the bandwidth.

attrBandwidthPackageNameRequired 

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

Attribute BandwidthPackageName: The Resource name of the bandwidth.

attrBandwidthTypeRequired 

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

Attribute BandwidthType: Bandwidth type.

attrBillingTypeRequired 

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

Attribute BillingType: Post-payment billing method.

attrCbnGeographicRegionIdARequired 

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

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

The value is China-mainland only.

attrCbnGeographicRegionIdBRequired 

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

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

The value is Global only.

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: Bandwidth package creation time.

attrDescriptionRequired 

public readonly attrDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Description: the description of bandwidth package.

attrExpiredTimeRequired 

public readonly attrExpiredTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ExpiredTime: Bandwidth package expiration time.

attrPaymentTypeRequired 

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

Attribute PaymentType: Type of payment.

attrRatioRequired 

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

Attribute Ratio: 95 Billing guaranteed percentage.

Value range: 30~100.

attrRenewalStatusRequired 

public readonly attrRenewalStatus: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute RenewalStatus: Renewal status.

attrResourceGroupIdRequired 

public readonly attrResourceGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrTypeRequired 

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

Attribute Type: The type of the bandwidth package.