BandwidthPackage

• Implements: IBandwidthPackage

This class encapsulates and extends the ROS resource type ALIYUN::GA::BandwidthPackage, which is used to create a bandwidth plan.

Initializers

import ros_cdk_ga
ros_cdk_ga.BandwidthPackage(
  scope: Construct,
  id: str,
  bandwidth: typing.Union[typing.Union[int, float], IResolvable],
  type: typing.Union[str, IResolvable],
  auto_pay: typing.Union[bool, IResolvable] = None,
  auto_use_coupon: typing.Union[str, IResolvable] = None,
  bandwidth_type: typing.Union[str, IResolvable] = None,
  billing_type: typing.Union[str, IResolvable] = None,
  cbn_geographic_region_id_a: typing.Union[str, IResolvable] = None,
  cbn_geographic_region_id_b: typing.Union[str, IResolvable] = None,
  charge_type: typing.Union[str, IResolvable] = None,
  duration: typing.Union[str, IResolvable] = None,
  pricing_cycle: typing.Union[str, IResolvable] = None,
  ratio: 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 bandwidth provided by the bandwidth plan.

type^Required

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

Property type: The type of the bandwidth plan.

auto_pay^Optional

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

Property autoPay: Specifies whether to enable automatic payment.

auto_use_coupon^Optional

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

Property autoUseCoupon: The AutoUseCoupon of the bandwidth.

bandwidth_type^Optional

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

Property bandwidthType: the bandwidth BandwidthType of the bandwidth.

billing_type^Optional

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

Property billingType: The BillingType of the bandwidth.

cbn_geographic_region_id_a^Optional

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

Property cbnGeographicRegionIdA: The CbnGeographicRegionIdA of the bandwidth.

cbn_geographic_region_id_b^Optional

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

Property cbnGeographicRegionIdB: The CbnGeographicRegionIdB of the bandwidth.

charge_type^Optional

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

Property chargeType: The ChargeType of the bandwidth.

duration^Optional

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

Property duration:.

pricing_cycle^Optional

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

Property pricingCycle:.

ratio^Optional

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

Property ratio: The Ratio of the bandwidth.

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_ga
ros_cdk_ga.BandwidthPackage.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_auto_pay^Required

attr_auto_pay: typing.Union[str, IResolvable]

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

Attribute AutoPay: The AutoPay of the bandwidth.

attr_auto_use_coupon^Required

attr_auto_use_coupon: typing.Union[str, IResolvable]

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

Attribute AutoUseCoupon: The AutoUseCoupon of the bandwidth.

attr_bandwidth^Required

attr_bandwidth: typing.Union[str, IResolvable]

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

Attribute Bandwidth: The bandwidth provided by the bandwidth plan.

attr_bandwidth_package_id^Required

attr_bandwidth_package_id: typing.Union[str, IResolvable]

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

Attribute BandwidthPackageId: The Resource ID of the bandwidth.

attr_bandwidth_package_name^Required

attr_bandwidth_package_name: typing.Union[str, IResolvable]

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

Attribute BandwidthPackageName: The Resource name of the bandwidth.

attr_bandwidth_type^Required

attr_bandwidth_type: typing.Union[str, IResolvable]

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

Attribute BandwidthType: the bandwidth BandwidthType of the bandwidth.

attr_billing_type^Required

attr_billing_type: typing.Union[str, IResolvable]

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

Attribute BillingType: The BillingType of the bandwidth.

attr_cbn_geographic_region_id_a^Required

attr_cbn_geographic_region_id_a: typing.Union[str, IResolvable]

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

Attribute CbnGeographicRegionIdA: The CbnGeographicRegionIdA of the bandwidth.

attr_cbn_geographic_region_id_b^Required

attr_cbn_geographic_region_id_b: typing.Union[str, IResolvable]

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

Attribute CbnGeographicRegionIdB: The CbnGeographicRegionIdB of the bandwidth.

attr_charge_type^Required

attr_charge_type: typing.Union[str, IResolvable]

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

Attribute ChargeType: The ChargeType of the bandwidth.

attr_payment_type^Required

attr_payment_type: typing.Union[str, IResolvable]

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

Attribute PaymentType: The Payment Type of the bandwidth.

attr_ratio^Required

attr_ratio: typing.Union[str, IResolvable]

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

Attribute Ratio: The Ratio of the bandwidth.

attr_type^Required

attr_type: typing.Union[str, IResolvable]

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

Attribute Type: The type of the bandwidth plan.

props^Required

props: BandwidthPackageProps

• Type: BandwidthPackageProps