Skip to content

BandwidthPackage

This class encapsulates and extends the ROS resource type DATASOURCE::GA::BandwidthPackage, which is used to query the information about a bandwidth plan.

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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
bandwidth_package_id typing.Union[str, ros_cdk_core.IResolvable] Property bandwidthPackageId: The Resource ID of the bandwidth.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

bandwidth_package_idRequired

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

Property bandwidthPackageId: The Resource ID of the bandwidth.

refresh_optionsOptional

  • 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_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.
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

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 

from ros_cdk_ga import datasource
datasource.BandwidthPackage.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.
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_auto_renew ros_cdk_core.IResolvable Attribute AutoRenew: Whether to enable automatic renewal.
attr_auto_renew_duration ros_cdk_core.IResolvable Attribute AutoRenewDuration: The duration of automatic renewal.
attr_bandwidth ros_cdk_core.IResolvable Attribute Bandwidth: The bandwidth value of the bandwidth package.
attr_bandwidth_package_id ros_cdk_core.IResolvable Attribute BandwidthPackageId: The Resource ID of the bandwidth.
attr_bandwidth_package_name ros_cdk_core.IResolvable Attribute BandwidthPackageName: The Resource name of the bandwidth.
attr_bandwidth_type ros_cdk_core.IResolvable Attribute BandwidthType: Bandwidth type.
attr_billing_type ros_cdk_core.IResolvable Attribute BillingType: Post-payment billing method.
attr_cbn_geographic_region_id_a ros_cdk_core.IResolvable Attribute CbnGeographicRegionIdA: The interworking region A of cross-region acceleration packages.
attr_cbn_geographic_region_id_b ros_cdk_core.IResolvable Attribute CbnGeographicRegionIdB: The interworking Region B of cross-region acceleration packages.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: Bandwidth package creation time.
attr_description ros_cdk_core.IResolvable Attribute Description: the description of bandwidth package.
attr_expired_time ros_cdk_core.IResolvable Attribute ExpiredTime: Bandwidth package expiration time.
attr_payment_type ros_cdk_core.IResolvable Attribute PaymentType: Type of payment.
attr_ratio ros_cdk_core.IResolvable Attribute Ratio: 95 Billing guaranteed percentage.
attr_renewal_status ros_cdk_core.IResolvable Attribute RenewalStatus: Renewal status.
attr_resource_group_id ros_cdk_core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attr_type ros_cdk_core.IResolvable Attribute Type: The type of the bandwidth package.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

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_auto_renewRequired 

attr_auto_renew: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AutoRenew: Whether to enable automatic renewal.

attr_auto_renew_durationRequired 

attr_auto_renew_duration: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AutoRenewDuration: The duration of automatic renewal.

Unit: Month.

attr_bandwidthRequired 

attr_bandwidth: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Bandwidth: The bandwidth value of the bandwidth package.

Unit: Mbps. Value range: 2~2000.

attr_bandwidth_package_idRequired 

attr_bandwidth_package_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BandwidthPackageId: The Resource ID of the bandwidth.

attr_bandwidth_package_nameRequired 

attr_bandwidth_package_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BandwidthPackageName: The Resource name of the bandwidth.

attr_bandwidth_typeRequired 

attr_bandwidth_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BandwidthType: Bandwidth type.

attr_billing_typeRequired 

attr_billing_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BillingType: Post-payment billing method.

attr_cbn_geographic_region_id_aRequired 

attr_cbn_geographic_region_id_a: IResolvable
  • Type: 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_bRequired 

attr_cbn_geographic_region_id_b: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CbnGeographicRegionIdB: The interworking Region B of cross-region acceleration packages.

The value is Global only.

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: Bandwidth package creation time.

attr_descriptionRequired 

attr_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Description: the description of bandwidth package.

attr_expired_timeRequired 

attr_expired_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ExpiredTime: Bandwidth package expiration time.

attr_payment_typeRequired 

attr_payment_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PaymentType: Type of payment.

attr_ratioRequired 

attr_ratio: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Ratio: 95 Billing guaranteed percentage.

Value range: 30~100.

attr_renewal_statusRequired 

attr_renewal_status: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RenewalStatus: Renewal status.

attr_resource_group_idRequired 

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attr_typeRequired 

attr_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Type: The type of the bandwidth package.