Skip to content

CommonBandwidthPackage

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::CommonBandwidthPackage, which is used to query the information about an Internet Shared Bandwidth instance in a region.

Initializers 

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

scopeRequired

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

idRequired

  • Type: string

propsOptional

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-vpc'
datasource.CommonBandwidthPackage.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.
attrBandwidth @alicloud/ros-cdk-core.IResolvable Attribute Bandwidth: The maximum bandwidth of the Internet Shared Bandwidth instance.
attrBusinessStatus @alicloud/ros-cdk-core.IResolvable Attribute BusinessStatus: The service status of the Internet Shared Bandwidth instance.
attrCommonBandwidthPackageId @alicloud/ros-cdk-core.IResolvable Attribute CommonBandwidthPackageId: The ID of the Internet shared bandwidth.
attrCommonBandwidthPackageName @alicloud/ros-cdk-core.IResolvable Attribute CommonBandwidthPackageName: The name of the Internet Shared Bandwidth instance.
attrCreationTime @alicloud/ros-cdk-core.IResolvable Attribute CreationTime: The time when the Internet Shared Bandwidth instance was created.
attrDeletionProtection @alicloud/ros-cdk-core.IResolvable Attribute DeletionProtection: Indicates whether deletion protection is enabled.
attrDescription @alicloud/ros-cdk-core.IResolvable Attribute Description: The description of the Internet Shared Bandwidth instance.
attrExpiredTime @alicloud/ros-cdk-core.IResolvable Attribute ExpiredTime: The time when the Internet Shared Bandwidth instance expired.
attrHasReservationData @alicloud/ros-cdk-core.IResolvable Attribute HasReservationData: Indicates whether the information about pending orders is returned.
attrInstanceChargeType @alicloud/ros-cdk-core.IResolvable Attribute InstanceChargeType: The billing method of the Internet Shared Bandwidth instance.
attrInternetChargeType @alicloud/ros-cdk-core.IResolvable Attribute InternetChargeType: The metering method of the Internet Shared Bandwidth instance.
attrIsp @alicloud/ros-cdk-core.IResolvable Attribute Isp: The line type.
attrPublicIpAddresses @alicloud/ros-cdk-core.IResolvable Attribute PublicIpAddresses: The elastic IP addresses (EIPs) that are associated with the Internet Shared Bandwidth instance.
attrRatio @alicloud/ros-cdk-core.IResolvable Attribute Ratio: The percentage of the minimum bandwidth commitment.
attrReservationActiveTime @alicloud/ros-cdk-core.IResolvable Attribute ReservationActiveTime: The time when the renewal took effect.
attrReservationBandwidth @alicloud/ros-cdk-core.IResolvable Attribute ReservationBandwidth: The new maximum bandwidth after the configurations are changed.
attrReservationInternetChargeType @alicloud/ros-cdk-core.IResolvable Attribute ReservationInternetChargeType: The metering method after the configurations are changed.
attrReservationOrderType @alicloud/ros-cdk-core.IResolvable Attribute ReservationOrderType: The renewal method.
attrResourceGroupId @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrServiceManaged @alicloud/ros-cdk-core.IResolvable Attribute ServiceManaged: Indicates whether the resource is created by the service account.
attrStatus @alicloud/ros-cdk-core.IResolvable Attribute Status: The status of the Internet Shared Bandwidth instance.

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

attrBandwidthRequired 

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

Attribute Bandwidth: The maximum bandwidth of the Internet Shared Bandwidth instance.

Unit: Mbit/s.

attrBusinessStatusRequired 

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

Attribute BusinessStatus: The service status of the Internet Shared Bandwidth instance.

Valid values: Normal: The Internet Shared Bandwidth instance runs as expected. FinancialLocked: An overdue payment occurs in the Internet Shared Bandwidth instance Unactivated: The Internet Shared Bandwidth instance is not activated.

attrCommonBandwidthPackageIdRequired 

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

Attribute CommonBandwidthPackageId: The ID of the Internet shared bandwidth.

attrCommonBandwidthPackageNameRequired 

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

Attribute CommonBandwidthPackageName: The name of the Internet Shared Bandwidth instance.

attrCreationTimeRequired 

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

Attribute CreationTime: The time when the Internet Shared Bandwidth instance was created.

The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.

attrDeletionProtectionRequired 

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

Attribute DeletionProtection: Indicates whether deletion protection is enabled.

Valid values: false true

attrDescriptionRequired 

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

Attribute Description: The description of the Internet Shared Bandwidth instance.

attrExpiredTimeRequired 

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

Attribute ExpiredTime: The time when the Internet Shared Bandwidth instance expired.

The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.

attrHasReservationDataRequired 

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

Attribute HasReservationData: Indicates whether the information about pending orders is returned.

Valid values: false true

attrInstanceChargeTypeRequired 

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

Attribute InstanceChargeType: The billing method of the Internet Shared Bandwidth instance.

Valid value: PostPaid: pay-as-you-go PrePaid: subscription

attrInternetChargeTypeRequired 

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

Attribute InternetChargeType: The metering method of the Internet Shared Bandwidth instance.

Valid value: PayBy95: Charged by Enhanced 95th Percentile. PayByBandwidth: Charged by Bandwidth. PayByDominantTraffic: Charged by Dominant Traffic.

attrIspRequired 

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

Attribute Isp: The line type.

Valid values: BGP (default): BGP (Multi-ISP) lines. BGP_PRO: BGP (Multi-ISP) Pro lines. Valid values if you are allowed to use single-ISP bandwidth: ChinaTelecom ChinaUnicom ChinaMobile ChinaTelecom_L2 ChinaUnicom_L2 ChinaMobile_L2

attrPublicIpAddressesRequired 

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

Attribute PublicIpAddresses: The elastic IP addresses (EIPs) that are associated with the Internet Shared Bandwidth instance.

attrRatioRequired 

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

Attribute Ratio: The percentage of the minimum bandwidth commitment.

Only 20 is returned.

attrReservationActiveTimeRequired 

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

Attribute ReservationActiveTime: The time when the renewal took effect.

The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.

attrReservationBandwidthRequired 

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

Attribute ReservationBandwidth: The new maximum bandwidth after the configurations are changed.

Unit: Mbit/s.

attrReservationInternetChargeTypeRequired 

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

Attribute ReservationInternetChargeType: The metering method after the configurations are changed.

Valid value: PayBy95: Charged by Enhanced 95th Percentile. PayByBandwidth: Charged by Bandwidth. PayByDominantTraffic: Charged by Dominant Traffic.

attrReservationOrderTypeRequired 

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

Attribute ReservationOrderType: The renewal method.

Valid values: RENEWCHANGE: renewal with a specification change TEMP_UPGRADE: renewal with a temporary upgrade UPGRADE: renewal with an upgrade

attrResourceGroupIdRequired 

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

Attribute ResourceGroupId: The ID of the resource group.

attrServiceManagedRequired 

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

Attribute ServiceManaged: Indicates whether the resource is created by the service account.

Valid values: 0: The resource is not created by the service account. 1: The resource is created by the service account.

attrStatusRequired 

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

Attribute Status: The status of the Internet Shared Bandwidth instance.

Valid values: Available: The Internet Shared Bandwidth instance is available. Modifying: The Internet Shared Bandwidth instance is being modified.