You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::CapacityReservation

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes a Capacity Reservation.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zone ⇒ String

The Availability Zone in which the capacity is reserved.

Returns:

  • (String) —

    The Availability Zone in which the capacity is reserved.

#availability_zone_id ⇒ String

The Availability Zone ID of the Capacity Reservation.

Returns:

  • (String) —

    The Availability Zone ID of the Capacity Reservation.

#available_instance_count ⇒ Integer

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

Returns:

  • (Integer) —

    The remaining capacity.

#capacity_reservation_arn ⇒ String

The Amazon Resource Name (ARN) of the Capacity Reservation.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the Capacity Reservation.

#capacity_reservation_id ⇒ String

The ID of the Capacity Reservation.

Returns:

  • (String) —

    The ID of the Capacity Reservation.

#create_date ⇒ Time

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

Returns:

  • (Time) —

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

#ebs_optimized ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Indicates whether the Capacity Reservation supports EBS-optimized instances.

#end_date ⇒ Time

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.

Returns:

  • (Time) —

    The date and time at which the Capacity Reservation expires.

#end_date_type ⇒ String

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.

    Possible values:

    • unlimited
    • limited

Returns:

  • (String) —

    Indicates the way in which the Capacity Reservation ends.

#ephemeral_storage ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#instance_match_criteria ⇒ String

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.

    Possible values:

    • open
    • targeted

Returns:

  • (String) —

    Indicates the type of instance launches that the Capacity Reservation accepts.

#instance_platform ⇒ String

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

Possible 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
  • Linux with SQL Server Standard
  • Linux with SQL Server Web
  • Linux with SQL Server Enterprise

Returns:

  • (String) —

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

#instance_type ⇒ String

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

Returns:

  • (String) —

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

#owner_id ⇒ String

The ID of the AWS account that owns the Capacity Reservation.

Returns:

  • (String) —

    The ID of the AWS account that owns the Capacity Reservation.

#state ⇒ String

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.

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

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

    Possible values:

    • active
    • expired
    • cancelled
    • pending
    • failed

Returns:

  • (String) —

    The current state of the Capacity Reservation.

#tags ⇒ Array<Types::Tag>

Any tags assigned to the Capacity Reservation.

Returns:

  • (Array<Types::Tag>) —

    Any tags assigned to the Capacity Reservation.

#tenancy ⇒ String

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.

    Possible values:

    • default
    • dedicated

Returns:

  • (String) —

    Indicates the tenancy of the Capacity Reservation.

#total_instance_count ⇒ Integer

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

Returns:

  • (Integer) —

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