AWS Native v0.126.0, Sep 30 24

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.ec2.getCapacityReservation

Explore with Pulumi AI

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

pulumi/pulumi-aws-native

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)
// Output-based functions aren't available in Java yet

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 .

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.

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.

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.

Default: open

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 .

EndDate string

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

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.

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.

Default: open

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 .

endDate String

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

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.

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.

Default: open

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 .

endDate string

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

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.

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.

Default: open

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 .

end_date str

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

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.

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.

Default: open

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 .

endDate String

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

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.

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.

Default: open

totalInstanceCount Number