CommonBandwidthPackage

• Implements: @alicloud/ros-cdk-vpc.datasource.ICommonBandwidthPackage

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::CommonBandwidthPackage.

Initializers

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

scope^Required

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

id^Required

• Type: string

props^Optional

• Type: CommonBandwidthPackageProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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.

session^Required

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

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

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

addCount

public addCount(count: number | IResolvable): void

count^Required

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

addDependency

public addDependency(resource: Resource): void

resource^Required

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

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

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

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

import { datasource } from '@alicloud/ros-cdk-vpc'
datasource.CommonBandwidthPackage.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

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

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

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

attrBandwidth^Required

public readonly attrBandwidth: string | IResolvable;

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

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

Unit: Mbit/s.

attrBusinessStatus^Required

public readonly attrBusinessStatus: string | IResolvable;

• Type: string | @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.

attrCommonBandwidthPackageId^Required

public readonly attrCommonBandwidthPackageId: string | IResolvable;

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

Attribute CommonBandwidthPackageId: The ID of the Internet shared bandwidth.

attrCommonBandwidthPackageName^Required

public readonly attrCommonBandwidthPackageName: string | IResolvable;

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

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

attrCreationTime^Required

public readonly attrCreationTime: string | IResolvable;

• Type: string | @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.

attrDeletionProtection^Required

public readonly attrDeletionProtection: string | IResolvable;

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

Attribute DeletionProtection: Indicates whether deletion protection is enabled.

Valid values: false true

attrDescription^Required

public readonly attrDescription: string | IResolvable;

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

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

attrExpiredTime^Required

public readonly attrExpiredTime: string | IResolvable;

• Type: string | @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.

attrHasReservationData^Required

public readonly attrHasReservationData: string | IResolvable;

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

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

Valid values: false true

attrInstanceChargeType^Required

public readonly attrInstanceChargeType: string | IResolvable;

• Type: string | @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

attrInternetChargeType^Required

public readonly attrInternetChargeType: string | IResolvable;

• Type: string | @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.

attrIsp^Required

public readonly attrIsp: string | IResolvable;

• Type: string | @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

attrPublicIpAddresses^Required

public readonly attrPublicIpAddresses: string | IResolvable;

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

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

attrRatio^Required

public readonly attrRatio: string | IResolvable;

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

Attribute Ratio: The percentage of the minimum bandwidth commitment.

Only 20 is returned.

attrReservationActiveTime^Required

public readonly attrReservationActiveTime: string | IResolvable;

• Type: string | @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.

attrReservationBandwidth^Required

public readonly attrReservationBandwidth: string | IResolvable;

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

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

Unit: Mbit/s.

attrReservationInternetChargeType^Required

public readonly attrReservationInternetChargeType: string | IResolvable;

• Type: string | @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.

attrReservationOrderType^Required

public readonly attrReservationOrderType: string | IResolvable;

• Type: string | @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

attrResourceGroupId^Required

public readonly attrResourceGroupId: string | IResolvable;

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

Attribute ResourceGroupId: The ID of the resource group.

attrServiceManaged^Required

public readonly attrServiceManaged: string | IResolvable;

• Type: string | @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.

attrStatus^Required

public readonly attrStatus: string | IResolvable;

• Type: string | @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.

props^Required

public readonly props: CommonBandwidthPackageProps;

• Type: CommonBandwidthPackageProps