BandwidthPackage

• Implements: ros_cdk_ga.datasource.IBandwidthPackage

This class encapsulates and extends the ROS resource type DATASOURCE::GA::BandwidthPackage.

Initializers

from ros_cdk_ga import datasource
datasource.BandwidthPackage(
  scope: Construct,
  id: str,
  bandwidth_package_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

bandwidth_package_id^Required

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

Property bandwidthPackageId: The Resource ID of the bandwidth.

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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

from ros_cdk_ga import datasource
datasource.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_renew^Required

attr_auto_renew: typing.Union[str, IResolvable]

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

Attribute AutoRenew: Whether to enable automatic renewal.

attr_auto_renew_duration^Required

attr_auto_renew_duration: typing.Union[str, IResolvable]

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

Attribute AutoRenewDuration: The duration of automatic renewal.

Unit: Month.

attr_bandwidth^Required

attr_bandwidth: typing.Union[str, IResolvable]

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

Attribute Bandwidth: The bandwidth value of the bandwidth package.

Unit: Mbps. Value range: 2~2000.

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: Bandwidth type.

attr_billing_type^Required

attr_billing_type: typing.Union[str, IResolvable]

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

Attribute BillingType: Post-payment billing method.

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 interworking region A of cross-region acceleration packages.

The value is China-mainland only.

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 interworking Region B of cross-region acceleration packages.

The value is Global only.

attr_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

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

Attribute CreateTime: Bandwidth package creation time.

attr_description^Required

attr_description: typing.Union[str, IResolvable]

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

Attribute Description: the description of bandwidth package.

attr_expired_time^Required

attr_expired_time: typing.Union[str, IResolvable]

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

Attribute ExpiredTime: Bandwidth package expiration time.

attr_payment_type^Required

attr_payment_type: typing.Union[str, IResolvable]

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

Attribute PaymentType: Type of payment.

attr_ratio^Required

attr_ratio: typing.Union[str, IResolvable]

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

Attribute Ratio: 95 Billing guaranteed percentage.

Value range: 30~100.

attr_renewal_status^Required

attr_renewal_status: typing.Union[str, IResolvable]

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

Attribute RenewalStatus: Renewal status.

attr_resource_group_id^Required

attr_resource_group_id: typing.Union[str, IResolvable]

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

Attribute ResourceGroupId: The ID of the resource group.

attr_type^Required

attr_type: typing.Union[str, IResolvable]

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

Attribute Type: The type of the bandwidth package.

props^Required

props: BandwidthPackageProps

• Type: BandwidthPackageProps