Class: Aws::EC2::Types::ModifyCapacityReservationRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::ModifyCapacityReservationRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

Note:

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

{
  capacity_reservation_id: "String", # required
  instance_count: 1,
  end_date: Time.now,
  end_date_type: "unlimited", # accepts unlimited, limited
  dry_run: false,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #capacity_reservation_id ⇒ String

  The ID of the Capacity Reservation.

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

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

• #instance_count ⇒ Integer

  The number of instances for which to reserve capacity.

Instance Attribute Details

#capacity_reservation_id ⇒ String

The ID of the Capacity Reservation.

Returns:

• (String)

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

class ModifyCapacityReservationRequest < Struct.new(
  :capacity_reservation_id,
  :instance_count,
  :end_date,
  :end_date_type,
  :dry_run)
  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 24921

class ModifyCapacityReservationRequest < Struct.new(
  :capacity_reservation_id,
  :instance_count,
  :end_date,
  :end_date_type,
  :dry_run)
  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.

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.

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

Returns:

• (Time)

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

class ModifyCapacityReservationRequest < Struct.new(
  :capacity_reservation_id,
  :instance_count,
  :end_date,
  :end_date_type,
  :dry_run)
  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` value if `EndDateType` is `unlimited`.

• ‘limited` - The Capacity Reservation expires automatically at a specified date and time. You must provide an `EndDate` value if `EndDateType` is `limited`.

Returns:

• (String)

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

class ModifyCapacityReservationRequest < Struct.new(
  :capacity_reservation_id,
  :instance_count,
  :end_date,
  :end_date_type,
  :dry_run)
  include Aws::Structure
end

#instance_count ⇒ Integer

The number of instances for which to reserve capacity.

Returns:

• (Integer)

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

class ModifyCapacityReservationRequest < Struct.new(
  :capacity_reservation_id,
  :instance_count,
  :end_date,
  :end_date_type,
  :dry_run)
  include Aws::Structure
end