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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Describes a Capacity Reservation.

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zoneString

The Availability Zone in which the capacity is reserved.

Returns:

  • (String)


2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2615

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags)
  include Aws::Structure
end

#available_instance_countInteger

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

Returns:

  • (Integer)


2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2615

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags)
  include Aws::Structure
end

#capacity_reservation_idString

The ID of the Capacity Reservation.

Returns:

  • (String)


2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2615

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags)
  include Aws::Structure
end

#create_dateTime

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

Returns:

  • (Time)


2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2615

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags)
  include Aws::Structure
end

#ebs_optimizedBoolean

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)


2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2615

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags)
  include Aws::Structure
end

#end_dateTime

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)


2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2615

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags)
  include Aws::Structure
end

#end_date_typeString

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.

Returns:

  • (String)


2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2615

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags)
  include Aws::Structure
end

#ephemeral_storageBoolean

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

Returns:

  • (Boolean)


2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2615

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags)
  include Aws::Structure
end

#instance_match_criteriaString

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.

Returns:

  • (String)


2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2615

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags)
  include Aws::Structure
end

#instance_platformString

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

Returns:

  • (String)


2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2615

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags)
  include Aws::Structure
end

#instance_typeString

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

Returns:

  • (String)


2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2615

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags)
  include Aws::Structure
end

#stateString

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.

Returns:

  • (String)


2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2615

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags)
  include Aws::Structure
end

#tagsArray<Types::Tag>

Any tags assigned to the Capacity Reservation.

Returns:



2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2615

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags)
  include Aws::Structure
end

#tenancyString

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.

Returns:

  • (String)


2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2615

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags)
  include Aws::Structure
end

#total_instance_countInteger

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

Returns:

  • (Integer)


2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2615

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags)
  include Aws::Structure
end