CommonBandwidthPackage

• Implements: ros_cdk_vpc.datasource.ICommonBandwidthPackage

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::CommonBandwidthPackage.

Initializers

from ros_cdk_vpc import datasource
datasource.CommonBandwidthPackage(
  scope: Construct,
  id: str,
  common_bandwidth_package_id: typing.Union[str, IResolvable] = None,
  common_bandwidth_package_name: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

common_bandwidth_package_id^Optional

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

Property commonBandwidthPackageId: The ID of the Internet shared bandwidth.

common_bandwidth_package_name^Optional

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

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

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_vpc import datasource
datasource.CommonBandwidthPackage.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_bandwidth^Required

attr_bandwidth: typing.Union[str, IResolvable]

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

Attribute Bandwidth: The maximum bandwidth of the Internet Shared Bandwidth instance.

Unit: Mbit/s.

attr_business_status^Required

attr_business_status: typing.Union[str, IResolvable]

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

Attribute BusinessStatus: The service status of the Internet Shared Bandwidth instance.

Valid values: Normal: The Internet Shared Bandwidth instance runs as expected. FinancialLocked: An overdue payment occurs in the Internet Shared Bandwidth instance Unactivated: The Internet Shared Bandwidth instance is not activated.

attr_common_bandwidth_package_id^Required

attr_common_bandwidth_package_id: typing.Union[str, IResolvable]

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

Attribute CommonBandwidthPackageId: The ID of the Internet shared bandwidth.

attr_common_bandwidth_package_name^Required

attr_common_bandwidth_package_name: typing.Union[str, IResolvable]

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

Attribute CommonBandwidthPackageName: The name of the Internet Shared Bandwidth instance.

attr_creation_time^Required

attr_creation_time: typing.Union[str, IResolvable]

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

Attribute CreationTime: The time when the Internet Shared Bandwidth instance was created.

The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.

attr_deletion_protection^Required

attr_deletion_protection: typing.Union[str, IResolvable]

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

Attribute DeletionProtection: Indicates whether deletion protection is enabled.

Valid values: false true

attr_description^Required

attr_description: typing.Union[str, IResolvable]

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

Attribute Description: The description of the Internet Shared Bandwidth instance.

attr_expired_time^Required

attr_expired_time: typing.Union[str, IResolvable]

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

Attribute ExpiredTime: The time when the Internet Shared Bandwidth instance expired.

The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.

attr_has_reservation_data^Required

attr_has_reservation_data: typing.Union[str, IResolvable]

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

Attribute HasReservationData: Indicates whether the information about pending orders is returned.

Valid values: false true

attr_instance_charge_type^Required

attr_instance_charge_type: typing.Union[str, IResolvable]

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

Attribute InstanceChargeType: The billing method of the Internet Shared Bandwidth instance.

Valid value: PostPaid: pay-as-you-go PrePaid: subscription

attr_internet_charge_type^Required

attr_internet_charge_type: typing.Union[str, IResolvable]

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

Attribute InternetChargeType: The metering method of the Internet Shared Bandwidth instance.

Valid value: PayBy95: Charged by Enhanced 95th Percentile. PayByBandwidth: Charged by Bandwidth. PayByDominantTraffic: Charged by Dominant Traffic.

attr_isp^Required

attr_isp: typing.Union[str, IResolvable]

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

Attribute Isp: The line type.

Valid values: BGP (default): BGP (Multi-ISP) lines. BGP_PRO: BGP (Multi-ISP) Pro lines. Valid values if you are allowed to use single-ISP bandwidth: ChinaTelecom ChinaUnicom ChinaMobile ChinaTelecom_L2 ChinaUnicom_L2 ChinaMobile_L2

attr_public_ip_addresses^Required

attr_public_ip_addresses: typing.Union[str, IResolvable]

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

Attribute PublicIpAddresses: The elastic IP addresses (EIPs) that are associated with the Internet Shared Bandwidth instance.

attr_ratio^Required

attr_ratio: typing.Union[str, IResolvable]

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

Attribute Ratio: The percentage of the minimum bandwidth commitment.

Only 20 is returned.

attr_reservation_active_time^Required

attr_reservation_active_time: typing.Union[str, IResolvable]

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

Attribute ReservationActiveTime: The time when the renewal took effect.

The time is displayed in the YYYY-MM-DDThh:mm:ssZ format.

attr_reservation_bandwidth^Required

attr_reservation_bandwidth: typing.Union[str, IResolvable]

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

Attribute ReservationBandwidth: The new maximum bandwidth after the configurations are changed.

Unit: Mbit/s.

attr_reservation_internet_charge_type^Required

attr_reservation_internet_charge_type: typing.Union[str, IResolvable]

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

Attribute ReservationInternetChargeType: The metering method after the configurations are changed.

Valid value: PayBy95: Charged by Enhanced 95th Percentile. PayByBandwidth: Charged by Bandwidth. PayByDominantTraffic: Charged by Dominant Traffic.

attr_reservation_order_type^Required

attr_reservation_order_type: typing.Union[str, IResolvable]

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

Attribute ReservationOrderType: The renewal method.

Valid values: RENEWCHANGE: renewal with a specification change TEMP_UPGRADE: renewal with a temporary upgrade UPGRADE: renewal with an upgrade

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_service_managed^Required

attr_service_managed: typing.Union[str, IResolvable]

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

Attribute ServiceManaged: Indicates whether the resource is created by the service account.

Valid values: 0: The resource is not created by the service account. 1: The resource is created by the service account.

attr_status^Required

attr_status: typing.Union[str, IResolvable]

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

Attribute Status: The status of the Internet Shared Bandwidth instance.

Valid values: Available: The Internet Shared Bandwidth instance is available. Modifying: The Internet Shared Bandwidth instance is being modified.

props^Required

props: CommonBandwidthPackageProps

• Type: CommonBandwidthPackageProps