Skip to content

Modifies the Capacity Reservation settings for a stopped instance

Description

Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching attributes, run in On-Demand Instance capacity, or only run in a Capacity Reservation.

Usage

ec2_modify_instance_capacity_reservation_attributes(InstanceId,
  CapacityReservationSpecification, DryRun)

Arguments

  • InstanceId

    [required] The ID of the instance to be modified.

  • CapacityReservationSpecification

    [required] Information about the Capacity Reservation targeting option.

  • DryRun

    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.

Value

A list with the following syntax:

list(
  Return = TRUE|FALSE
)

Request syntax

svc$modify_instance_capacity_reservation_attributes(
  InstanceId = "string",
  CapacityReservationSpecification = list(
    CapacityReservationPreference = "capacity-reservations-only"|"open"|"none",
    CapacityReservationTarget = list(
      CapacityReservationId = "string",
      CapacityReservationResourceGroupArn = "string"
    )
  ),
  DryRun = TRUE|FALSE
)