CapacityReservation

This class encapsulates and extends the ROS resource type ALIYUN::ECS::CapacityReservation, which is used to create a capacity reservation.

Initializers

import ros_cdk_ecs
ros_cdk_ecs.CapacityReservation(
  scope: Construct,
  id: str,
  instance_amount: typing.Union[typing.Union[int, float], IResolvable],
  instance_type: typing.Union[str, IResolvable],
  zone_id: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  end_time: typing.Union[str, IResolvable] = None,
  end_time_type: typing.Union[str, IResolvable] = None,
  private_pool_options: typing.Union[IResolvable, PrivatePoolOptionsProperty] = None,
  resource_group_id: 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_type	typing.Union[str, ros_cdk_core.IResolvable]	Property instanceType: The instance type.
zone_id	typing.Union[str, ros_cdk_core.IResolvable]	Property zoneId: The ID of zone N within the region in which to create the capacity reservation.
description	typing.Union[str, ros_cdk_core.IResolvable]	Property description: The description of the capacity reservation.
end_time	typing.Union[str, ros_cdk_core.IResolvable]	Property endTime: The time when the capacity reservation expires.
end_time_type	typing.Union[str, ros_cdk_core.IResolvable]	Property endTimeType: The release mode of the capacity reservation.
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 capacity reservation.
tags	typing.List[TagsProperty]	Property tags:.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

instance_amount^Required

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

---

instance_type^Required

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

Property instanceType: The instance type.

A capacity reservation can be created to reserve the capacity of only a single instance type. You can call the DescribeInstanceTypes operation to query the instance types provided by ECS.

---

zone_id^Required

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

Property zoneId: The ID of zone N within the region in which to create the capacity reservation.

A capacity reservation can reserve resources within only a single zone.

---

description^Optional

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

Property description: The description of the capacity reservation.

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

---

end_time^Optional

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

Property endTime: The time when the capacity reservation expires.

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.

---

end_time_type^Optional

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

Property endTimeType: The release mode of the capacity reservation.

Valid values: Limited: The capacity reservation is automatically released at the specified time. If you specify this parameter, you must also specify the EndTime parameter. Unlimited: The capacity reservation must be manually released. You can release it anytime.

---

private_pool_options^Optional

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

Property privatePoolOptions:.

---

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group to which to assign the capacity reservation.

---

tags^Optional

• Type: typing.List[TagsProperty]

Property tags:.

---

enable_resource_property_constraint^Optional

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

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

---

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

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

import ros_cdk_ecs
ros_cdk_ecs.CapacityReservation.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• 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 capacity reservation.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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

attr_private_pool_options_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute PrivatePoolOptionsId: The ID of the capacity reservation.

---