Skip to content

ElasticityAssurance

This class encapsulates and extends the ROS resource type ALIYUN::ECS::ElasticityAssurance, which is used to create an elasticity assurance.

Initializers

import ros_cdk_ecs
ros_cdk_ecs.ElasticityAssurance(
  scope: Construct,
  id: str,
  instance_amount: typing.Union[typing.Union[int, float], IResolvable],
  instance_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  zone_id: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  private_pool_options: typing.Union[IResolvable, PrivatePoolOptionsProperty] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  start_time: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
instance_amount typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property instanceAmount: The total number of instances for which to reserve capacity of an instance type.
instance_types typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property instanceTypes: Instance type.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The zone ID of the elasticity assurance.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the elasticity assurance.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: The effective duration of the elasticity assurance.
period_unit typing.Union[str, ros_cdk_core.IResolvable] Property periodUnit: The unit of the effective duration of the elasticity assurance.
private_pool_options typing.Union[ros_cdk_core.IResolvable, PrivatePoolOptionsProperty] Property privatePoolOptions:.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group to which to assign the elasticity assurance.
start_time typing.Union[str, ros_cdk_core.IResolvable] Property startTime: The time when the elasticity assurance takes effect.
tags typing.List[TagsProperty] Property tags:.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

instance_amountRequired

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

Property instanceAmount: The total number of instances for which to reserve capacity of an instance type.

Valid values: 1 to 1000.


instance_typesRequired

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

Property instanceTypes: Instance type.

Currently, an elasticity assurance can be created to reserve the capacity of a single instance type.


zone_idRequired

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

Property zoneId: The zone ID of the elasticity assurance.

Currently, an elasticity assurance can be used to reserve resources within a single zone.


descriptionOptional

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

Property description: The description of the elasticity assurance.

The description must be 2 to 256 characters in length and cannot start with http:// or https://. This parameter is empty by default.


periodOptional

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

Property period: The effective duration of the elasticity assurance.

The unit of the effective duration is determined by the PeriodUnit value. Valid values: When the PeriodUnit parameter is set to Month, the valid values are 1, 2, 3, 4, 5, 6, 7, 8, and 9. When the PeriodUnit parameter is set to Year, the valid values are 1, 2, 3, 4, and 5. Default value: 1.


period_unitOptional

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

Property periodUnit: The unit of the effective duration of the elasticity assurance.

Valid values: Month Year Default value: Year.


private_pool_optionsOptional

Property privatePoolOptions:.


resource_group_idOptional

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

Property resourceGroupId: The ID of the resource group to which to assign the elasticity assurance.


start_timeOptional

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

Property startTime: The time when the elasticity assurance takes effect.

The default value is the time when the CreateElasticityAssurance operation is called to create the elasticity assurance. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. For more information, see ISO 8601.


tagsOptional

Property tags:.


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_ecs
ros_cdk_ecs.ElasticityAssurance.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_private_pool_options_id ros_cdk_core.IResolvable Attribute PrivatePoolOptionsId: The ID of the elasticity assurance.

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_private_pool_options_idRequired

attr_private_pool_options_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PrivatePoolOptionsId: The ID of the elasticity assurance.