Class: Aws::EC2::Types::ModifyCapacityReservationFleetRequest

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

Overview

Note:

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

{
  capacity_reservation_fleet_id: "CapacityReservationFleetId", # required
  total_target_capacity: 1,
  end_date: Time.now,
  dry_run: false,
  remove_end_date: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_reservation_fleet_idString

The ID of the Capacity Reservation Fleet to modify.

Returns:

  • (String)


47589
47590
47591
47592
47593
47594
47595
47596
47597
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47589

class ModifyCapacityReservationFleetRequest < Struct.new(
  :capacity_reservation_fleet_id,
  :total_target_capacity,
  :end_date,
  :dry_run,
  :remove_end_date)
  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)


47589
47590
47591
47592
47593
47594
47595
47596
47597
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47589

class ModifyCapacityReservationFleetRequest < Struct.new(
  :capacity_reservation_fleet_id,
  :total_target_capacity,
  :end_date,
  :dry_run,
  :remove_end_date)
  SENSITIVE = []
  include Aws::Structure
end

#end_dateTime

The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.

The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019.

You can't specify EndDate and RemoveEndDate in the same request.

Returns:

  • (Time)


47589
47590
47591
47592
47593
47594
47595
47596
47597
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47589

class ModifyCapacityReservationFleetRequest < Struct.new(
  :capacity_reservation_fleet_id,
  :total_target_capacity,
  :end_date,
  :dry_run,
  :remove_end_date)
  SENSITIVE = []
  include Aws::Structure
end

#remove_end_dateBoolean

Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly cancel it using the CancelCapacityReservationFleet action.

You can't specify RemoveEndDate and EndDate in the same request.

Returns:

  • (Boolean)


47589
47590
47591
47592
47593
47594
47595
47596
47597
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47589

class ModifyCapacityReservationFleetRequest < Struct.new(
  :capacity_reservation_fleet_id,
  :total_target_capacity,
  :end_date,
  :dry_run,
  :remove_end_date)
  SENSITIVE = []
  include Aws::Structure
end

#total_target_capacityInteger

The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the Amazon EC2 User Guide.

Returns:

  • (Integer)


47589
47590
47591
47592
47593
47594
47595
47596
47597
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 47589

class ModifyCapacityReservationFleetRequest < Struct.new(
  :capacity_reservation_fleet_id,
  :total_target_capacity,
  :end_date,
  :dry_run,
  :remove_end_date)
  SENSITIVE = []
  include Aws::Structure
end