CenBandwidthPackage

• Implements: ICenBandwidthPackage

This class encapsulates and extends the ROS resource type ALIYUN::CEN::CenBandwidthPackage.

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
)

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 bandwidth plan.

Unit: Mbps. Valid values: 2 to 10000.

geographic_region_a_id^Required

• 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_id^Required

• 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_pay^Optional

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

Property autoPay: Specifies whether to enable automatic payment.

Valid values:

• true: yes.
• false (default): no. If you disable automatic payment, you must go to the Order Hub in the console to complete the payment after you call this operation. Otherwise, the instance cannot be created.

auto_renew^Optional

• 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_duration^Optional

• 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_type^Optional

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

Property bandwidthPackageChargeType: The billing method.

Valid value: PREPAY, POSTPAY (Default)

description^Optional

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

Property description: The description of the bandwidth plan.

The description can be empty or 1 to 256 characters in length. It cannot start with http:// or https://.

name^Optional

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

Property name: The name of the bandwidth plan.

The name can be empty or 1 to 128 characters in length. It cannot start with http:// or https://.

period^Optional

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

Property period: The subscription duration of the bandwidth plan.

Default value: 1.

• If you set PricingCycle to Month, valid values for Period are 1 to 3 and 6.
• If you set PricingCycle to Year, valid values for Period are 1 to 3.

This parameter is required if you set BandwidthPackageChargeType to PREPAY.

pricing_cycle^Optional

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

Property pricingCycle: The pricing cycle.

resource_group_id^Optional

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

Property resourceGroupId: Resource group id.

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.

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_cen
ros_cdk_cen.CenBandwidthPackage.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_cen_bandwidth_package_id^Required

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.

props^Required

props: CenBandwidthPackageProps

• Type: CenBandwidthPackageProps