Skip to content

BandwidthPackage

  • Implements: @alicloud/ros-cdk-ga.datasource.IBandwidthPackage

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

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

attrAutoRenewRequired

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

Attribute AutoRenew: Whether to enable automatic renewal.


attrAutoRenewDurationRequired

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

Attribute AutoRenewDuration: The duration of automatic renewal.

Unit: Month.


attrBandwidthRequired

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

Attribute Bandwidth: The bandwidth value of the bandwidth package.

Unit: Mbps. Value range: 2~2000.


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: Bandwidth type.


attrBillingTypeRequired

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

Attribute BillingType: Post-payment billing method.


attrCbnGeographicRegionIdARequired

public readonly attrCbnGeographicRegionIdA: string | IResolvable;
  • Type: string | @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: string | IResolvable;
  • Type: string | @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: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: Bandwidth package creation time.


attrDescriptionRequired

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

Attribute Description: the description of bandwidth package.


attrExpiredTimeRequired

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

Attribute ExpiredTime: Bandwidth package expiration time.


attrPaymentTypeRequired

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

Attribute PaymentType: Type of payment.


attrRatioRequired

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

Attribute Ratio: 95 Billing guaranteed percentage.

Value range: 30~100.


attrRenewalStatusRequired

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

Attribute RenewalStatus: Renewal status.


attrResourceGroupIdRequired

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

Attribute ResourceGroupId: The ID of the resource group.


attrTypeRequired

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

Attribute Type: The type of the bandwidth package.


propsRequired

public readonly props: BandwidthPackageProps;