Skip to content

CommonBandwidthPackage

This class encapsulates and extends the ROS resource type ALIYUN::VPC::CommonBandwidthPackage, which is used to create an elastic IP address (EIP) bandwidth plan.

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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
bandwidth typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property bandwidth: The peak bandwidth of the Internet Shared Bandwidth instance.
deletion_protection typing.Union[bool, ros_cdk_core.IResolvable] Property deletionProtection: Whether to enable deletion protection.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the Internet Shared Bandwidth instance.
internet_charge_type typing.Union[str, ros_cdk_core.IResolvable] Property internetChargeType: The billing model of the Internet Shared Bandwidth instance.
isp typing.Union[str, ros_cdk_core.IResolvable] Property isp: Line type of EIP, value: BGP (multi-line).
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the Internet Shared Bandwidth instance.
ratio typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property ratio: The minimum consumption ratio of the Internet Shared Bandwidth instance.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
zone typing.Union[str, ros_cdk_core.IResolvable] Property zone: Zone Id.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

bandwidthRequired

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

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

Unit: Mbit/s.

deletion_protectionOptional

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

Property deletionProtection: Whether to enable deletion protection.

Default to False.

descriptionOptional

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

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

The description must be 2 to 256 characters in length. It must start with a letter, and cannot start with http:// or https://.

internet_charge_typeOptional

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

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

Allowed values: PayByBandwidth (default): Billed by bandwidth. PayBy95: Charged at Enhanced 95.

ispOptional

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

Property isp: Line type of EIP, value: BGP (multi-line).

nameOptional

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

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

The name must be 2 to 128 characters in length and can contain letters, numbers, periods (.), underscores (_), and hyphens (-). The name must start with a letter, and cannot start with http:// or https://.

ratioOptional

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

Property ratio: The minimum consumption ratio of the Internet Shared Bandwidth instance.

Default to 100. Note This parameter is only supported on the China site.

resource_group_idOptional

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

Property resourceGroupId: The ID of the resource group.

tagsOptional

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.

zoneOptional

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

Property zone: Zone Id.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

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

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_bandwidth_package_id ros_cdk_core.IResolvable Attribute BandwidthPackageId: The ID of the Internet Shared Bandwidth instance.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_bandwidth_package_idRequired 

attr_bandwidth_package_id: IResolvable
  • Type: ros_cdk_core.IResolvable

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