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

Inherits:

Struct

Object
Struct
Aws::EC2::Types::CapacityReservation

show all

Includes:: Structure

Defined in:: lib/aws-sdk-ec2/types.rb

Overview

Describes a Capacity Reservation.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#availability_zone ⇒ String

The Availability Zone in which the capacity is reserved.
#availability_zone_id ⇒ String

The Availability Zone ID of the Capacity Reservation.
#available_instance_count ⇒ Integer

The remaining capacity.
#capacity_allocations ⇒ Array<Types::CapacityAllocation>

Information about instance capacity usage.
#capacity_reservation_arn ⇒ String

The Amazon Resource Name (ARN) of the Capacity Reservation.
#capacity_reservation_fleet_id ⇒ String

The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs.
#capacity_reservation_id ⇒ String

The ID of the Capacity Reservation.
#commitment_info ⇒ Types::CapacityReservationCommitmentInfo

Information about your commitment for a future-dated Capacity Reservation.
#create_date ⇒ Time

The date and time at which the Capacity Reservation was created.
#delivery_preference ⇒ String

The delivery method for a future-dated Capacity Reservation.
#ebs_optimized ⇒ Boolean

Indicates whether the Capacity Reservation supports EBS-optimized instances.
#end_date ⇒ Time

The date and time at which the Capacity Reservation expires.
#end_date_type ⇒ String

Indicates the way in which the Capacity Reservation ends.
#ephemeral_storage ⇒ Boolean

Deprecated..
#instance_match_criteria ⇒ 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.
#instance_type ⇒ String

The type of instance for which the Capacity Reservation reserves capacity.
#outpost_arn ⇒ String

The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
#owner_id ⇒ String

The ID of the Amazon Web Services account that owns the Capacity Reservation.
#placement_group_arn ⇒ String

The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created.
#reservation_type ⇒ String

The type of Capacity Reservation.
#start_date ⇒ Time

The date and time at which the Capacity Reservation was started.
#state ⇒ String

The current state of the Capacity Reservation.
#tags ⇒ Array<Types::Tag>

Any tags assigned to the Capacity Reservation.
#tenancy ⇒ String

Indicates the tenancy of the Capacity Reservation.
#total_instance_count ⇒ Integer

The total number of instances for which the Capacity Reservation reserves capacity.
#unused_reservation_billing_owner_id ⇒ String

The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned.

Instance Attribute Details

#availability_zone ⇒ `String`

The Availability Zone in which the capacity is reserved.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_id ⇒ `String`

The Availability Zone ID of the Capacity Reservation.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#available_instance_count ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_allocations ⇒ `Array<Types::CapacityAllocation>`

Information about instance capacity usage.

Returns:

(Array<Types::CapacityAllocation>)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_reservation_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_reservation_fleet_id ⇒ `String`

The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_reservation_id ⇒ `String`

The ID of the Capacity Reservation.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#commitment_info ⇒ `Types::CapacityReservationCommitmentInfo`

Information about your commitment for a future-dated Capacity Reservation.

Returns:

(Types::CapacityReservationCommitmentInfo)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#create_date ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_preference ⇒ `String`

The delivery method for a future-dated Capacity Reservation. ‘incremental` indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#ephemeral_storage ⇒ `Boolean`

Deprecated.

Returns:

(Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#instance_platform ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#outpost_arn ⇒ `String`

The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#owner_id ⇒ `String`

The ID of the Amazon Web Services account that owns the Capacity Reservation.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#placement_group_arn ⇒ `String`

The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see [ Capacity Reservations for cluster placement groups] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#reservation_type ⇒ `String`

The type of Capacity Reservation.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#start_date ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ `String`

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

‘active` - The capacity is available for use.
‘expired` - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
‘cancelled` - The Capacity Reservation was canceled. 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 can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
‘scheduled` - (*Future-dated Capacity Reservations only*) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
‘assessing` - (*Future-dated Capacity Reservations only*) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
‘delayed` - (*Future-dated Capacity Reservations only*) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
‘unsupported` - (*Future-dated Capacity Reservations only*) Amazon EC2 can’t support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

Any tags assigned to the Capacity Reservation.

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#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 Amazon Web Services accounts.
‘dedicated` - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#total_instance_count ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#unused_reservation_billing_owner_id ⇒ `String`

The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned.

Returns:

(String)

# File 'lib/aws-sdk-ec2/types.rb', line 5120

class CapacityReservation < Struct.new(
  :capacity_reservation_id,
  :owner_id,
  :capacity_reservation_arn,
  :availability_zone_id,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :total_instance_count,
  :available_instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :state,
  :start_date,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :create_date,
  :tags,
  :outpost_arn,
  :capacity_reservation_fleet_id,
  :placement_group_arn,
  :capacity_allocations,
  :reservation_type,
  :unused_reservation_billing_owner_id,
  :commitment_info,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zone ⇒ String

#availability_zone_id ⇒ String

#available_instance_count ⇒ Integer

#capacity_allocations ⇒ Array<Types::CapacityAllocation>

#capacity_reservation_arn ⇒ String

#capacity_reservation_fleet_id ⇒ String

#capacity_reservation_id ⇒ String

#commitment_info ⇒ Types::CapacityReservationCommitmentInfo

#create_date ⇒ Time

#delivery_preference ⇒ String

#ebs_optimized ⇒ Boolean

#end_date ⇒ Time

#end_date_type ⇒ String

#ephemeral_storage ⇒ Boolean

#instance_match_criteria ⇒ String

#instance_platform ⇒ String

#instance_type ⇒ String

#outpost_arn ⇒ String

#owner_id ⇒ String

#placement_group_arn ⇒ String

#reservation_type ⇒ String

#start_date ⇒ Time

#state ⇒ String

#tags ⇒ Array<Types::Tag>

#tenancy ⇒ String

#total_instance_count ⇒ Integer

#unused_reservation_billing_owner_id ⇒ String

#availability_zone ⇒ `String`

#availability_zone_id ⇒ `String`

#available_instance_count ⇒ `Integer`

#capacity_allocations ⇒ `Array<Types::CapacityAllocation>`

#capacity_reservation_arn ⇒ `String`

#capacity_reservation_fleet_id ⇒ `String`

#capacity_reservation_id ⇒ `String`

#commitment_info ⇒ `Types::CapacityReservationCommitmentInfo`

#create_date ⇒ `Time`

#delivery_preference ⇒ `String`

#ebs_optimized ⇒ `Boolean`

#end_date ⇒ `Time`

#end_date_type ⇒ `String`

#ephemeral_storage ⇒ `Boolean`

#instance_match_criteria ⇒ `String`

#instance_platform ⇒ `String`

#instance_type ⇒ `String`

#outpost_arn ⇒ `String`

#owner_id ⇒ `String`

#placement_group_arn ⇒ `String`

#reservation_type ⇒ `String`

#start_date ⇒ `Time`

#state ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#tenancy ⇒ `String`

#total_instance_count ⇒ `Integer`

#unused_reservation_billing_owner_id ⇒ `String`