Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

CapacityReservation

Describes a Capacity Reservation.

Contents

availabilityZone

The Availability Zone in which the capacity is reserved.

Type: String

Required: No

availableInstanceCount

The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

Type: Integer

Required: No

capacityReservationId

The ID of the Capacity Reservation.

Type: String

Required: No

createDate

The date and time at which the Capacity Reservation was created.

Type: Timestamp

Required: No

ebsOptimized

Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.

Type: Boolean

Required: No

endDate

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

Type: Timestamp

Required: No

endDateType

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

  • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

  • limited - The Capacity Reservation expires automatically at a specified date and time.

Type: String

Valid Values: unlimited | limited

Required: No

ephemeralStorage

Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.

Type: Boolean

Required: No

instanceMatchCriteria

Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

  • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

  • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

Type: String

Valid Values: open | targeted

Required: No

instancePlatform

The type of operating system for which the Capacity Reservation reserves capacity.

Type: String

Valid Values: Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Windows with SQL Server | Windows with SQL Server Enterprise | Windows with SQL Server Standard | Windows with SQL Server Web

Required: No

instanceType

The type of instance for which the Capacity Reservation reserves capacity.

Type: String

Required: No

state

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

  • active - The Capacity Reservation is active and the capacity is available for your use.

  • cancelled - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

  • expired - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.

  • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

  • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

Type: String

Valid Values: active | expired | cancelled | pending | failed

Required: No

tagSet

Any tags assigned to the Capacity Reservation.

Type: Array of Tag objects

Required: No

tenancy

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

  • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

Type: String

Valid Values: default | dedicated

Required: No

totalInstanceCount

The number of instances for which the Capacity Reservation reserves capacity.

Type: Integer

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: