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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateCapacityReservationRequest as input to an Aws::Client method, you can use a vanilla 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",
  availability_zone_id: "String",
  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, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  dry_run: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zone ⇒ String

The Availability Zone in which to create the Capacity Reservation.

Returns:

  • (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.

Returns:

  • (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. For more information, see How to Ensure Idempotency.

Returns:

  • (String) —

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

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

    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. 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) —

    Indicates whether the Capacity Reservation supports EBS-optimized instances.

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

Returns:

  • (Time) —

    The date and time at which the Capacity Reservation expires.

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

    Possible values:

    • unlimited
    • limited

Returns:

  • (String) —

    Indicates the way in which the Capacity Reservation ends.

#ephemeral_storage ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#instance_count ⇒ Integer

The number of instances for which to reserve capacity.

Returns:

  • (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. 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

Possible values:

  • open
  • targeted

Returns:

  • (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.

Possible values:

  • 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

Returns:

  • (String) —

    The type of operating system for which to reserve capacity.

#instance_type ⇒ String

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

Returns:

  • (String) —

    The instance type for which to reserve capacity.

#tag_specifications ⇒ Array<Types::TagSpecification>

The tags to apply to the Capacity Reservation during launch.

Returns:

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

  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

    Possible values:

    • default
    • dedicated

Returns:

  • (String) —

    Indicates the tenancy of the Capacity Reservation.