Skip to content

CapacityReservationProps

Properties for defining a CapacityReservation.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecs-capacityreservation

Initializer

import { CapacityReservationProps } from '@alicloud/ros-cdk-ecs'
const capacityReservationProps: CapacityReservationProps = { ... }

Properties

Name Type Description
instanceAmount number | @alicloud/ros-cdk-core.IResolvable Property instanceAmount: The total number of instances for which to reserve capacity of an instance type.
instanceType string | @alicloud/ros-cdk-core.IResolvable Property instanceType: The instance type.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The ID of zone N within the region in which to create the capacity reservation.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the capacity reservation.
endTime string | @alicloud/ros-cdk-core.IResolvable Property endTime: The time when the capacity reservation expires.
endTimeType string | @alicloud/ros-cdk-core.IResolvable Property endTimeType: The release mode of the capacity reservation.
privatePoolOptions @alicloud/ros-cdk-core.IResolvable | PrivatePoolOptionsProperty Property privatePoolOptions:.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group to which to assign the capacity reservation.
tags TagsProperty[] Property tags:.

instanceAmountRequired

public readonly instanceAmount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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


instanceTypeRequired

public readonly instanceType: string | IResolvable;
  • Type: string | @alicloud/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.


zoneIdRequired

public readonly zoneId: string | IResolvable;
  • Type: string | @alicloud/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.


descriptionOptional

public readonly description: string | IResolvable;
  • Type: string | @alicloud/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.


endTimeOptional

public readonly endTime: string | IResolvable;
  • Type: string | @alicloud/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.


endTimeTypeOptional

public readonly endTimeType: string | IResolvable;
  • Type: string | @alicloud/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.


privatePoolOptionsOptional

public readonly privatePoolOptions: IResolvable | PrivatePoolOptionsProperty;

Property privatePoolOptions:.


resourceGroupIdOptional

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


tagsOptional

public readonly tags: TagsProperty[];

Property tags:.