Skip to content

ResourcePackage

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

Initializers

import ros_cdk_bss
ros_cdk_bss.ResourcePackage(
  scope: Construct,
  id: str,
  duration: typing.Union[typing.Union[int, float], IResolvable],
  package_type: typing.Union[str, IResolvable],
  product_code: typing.Union[str, IResolvable],
  specification: typing.Union[str, IResolvable],
  effective_date: typing.Union[str, IResolvable] = None,
  pricing_cycle: 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.
duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property duration: The validity of the specified resource package.
package_type typing.Union[str, ros_cdk_core.IResolvable] Property packageType: The type of the specified resource package.
product_code typing.Union[str, ros_cdk_core.IResolvable] Property productCode: The code of the specified product.
specification typing.Union[str, ros_cdk_core.IResolvable] Property specification: The size of the specified resource package.
effective_date typing.Union[str, ros_cdk_core.IResolvable] Property effectiveDate: The effective date of the specified resource package.
pricing_cycle typing.Union[str, ros_cdk_core.IResolvable] Property pricingCycle: The validity of the specified resource package.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

durationRequired

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

Property duration: The validity of the specified resource package.

The value is the same as the Value of AvailableDuration returned by DescribeResourcePackageProduct.


package_typeRequired

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

Property packageType: The type of the specified resource package.

The value is the same as the value of the Code value of the ResourcePackage object returned by DescribeResourcePackageProduct.


product_codeRequired

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

Property productCode: The code of the specified product.

The value is the same as the value of ProductType returned by QueryProductList.


specificationRequired

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

Property specification: The size of the specified resource package.

The value is the same as the Value of Specification returned by DescribeResourcePackageProduct.


effective_dateOptional

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

Property effectiveDate: The effective date of the specified resource package.

The resource package will take effect immediately if the effective date is unspecified. The date format follows the ISO8601 standard and uses UTC time. Format: yyyy-MM-ddTHH:mm:ssZ


pricing_cycleOptional

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

Property pricingCycle: The validity of the specified resource package.

Default value: Month. Valid values: Month, Year


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

import ros_cdk_bss
ros_cdk_bss.ResourcePackage.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_instance_id ros_cdk_core.IResolvable Attribute InstanceId: The ID of the specified instance.
attr_order_id ros_cdk_core.IResolvable Attribute OrderId: The ID of the specified order.

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_instance_idRequired

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: The ID of the specified instance.


attr_order_idRequired

attr_order_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OrderId: The ID of the specified order.