Skip to content

CenBandwidthPackage

This class encapsulates and extends the ROS resource type ALIYUN::CEN::CenBandwidthPackage, which is used to purchase a bandwidth plan before you use Cloud Enterprise Network (CEN) to connect network instances that reside in different regions.

Initializers

import ros_cdk_cen
ros_cdk_cen.CenBandwidthPackage(
  scope: Construct,
  id: str,
  bandwidth: typing.Union[typing.Union[int, float], IResolvable],
  geographic_region_a_id: typing.Union[str, IResolvable],
  geographic_region_b_id: typing.Union[str, IResolvable],
  auto_pay: typing.Union[bool, IResolvable] = None,
  auto_renew: typing.Union[bool, IResolvable] = None,
  auto_renew_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  bandwidth_package_charge_type: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  pricing_cycle: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = 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 bandwidth in Mbps of the bandwidth package.
geographic_region_a_id typing.Union[str, ros_cdk_core.IResolvable] Property geographicRegionAId: The other area A to connect.
geographic_region_b_id typing.Union[str, ros_cdk_core.IResolvable] Property geographicRegionBId: The other area B to connect.
auto_pay typing.Union[bool, ros_cdk_core.IResolvable] Property autoPay: Whether to automatically pay the bill.
auto_renew typing.Union[bool, ros_cdk_core.IResolvable] Property autoRenew: Indicates whether automatic renewal is enabled.
auto_renew_duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property autoRenewDuration: Duration of each automatic renewals.
bandwidth_package_charge_type typing.Union[str, ros_cdk_core.IResolvable] Property bandwidthPackageChargeType: The billing method.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the bandwidth package.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the bandwidth package.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The purchase period.
pricing_cycle typing.Union[str, ros_cdk_core.IResolvable] Property pricingCycle: The pricing cycle.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group id.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
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 bandwidth in Mbps of the bandwidth package.

The bandwidth cannot be less than 2 Mbps.


geographic_region_a_idRequired

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

Property geographicRegionAId: The other area A to connect.

Valid value: China | North-America | Asia-Pacific | Europe | Australia


geographic_region_b_idRequired

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

Property geographicRegionBId: The other area B to connect.

Valid value: China | North-America | Asia-Pacific | Europe | Australia


auto_payOptional

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

Property autoPay: Whether to automatically pay the bill.

Valid value: true (default) false


auto_renewOptional

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

Property autoRenew: Indicates whether automatic renewal is enabled.

Valid values:true: Automatic renewal is enabled.false: Automatic renewal is not enabled. You must renew the instance manually.Default value: false.


auto_renew_durationOptional

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

Property autoRenewDuration: Duration of each automatic renewals.

It takes effect when AutoRenew is true.


bandwidth_package_charge_typeOptional

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

Property bandwidthPackageChargeType: The billing method.

Valid value: PREPAY, POSTPAY (Default)


descriptionOptional

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

Property description: The description of the bandwidth package.

The description can contain [2,256] characters, numbers, underscores, and hyphens, and the name must start with English letters, but cannot start with http:// or https://.


nameOptional

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

Property name: The name of the bandwidth package.

The name can contain 2-128 characters including a-z, A-Z, 0-9, periods, underlines, and hyphens. It must start with English letters, but cannot start with http:// or https://.


periodOptional

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

Property period: The purchase period.

The default value is 1.


pricing_cycleOptional

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

Property pricingCycle: The pricing cycle.


resource_group_idOptional

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

Property resourceGroupId: Resource group id.


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.


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.
fetch_condition No description.
fetch_dependency No description.
fetch_resource_desc 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

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

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_cen
ros_cdk_cen.CenBandwidthPackage.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.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
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_arn typing.Union[str, ros_cdk_core.IResolvable] Attribute Arn: The Alibaba Cloud Resource Name (ARN).
attr_cen_bandwidth_package_id typing.Union[str, ros_cdk_core.IResolvable] Attribute CenBandwidthPackageId: The ID of the bandwidth package.
props CenBandwidthPackageProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


envRequired

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.


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_arnRequired

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

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


attr_cen_bandwidth_package_idRequired

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

Attribute CenBandwidthPackageId: The ID of the bandwidth package.


propsRequired

props: CenBandwidthPackageProps