CommonBandwidthPackage

• Implements: ICommonBandwidthPackage

This class encapsulates and extends the ROS resource type ALIYUN::VPC::CommonBandwidthPackage, which is used to create an Internet Shared Bandwidth instance.

Initializers

import ros_cdk_vpc
ros_cdk_vpc.CommonBandwidthPackage(
  scope: Construct,
  id: str,
  bandwidth: typing.Union[typing.Union[int, float], IResolvable],
  deletion_protection: typing.Union[bool, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  internet_charge_type: typing.Union[str, IResolvable] = None,
  isp: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  ratio: typing.Union[typing.Union[int, float], IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  zone: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

bandwidth^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

Unit: Mbit/s. Valid values: 1 to 1000. Default value: 1.

deletion_protection^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property deletionProtection: Whether to enable deletion protection.

Default to False.

description^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The description of the Internet Shared Bandwidth instance.

The description must be 0 to 256 characters in length and cannot start with http:\/\/ or https:\/\/.

internet_charge_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property internetChargeType: The billing method of the Internet Shared Bandwidth instance.

Set the value to PayByTraffic, which specifies the pay-by-data-transfer billing method.

isp^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property isp: The line type.

Valid values:

• BGP (default) All regions support BGP (Multi-ISP).
• BGP_PRO BGP (Multi-ISP) Pro lines are available in the China (Hong Kong), Singapore, Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions. If you are allowed to use single-ISP bandwidth, you can also use one of the following values:
• ChinaTelecom
• ChinaUnicom
• ChinaMobile
• ChinaTelecom_L2
• ChinaUnicom_L2
• ChinaMobile_L2 If your services are deployed in China East 1 Finance, this parameter is required and you must set the value to BGP_FinanceCloud.

name^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property name: The name of the Internet Shared Bandwidth instance.

The name must be 0 to 128 characters in length and cannot start with http:\/\/ or https:\/\/.

ratio^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property ratio: The percentage of the minimum bandwidth commitment.

Set the parameter to 20.

resource_group_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group.

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

zone^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property zone: The zone of the Internet Shared Bandwidth instance.

This parameter is required if you create an Internet Shared Bandwidth instance for a cloud box.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_vpc
ros_cdk_vpc.CommonBandwidthPackage.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_arn^Required

attr_arn: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attr_bandwidth_package_id^Required

attr_bandwidth_package_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute BandwidthPackageId: The ID of the Internet Shared Bandwidth instance.

props^Required

props: CommonBandwidthPackageProps

• Type: CommonBandwidthPackageProps