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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #accept ⇒ Boolean

  Reserved.

• #accept_modification_terms ⇒ Boolean

  Indicates that you accept the modification terms of the quote identified by QuoteId.

• #additional_info ⇒ String

  Reserved for future use.

• #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_match_criteria ⇒ String

  The matching criteria (instance eligibility) that you want to use in the modified Capacity Reservation.

• #quote_id ⇒ String

  The ID of the quote that describes the modification you want to apply.

• #start_date ⇒ Time

  The new start date for the Capacity Reservation, in the ISO8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).

Instance Attribute Details

#accept ⇒ Boolean

Reserved. Capacity Reservations you have created are accepted by default.

Returns:

• (Boolean)

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

class ModifyCapacityReservationRequest < Struct.new(
  :capacity_reservation_id,
  :instance_count,
  :end_date,
  :end_date_type,
  :accept,
  :dry_run,
  :additional_info,
  :instance_match_criteria,
  :accept_modification_terms,
  :start_date,
  :quote_id)
  SENSITIVE = []
  include Aws::Structure
end

#accept_modification_terms ⇒ Boolean

Indicates that you accept the modification terms of the quote identified by QuoteId. To apply a quoted modification, set this parameter to true.

Returns:

• (Boolean)

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

class ModifyCapacityReservationRequest < Struct.new(
  :capacity_reservation_id,
  :instance_count,
  :end_date,
  :end_date_type,
  :accept,
  :dry_run,
  :additional_info,
  :instance_match_criteria,
  :accept_modification_terms,
  :start_date,
  :quote_id)
  SENSITIVE = []
  include Aws::Structure
end

#additional_info ⇒ String

Reserved for future use.

Returns:

• (String)

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

class ModifyCapacityReservationRequest < Struct.new(
  :capacity_reservation_id,
  :instance_count,
  :end_date,
  :end_date_type,
  :accept,
  :dry_run,
  :additional_info,
  :instance_match_criteria,
  :accept_modification_terms,
  :start_date,
  :quote_id)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_reservation_id ⇒ String

The ID of the Capacity Reservation.

Returns:

• (String)

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

class ModifyCapacityReservationRequest < Struct.new(
  :capacity_reservation_id,
  :instance_count,
  :end_date,
  :end_date_type,
  :accept,
  :dry_run,
  :additional_info,
  :instance_match_criteria,
  :accept_modification_terms,
  :start_date,
  :quote_id)
  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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 66843

class ModifyCapacityReservationRequest < Struct.new(
  :capacity_reservation_id,
  :instance_count,
  :end_date,
  :end_date_type,
  :accept,
  :dry_run,
  :additional_info,
  :instance_match_criteria,
  :accept_modification_terms,
  :start_date,
  :quote_id)
  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.

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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 66843

class ModifyCapacityReservationRequest < Struct.new(
  :capacity_reservation_id,
  :instance_count,
  :end_date,
  :end_date_type,
  :accept,
  :dry_run,
  :additional_info,
  :instance_match_criteria,
  :accept_modification_terms,
  :start_date,
  :quote_id)
  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 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 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 66843

class ModifyCapacityReservationRequest < Struct.new(
  :capacity_reservation_id,
  :instance_count,
  :end_date,
  :end_date_type,
  :accept,
  :dry_run,
  :additional_info,
  :instance_match_criteria,
  :accept_modification_terms,
  :start_date,
  :quote_id)
  SENSITIVE = []
  include Aws::Structure
end

#instance_count ⇒ Integer

The number of instances for which to reserve capacity. The number of instances can't be increased or decreased by more than 1000 in a single request.

Returns:

• (Integer)

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

class ModifyCapacityReservationRequest < Struct.new(
  :capacity_reservation_id,
  :instance_count,
  :end_date,
  :end_date_type,
  :accept,
  :dry_run,
  :additional_info,
  :instance_match_criteria,
  :accept_modification_terms,
  :start_date,
  :quote_id)
  SENSITIVE = []
  include Aws::Structure
end

#instance_match_criteria ⇒ String

The matching criteria (instance eligibility) that you want to use in the modified Capacity Reservation. If you change the instance eligibility of an existing Capacity Reservation from targeted to open, any running instances that match the attributes of the Capacity Reservation, have the CapacityReservationPreference set to open, and are not yet running in the Capacity Reservation, will automatically use the modified Capacity Reservation.

To modify the instance eligibility, the Capacity Reservation must be completely idle (zero usage).

Returns:

• (String)

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

class ModifyCapacityReservationRequest < Struct.new(
  :capacity_reservation_id,
  :instance_count,
  :end_date,
  :end_date_type,
  :accept,
  :dry_run,
  :additional_info,
  :instance_match_criteria,
  :accept_modification_terms,
  :start_date,
  :quote_id)
  SENSITIVE = []
  include Aws::Structure
end

#quote_id ⇒ String

The ID of the quote that describes the modification you want to apply. Generate a quote by using CreateCapacityReservationDateChangeQuote. The quote must be in the active state, and each quote can be used only once.

Returns:

• (String)

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

class ModifyCapacityReservationRequest < Struct.new(
  :capacity_reservation_id,
  :instance_count,
  :end_date,
  :end_date_type,
  :accept,
  :dry_run,
  :additional_info,
  :instance_match_criteria,
  :accept_modification_terms,
  :start_date,
  :quote_id)
  SENSITIVE = []
  include Aws::Structure
end

#start_date ⇒ Time

The new start date for the Capacity Reservation, in the ISO8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ). Applies to future-dated Capacity Reservations only. Requires a quote from CreateCapacityReservationDateChangeQuote; pass the quote ID in QuoteId with AcceptModificationTerms set to true.

Returns:

• (Time)

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

class ModifyCapacityReservationRequest < Struct.new(
  :capacity_reservation_id,
  :instance_count,
  :end_date,
  :end_date_type,
  :accept,
  :dry_run,
  :additional_info,
  :instance_match_criteria,
  :accept_modification_terms,
  :start_date,
  :quote_id)
  SENSITIVE = []
  include Aws::Structure
end