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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zoneString

The Availability Zone in which to create the Capacity Reservation.

Returns:

  • (String)


7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7013

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)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone_idString

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

Returns:

  • (String)


7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7013

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)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

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

Returns:

  • (String)


7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7013

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)
  SENSITIVE = []
  include Aws::Structure
end

#dry_runBoolean

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)


7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7013

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)
  SENSITIVE = []
  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)


7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7013

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)
  SENSITIVE = []
  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.

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.

Returns:

  • (Time)


7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7013

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)
  SENSITIVE = []
  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. 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)


7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7013

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)
  SENSITIVE = []
  include Aws::Structure
end

#ephemeral_storageBoolean

Deprecated.

Returns:

  • (Boolean)


7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7013

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)
  SENSITIVE = []
  include Aws::Structure
end

#instance_countInteger

The number of instances for which to reserve capacity.

Valid range: 1 - 1000

Returns:

  • (Integer)


7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7013

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)
  SENSITIVE = []
  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 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.

Default: open

Returns:

  • (String)


7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7013

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)
  SENSITIVE = []
  include Aws::Structure
end

#instance_platformString

The type of operating system for which to reserve capacity.

Returns:

  • (String)


7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7013

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)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typeString

The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.

Returns:

  • (String)


7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7013

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)
  SENSITIVE = []
  include Aws::Structure
end

#outpost_arnString

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

Returns:

  • (String)


7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7013

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)
  SENSITIVE = []
  include Aws::Structure
end

#placement_group_arnString

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 in the Amazon EC2 User Guide.

Returns:

  • (String)


7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7013

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)
  SENSITIVE = []
  include Aws::Structure
end

#tag_specificationsArray<Types::TagSpecification>

The tags to apply to the Capacity Reservation during launch.

Returns:



7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7013

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)
  SENSITIVE = []
  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 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)


7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 7013

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)
  SENSITIVE = []
  include Aws::Structure
end