Class: Aws::EC2::Types::CreateCapacityReservationRequest

Inherits:

Struct

Object
Struct
Aws::EC2::Types::CreateCapacityReservationRequest

show all

Includes:: Structure

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

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#availability_zone ⇒ String

The Availability Zone in which to create the Capacity Reservation.
#availability_zone_id ⇒ String

The ID of the Availability Zone in which to create the Capacity Reservation.
#client_token ⇒ String

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
#commitment_duration ⇒ Integer

<note markdown=“1”> Required for future-dated Capacity Reservations only.
#delivery_preference ⇒ String

<note markdown=“1”> Required for future-dated Capacity Reservations only.
#dry_run ⇒ Boolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
#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_count ⇒ Integer

The number of instances for which to reserve capacity.
#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 to reserve capacity.
#instance_type ⇒ String

The instance type for which to reserve capacity.
#outpost_arn ⇒ String

<note markdown=“1”> Not supported for future-dated Capacity Reservations.
#placement_group_arn ⇒ String

<note markdown=“1”> Not supported for future-dated Capacity Reservations.
#start_date ⇒ Time

<note markdown=“1”> Required for future-dated Capacity Reservations only.
#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the Capacity Reservation during launch.
#tenancy ⇒ String

Indicates the tenancy of the Capacity Reservation.

Instance Attribute Details

#availability_zone ⇒ `String`

The Availability Zone in which to create the Capacity Reservation.

Returns:

(String)

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

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_id ⇒ `String`

The ID of the Availability Zone in which to create the Capacity Reservation.

Returns:

(String)

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

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ `String`

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensure Idempotency].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

(String)

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

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#commitment_duration ⇒ `Integer`

<note markdown=“1”> Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

</note>

Specify a commitment duration, in seconds, for the future-dated Capacity Reservation.

The commitment duration is a minimum duration for which you commit to having the future-dated Capacity Reservation in the ‘active` state in your account after it has been delivered.

For more information, see [ Commitment duration].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-concepts.html#cr-commitment-duration

Returns:

(Integer)

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

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_preference ⇒ `String`

<note markdown=“1”> Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

</note>

Indicates that the requested capacity will be delivered in addition to any running instances or reserved capacity that you have in your account at the requested date and time.

The only supported value is ‘incremental`.

Returns:

(String)

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

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ `Boolean`

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ‘DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.

Returns:

(Boolean)

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

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :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 7981

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :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.

You must provide an ‘EndDate` value if `EndDateType` is `limited`. Omit `EndDate` if `EndDateType` is `unlimited`.

If the ‘EndDateType` is `limited`, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

If you are requesting a future-dated Capacity Reservation, you can’t specify an end date and time that is within the commitment duration.

Returns:

(Time)

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

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :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. Do not provide an `EndDate` if the `EndDateType` is `unlimited`.
‘limited` - The Capacity Reservation expires automatically at a specified date and time. You must provide an `EndDate` value if the `EndDateType` value is `limited`.

Returns:

(String)

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

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#ephemeral_storage ⇒ `Boolean`

Deprecated.

Returns:

(Boolean)

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

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#instance_count ⇒ `Integer`

The number of instances for which to reserve capacity.

<note markdown=“1”> You can request future-dated Capacity Reservations for an instance count with a minimum of 100 vCPUs. For example, if you request a future-dated Capacity Reservation for ‘m5.xlarge` instances, you must request at least 25 instances (*25 * m5.xlarge = 100 vCPUs*).

</note>

Valid range: 1 - 1000

Returns:

(Integer)

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

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :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 automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in 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.

<note markdown=“1”> If you are requesting a future-dated Capacity Reservation, you must specify ‘targeted`.

</note>

Default: ‘open`

Returns:

(String)

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

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#instance_platform ⇒ `String`

The type of operating system for which to reserve capacity.

Returns:

(String)

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

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ `String`

The instance type for which to reserve capacity.

<note markdown=“1”> You can request future-dated Capacity Reservations for instance types in the C, M, R, I, and T instance families only.

</note>

For more information, see [Instance types] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html

Returns:

(String)

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

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#outpost_arn ⇒ `String`

<note markdown=“1”> Not supported for future-dated Capacity Reservations.

</note>

The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.

Returns:

(String)

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

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#placement_group_arn ⇒ `String`

<note markdown=“1”> Not supported for future-dated Capacity Reservations.

</note>

The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see

Capacity Reservations for cluster placement groups][1: 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 7981

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#start_date ⇒ `Time`

<note markdown=“1”> Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

</note>

The date and time at which the future-dated Capacity Reservation should become available for use, in the ISO8601 format in the UTC time zone (‘YYYY-MM-DDThh:mm:ss.sssZ`).

You can request a future-dated Capacity Reservation between 5 and 120 days in advance.

Returns:

(Time)

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

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specifications ⇒ `Array<Types::TagSpecification>`

The tags to apply to the Capacity Reservation during launch.

Returns:

(Array<Types::TagSpecification>)

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

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :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 7981

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :availability_zone_id,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run,
  :outpost_arn,
  :placement_group_arn,
  :start_date,
  :commitment_duration,
  :delivery_preference)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::EC2::Types::CreateCapacityReservationRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zone ⇒ String

#availability_zone_id ⇒ String

#client_token ⇒ String

#commitment_duration ⇒ Integer

#delivery_preference ⇒ String

#dry_run ⇒ Boolean

#ebs_optimized ⇒ Boolean

#end_date ⇒ Time

#end_date_type ⇒ String

#ephemeral_storage ⇒ Boolean

#instance_count ⇒ Integer

#instance_match_criteria ⇒ String

#instance_platform ⇒ String

#instance_type ⇒ String

#outpost_arn ⇒ String

#placement_group_arn ⇒ String

#start_date ⇒ Time

#tag_specifications ⇒ Array<Types::TagSpecification>

#tenancy ⇒ String

#availability_zone ⇒ `String`

#availability_zone_id ⇒ `String`

#client_token ⇒ `String`

#commitment_duration ⇒ `Integer`

#delivery_preference ⇒ `String`

#dry_run ⇒ `Boolean`

#ebs_optimized ⇒ `Boolean`

#end_date ⇒ `Time`

#end_date_type ⇒ `String`

#ephemeral_storage ⇒ `Boolean`

#instance_count ⇒ `Integer`

#instance_match_criteria ⇒ `String`

#instance_platform ⇒ `String`

#instance_type ⇒ `String`

#outpost_arn ⇒ `String`

#placement_group_arn ⇒ `String`

#start_date ⇒ `Time`

#tag_specifications ⇒ `Array<Types::TagSpecification>`

#tenancy ⇒ `String`