Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ec2
  5. getCapacityReservation

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.ec2.getCapacityReservation

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::EC2::CapacityReservation

    Using getCapacityReservation

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCapacityReservation(args: GetCapacityReservationArgs, opts?: InvokeOptions): Promise<GetCapacityReservationResult>
function getCapacityReservationOutput(args: GetCapacityReservationOutputArgs, opts?: InvokeOptions): Output<GetCapacityReservationResult>
    def get_capacity_reservation(id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetCapacityReservationResult
def get_capacity_reservation_output(id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetCapacityReservationResult]
    func LookupCapacityReservation(ctx *Context, args *LookupCapacityReservationArgs, opts ...InvokeOption) (*LookupCapacityReservationResult, error)
func LookupCapacityReservationOutput(ctx *Context, args *LookupCapacityReservationOutputArgs, opts ...InvokeOption) LookupCapacityReservationResultOutput

    > Note: This function is named LookupCapacityReservation in the Go SDK.

    public static class GetCapacityReservation 
{
    public static Task<GetCapacityReservationResult> InvokeAsync(GetCapacityReservationArgs args, InvokeOptions? opts = null)
    public static Output<GetCapacityReservationResult> Invoke(GetCapacityReservationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCapacityReservationResult> getCapacityReservation(GetCapacityReservationArgs args, InvokeOptions options)
public static Output<GetCapacityReservationResult> getCapacityReservation(GetCapacityReservationArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:ec2:getCapacityReservation
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of the Capacity Reservation.
    Id string
    The ID of the Capacity Reservation.
    id String
    The ID of the Capacity Reservation.
    id string
    The ID of the Capacity Reservation.
    id str
    The ID of the Capacity Reservation.
    id String
    The ID of the Capacity Reservation.

    getCapacityReservation Result

    The following output properties are available:

    AvailableInstanceCount int
    Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation. For example: 9 .
    CapacityAllocationSet List<Pulumi.AwsNative.Ec2.Outputs.CapacityReservationCapacityAllocation>
    CapacityReservationArn string
    The Amazon Resource Name (ARN) of the Capacity Reservation.
    CapacityReservationFleetId string
    The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
    CommitmentInfo Pulumi.AwsNative.Ec2.Outputs.CommitmentInfoProperties
    CreateDate string
    The date and time at which the Capacity Reservation was created.
    DeliveryPreference string
    The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.
    EndDate string

    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.

    If you are requesting a future-dated Capacity Reservation, you can't specify an end date and time that is within the commitment duration.

    EndDateType 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 .
    Id string
    The ID of the Capacity Reservation.
    InstanceCount int

    The number of instances for which to reserve capacity.

    You can request future-dated Capacity Reservations for an instance count with a minimum of 100 vCPUs. For example, if you request a future-dated Capacity Reservation for m5.xlarge instances, you must request at least 25 instances ( 25 * m5.xlarge = 100 vCPUs ).

    Valid range: 1 - 1000

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

    If you are requesting a future-dated Capacity Reservation, you must specify targeted .

    Default: open

    OwnerId string
    The ID of the AWS account that owns the Capacity Reservation.
    ReservationType string
    The type of Capacity Reservation.
    StartDate string
    The date and time at which the Capacity Reservation was started.
    State string
    The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

    • active - The capacity is available for use.
    • expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
    • cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.
    • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
    • failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
    • scheduled - ( Future-dated Capacity Reservations ) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
    • payment-pending - ( Capacity Blocks ) The upfront payment has not been processed yet.
    • payment-failed - ( Capacity Blocks ) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
    • assessing - ( Future-dated Capacity Reservations ) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
    • delayed - ( Future-dated Capacity Reservations ) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
    • unsupported - ( Future-dated Capacity Reservations ) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.
    TotalInstanceCount int
    Returns the total number of instances for which the Capacity Reservation reserves capacity. For example: 15 .
    AvailableInstanceCount int
    Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation. For example: 9 .
    CapacityAllocationSet []CapacityReservationCapacityAllocation
    CapacityReservationArn string
    The Amazon Resource Name (ARN) of the Capacity Reservation.
    CapacityReservationFleetId string
    The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
    CommitmentInfo CommitmentInfoProperties
    CreateDate string
    The date and time at which the Capacity Reservation was created.
    DeliveryPreference string
    The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.
    EndDate string

    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.

    If you are requesting a future-dated Capacity Reservation, you can't specify an end date and time that is within the commitment duration.

    EndDateType 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 .
    Id string
    The ID of the Capacity Reservation.
    InstanceCount int

    The number of instances for which to reserve capacity.

    You can request future-dated Capacity Reservations for an instance count with a minimum of 100 vCPUs. For example, if you request a future-dated Capacity Reservation for m5.xlarge instances, you must request at least 25 instances ( 25 * m5.xlarge = 100 vCPUs ).

    Valid range: 1 - 1000

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

    If you are requesting a future-dated Capacity Reservation, you must specify targeted .

    Default: open

    OwnerId string
    The ID of the AWS account that owns the Capacity Reservation.
    ReservationType string
    The type of Capacity Reservation.
    StartDate string
    The date and time at which the Capacity Reservation was started.
    State string
    The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

    • active - The capacity is available for use.
    • expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
    • cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.
    • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
    • failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
    • scheduled - ( Future-dated Capacity Reservations ) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
    • payment-pending - ( Capacity Blocks ) The upfront payment has not been processed yet.
    • payment-failed - ( Capacity Blocks ) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
    • assessing - ( Future-dated Capacity Reservations ) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
    • delayed - ( Future-dated Capacity Reservations ) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
    • unsupported - ( Future-dated Capacity Reservations ) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.
    TotalInstanceCount int
    Returns the total number of instances for which the Capacity Reservation reserves capacity. For example: 15 .
    availableInstanceCount Integer
    Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation. For example: 9 .
    capacityAllocationSet List<CapacityReservationCapacityAllocation>
    capacityReservationArn String
    The Amazon Resource Name (ARN) of the Capacity Reservation.
    capacityReservationFleetId String
    The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
    commitmentInfo CommitmentInfoProperties
    createDate String
    The date and time at which the Capacity Reservation was created.
    deliveryPreference String
    The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.
    endDate String

    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.

    If you are requesting a future-dated Capacity Reservation, you can't specify an end date and time that is within the commitment duration.

    endDateType 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 .
    id String
    The ID of the Capacity Reservation.
    instanceCount Integer

    The number of instances for which to reserve capacity.

    You can request future-dated Capacity Reservations for an instance count with a minimum of 100 vCPUs. For example, if you request a future-dated Capacity Reservation for m5.xlarge instances, you must request at least 25 instances ( 25 * m5.xlarge = 100 vCPUs ).

    Valid range: 1 - 1000

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

    If you are requesting a future-dated Capacity Reservation, you must specify targeted .

    Default: open

    ownerId String
    The ID of the AWS account that owns the Capacity Reservation.
    reservationType String
    The type of Capacity Reservation.
    startDate String
    The date and time at which the Capacity Reservation was started.
    state String
    The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

    • active - The capacity is available for use.
    • expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
    • cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.
    • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
    • failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
    • scheduled - ( Future-dated Capacity Reservations ) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
    • payment-pending - ( Capacity Blocks ) The upfront payment has not been processed yet.
    • payment-failed - ( Capacity Blocks ) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
    • assessing - ( Future-dated Capacity Reservations ) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
    • delayed - ( Future-dated Capacity Reservations ) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
    • unsupported - ( Future-dated Capacity Reservations ) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.
    totalInstanceCount Integer
    Returns the total number of instances for which the Capacity Reservation reserves capacity. For example: 15 .
    availableInstanceCount number
    Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation. For example: 9 .
    capacityAllocationSet CapacityReservationCapacityAllocation[]
    capacityReservationArn string
    The Amazon Resource Name (ARN) of the Capacity Reservation.
    capacityReservationFleetId string
    The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
    commitmentInfo CommitmentInfoProperties
    createDate string
    The date and time at which the Capacity Reservation was created.
    deliveryPreference string
    The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.
    endDate string

    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.

    If you are requesting a future-dated Capacity Reservation, you can't specify an end date and time that is within the commitment duration.

    endDateType 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 .
    id string
    The ID of the Capacity Reservation.
    instanceCount number

    The number of instances for which to reserve capacity.

    You can request future-dated Capacity Reservations for an instance count with a minimum of 100 vCPUs. For example, if you request a future-dated Capacity Reservation for m5.xlarge instances, you must request at least 25 instances ( 25 * m5.xlarge = 100 vCPUs ).

    Valid range: 1 - 1000

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

    If you are requesting a future-dated Capacity Reservation, you must specify targeted .

    Default: open

    ownerId string
    The ID of the AWS account that owns the Capacity Reservation.
    reservationType string
    The type of Capacity Reservation.
    startDate string
    The date and time at which the Capacity Reservation was started.
    state string
    The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

    • active - The capacity is available for use.
    • expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
    • cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.
    • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
    • failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
    • scheduled - ( Future-dated Capacity Reservations ) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
    • payment-pending - ( Capacity Blocks ) The upfront payment has not been processed yet.
    • payment-failed - ( Capacity Blocks ) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
    • assessing - ( Future-dated Capacity Reservations ) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
    • delayed - ( Future-dated Capacity Reservations ) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
    • unsupported - ( Future-dated Capacity Reservations ) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.
    totalInstanceCount number
    Returns the total number of instances for which the Capacity Reservation reserves capacity. For example: 15 .
    available_instance_count int
    Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation. For example: 9 .
    capacity_allocation_set Sequence[CapacityReservationCapacityAllocation]
    capacity_reservation_arn str
    The Amazon Resource Name (ARN) of the Capacity Reservation.
    capacity_reservation_fleet_id str
    The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
    commitment_info CommitmentInfoProperties
    create_date str
    The date and time at which the Capacity Reservation was created.
    delivery_preference str
    The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.
    end_date str

    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.

    If you are requesting a future-dated Capacity Reservation, you can't specify an end date and time that is within the commitment duration.

    end_date_type str
    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 .
    id str
    The ID of the Capacity Reservation.
    instance_count int

    The number of instances for which to reserve capacity.

    You can request future-dated Capacity Reservations for an instance count with a minimum of 100 vCPUs. For example, if you request a future-dated Capacity Reservation for m5.xlarge instances, you must request at least 25 instances ( 25 * m5.xlarge = 100 vCPUs ).

    Valid range: 1 - 1000

    instance_match_criteria str

    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.

    If you are requesting a future-dated Capacity Reservation, you must specify targeted .

    Default: open

    owner_id str
    The ID of the AWS account that owns the Capacity Reservation.
    reservation_type str
    The type of Capacity Reservation.
    start_date str
    The date and time at which the Capacity Reservation was started.
    state str
    The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

    • active - The capacity is available for use.
    • expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
    • cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.
    • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
    • failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
    • scheduled - ( Future-dated Capacity Reservations ) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
    • payment-pending - ( Capacity Blocks ) The upfront payment has not been processed yet.
    • payment-failed - ( Capacity Blocks ) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
    • assessing - ( Future-dated Capacity Reservations ) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
    • delayed - ( Future-dated Capacity Reservations ) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
    • unsupported - ( Future-dated Capacity Reservations ) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.
    total_instance_count int
    Returns the total number of instances for which the Capacity Reservation reserves capacity. For example: 15 .
    availableInstanceCount Number
    Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation. For example: 9 .
    capacityAllocationSet List<Property Map>
    capacityReservationArn String
    The Amazon Resource Name (ARN) of the Capacity Reservation.
    capacityReservationFleetId String
    The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
    commitmentInfo Property Map
    createDate String
    The date and time at which the Capacity Reservation was created.
    deliveryPreference String
    The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.
    endDate String

    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.

    If you are requesting a future-dated Capacity Reservation, you can't specify an end date and time that is within the commitment duration.

    endDateType 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 .
    id String
    The ID of the Capacity Reservation.
    instanceCount Number

    The number of instances for which to reserve capacity.

    You can request future-dated Capacity Reservations for an instance count with a minimum of 100 vCPUs. For example, if you request a future-dated Capacity Reservation for m5.xlarge instances, you must request at least 25 instances ( 25 * m5.xlarge = 100 vCPUs ).

    Valid range: 1 - 1000

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

    If you are requesting a future-dated Capacity Reservation, you must specify targeted .

    Default: open

    ownerId String
    The ID of the AWS account that owns the Capacity Reservation.
    reservationType String
    The type of Capacity Reservation.
    startDate String
    The date and time at which the Capacity Reservation was started.
    state String
    The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

    • active - The capacity is available for use.
    • expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
    • cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.
    • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
    • failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
    • scheduled - ( Future-dated Capacity Reservations ) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
    • payment-pending - ( Capacity Blocks ) The upfront payment has not been processed yet.
    • payment-failed - ( Capacity Blocks ) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
    • assessing - ( Future-dated Capacity Reservations ) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
    • delayed - ( Future-dated Capacity Reservations ) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
    • unsupported - ( Future-dated Capacity Reservations ) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.
    totalInstanceCount Number
    Returns the total number of instances for which the Capacity Reservation reserves capacity. For example: 15 .

    Supporting Types

    CapacityReservationCapacityAllocation

    AllocationType string
    The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
    Count int
    The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.
    AllocationType string
    The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
    Count int
    The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.
    allocationType String
    The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
    count Integer
    The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.
    allocationType string
    The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
    count number
    The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.
    allocation_type str
    The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
    count int
    The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.
    allocationType String
    The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
    count Number
    The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.

    CommitmentInfoProperties

    CommitmentEndDate string
    The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ ). You can't decrease the instance count or cancel the Capacity Reservation before this date and time.
    CommittedInstanceCount int
    The instance capacity that you committed to when you requested the future-dated Capacity Reservation.
    CommitmentEndDate string
    The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ ). You can't decrease the instance count or cancel the Capacity Reservation before this date and time.
    CommittedInstanceCount int
    The instance capacity that you committed to when you requested the future-dated Capacity Reservation.
    commitmentEndDate String
    The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ ). You can't decrease the instance count or cancel the Capacity Reservation before this date and time.
    committedInstanceCount Integer
    The instance capacity that you committed to when you requested the future-dated Capacity Reservation.
    commitmentEndDate string
    The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ ). You can't decrease the instance count or cancel the Capacity Reservation before this date and time.
    committedInstanceCount number
    The instance capacity that you committed to when you requested the future-dated Capacity Reservation.
    commitment_end_date str
    The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ ). You can't decrease the instance count or cancel the Capacity Reservation before this date and time.
    committed_instance_count int
    The instance capacity that you committed to when you requested the future-dated Capacity Reservation.
    commitmentEndDate String
    The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ ). You can't decrease the instance count or cancel the Capacity Reservation before this date and time.
    committedInstanceCount Number
    The instance capacity that you committed to when you requested the future-dated Capacity Reservation.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-aws-native