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

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

Overview

Note:

When making an API call, you may pass CreateCapacityReservationRequest data as a hash:

{
  client_token: "String",
  instance_type: "String", # required
  instance_platform: "Linux/UNIX", # required, accepts 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
  availability_zone: "String", # required
  tenancy: "default", # accepts default, dedicated
  instance_count: 1, # required
  ebs_optimized: false,
  ephemeral_storage: false,
  end_date: Time.now,
  end_date_type: "unlimited", # accepts unlimited, limited
  instance_match_criteria: "open", # accepts open, targeted
  tag_specifications: [
    {
      resource_type: "client-vpn-endpoint", # accepts client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, elastic-ip, fleet, fpga-image, image, instance, internet-gateway, launch-template, natgateway, network-acl, network-interface, reserved-instances, route-table, security-group, snapshot, spot-instances-request, subnet, transit-gateway, transit-gateway-attachment, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  dry_run: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zoneString

The Availability Zone in which to create the Capacity Reservation.

Returns:

  • (String)


4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
# File 'lib/aws-sdk-ec2/types.rb', line 4044

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run)
  include Aws::Structure
end

#client_tokenString

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

Constraint: Maximum 64 ASCII characters.

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

Returns:

  • (String)


4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
# File 'lib/aws-sdk-ec2/types.rb', line 4044

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


4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
# File 'lib/aws-sdk-ec2/types.rb', line 4044

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


4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
# File 'lib/aws-sdk-ec2/types.rb', line 4044

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


4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
# File 'lib/aws-sdk-ec2/types.rb', line 4044

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


4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
# File 'lib/aws-sdk-ec2/types.rb', line 4044

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run)
  include Aws::Structure
end

#ephemeral_storageBoolean

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

Returns:

  • (Boolean)


4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
# File 'lib/aws-sdk-ec2/types.rb', line 4044

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run)
  include Aws::Structure
end

#instance_countInteger

The number of instances for which to reserve capacity.

Returns:

  • (Integer)


4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
# File 'lib/aws-sdk-ec2/types.rb', line 4044

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


4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
# File 'lib/aws-sdk-ec2/types.rb', line 4044

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run)
  include Aws::Structure
end

#instance_platformString

The type of operating system for which to reserve capacity.

Returns:

  • (String)


4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
# File 'lib/aws-sdk-ec2/types.rb', line 4044

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run)
  include Aws::Structure
end

#instance_typeString

The instance type for which to reserve capacity. For more information, see [Instance Types] in the *Amazon Elastic Compute Cloud User Guide*.

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

Returns:

  • (String)


4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
# File 'lib/aws-sdk-ec2/types.rb', line 4044

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run)
  include Aws::Structure
end

#tag_specificationsArray<Types::TagSpecification>

The tags to apply to the Capacity Reservation during launch.

Returns:



4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
# File 'lib/aws-sdk-ec2/types.rb', line 4044

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


4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
# File 'lib/aws-sdk-ec2/types.rb', line 4044

class CreateCapacityReservationRequest < Struct.new(
  :client_token,
  :instance_type,
  :instance_platform,
  :availability_zone,
  :tenancy,
  :instance_count,
  :ebs_optimized,
  :ephemeral_storage,
  :end_date,
  :end_date_type,
  :instance_match_criteria,
  :tag_specifications,
  :dry_run)
  include Aws::Structure
end