software.amazon.awssdk.services.ec2.model

Interface DescribeCapacityReservationsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeCapacityReservationsRequest.Builder,DescribeCapacityReservationsRequest>, Ec2Request.Builder, SdkBuilder<DescribeCapacityReservationsRequest.Builder,DescribeCapacityReservationsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeCapacityReservationsRequest

public static interface DescribeCapacityReservationsRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeCapacityReservationsRequest.Builder,DescribeCapacityReservationsRequest>

Method Summary

Modifier and Type	Method and Description
DescribeCapacityReservationsRequest.Builder	capacityReservationIds(Collection<String> capacityReservationIds) The ID of the Capacity Reservation.
DescribeCapacityReservationsRequest.Builder	capacityReservationIds(String... capacityReservationIds) The ID of the Capacity Reservation.
DescribeCapacityReservationsRequest.Builder	filters(Collection<Filter> filters) One or more filters.
DescribeCapacityReservationsRequest.Builder	filters(Consumer<Filter.Builder>... filters) One or more filters.
DescribeCapacityReservationsRequest.Builder	filters(Filter... filters) One or more filters.
DescribeCapacityReservationsRequest.Builder	maxResults(Integer maxResults) The maximum number of results to return for the request in a single page.
DescribeCapacityReservationsRequest.Builder	nextToken(String nextToken) The token to use to retrieve the next page of results.
DescribeCapacityReservationsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeCapacityReservationsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

capacityReservationIds

DescribeCapacityReservationsRequest.Builder capacityReservationIds(Collection<String> capacityReservationIds)

The ID of the Capacity Reservation.

Parameters:

capacityReservationIds - The ID of the Capacity Reservation.

Returns:

Returns a reference to this object so that method calls can be chained together.

capacityReservationIds

DescribeCapacityReservationsRequest.Builder capacityReservationIds(String... capacityReservationIds)

The ID of the Capacity Reservation.

Parameters:

capacityReservationIds - The ID of the Capacity Reservation.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

DescribeCapacityReservationsRequest.Builder nextToken(String nextToken)

The token to use to retrieve the next page of results.

Parameters:

nextToken - The token to use to retrieve the next page of results.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxResults

DescribeCapacityReservationsRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

Parameters:

maxResults - The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeCapacityReservationsRequest.Builder filters(Collection<Filter> filters)

One or more filters.

• instance-type - The type of instance for which the Capacity Reservation reserves capacity.

• owner-id - The ID of the AWS account that owns the Capacity Reservation.

• availability-zone-id - The Availability Zone ID of the Capacity Reservation.

• instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.

• availability-zone - The Availability Zone ID of the Capacity Reservation.

• tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

  • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

• state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

  • active- The Capacity Reservation is active and the capacity is available for your use.

  • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

  • cancelled - The Capacity Reservation was cancelled. 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 might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

• end-date - 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.

• end-date-type - 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.

  • limited - The Capacity Reservation expires automatically at a specified date and time.

• instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

  • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into 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.

Parameters:

filters - One or more filters.

• instance-type - The type of instance for which the Capacity Reservation reserves capacity.

• owner-id - The ID of the AWS account that owns the Capacity Reservation.

• availability-zone-id - The Availability Zone ID of the Capacity Reservation.

• instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.

• availability-zone - The Availability Zone ID of the Capacity Reservation.

• tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

  • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

• state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

  • active- The Capacity Reservation is active and the capacity is available for your use.

  • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

  • cancelled - The Capacity Reservation was cancelled. 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 might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

• end-date - 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.

• end-date-type - 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.

  • limited - The Capacity Reservation expires automatically at a specified date and time.

• instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

  • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeCapacityReservationsRequest.Builder filters(Filter... filters)

One or more filters.

• instance-type - The type of instance for which the Capacity Reservation reserves capacity.

• owner-id - The ID of the AWS account that owns the Capacity Reservation.

• availability-zone-id - The Availability Zone ID of the Capacity Reservation.

• instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.

• availability-zone - The Availability Zone ID of the Capacity Reservation.

• tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

  • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

• state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

  • active- The Capacity Reservation is active and the capacity is available for your use.

  • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

  • cancelled - The Capacity Reservation was cancelled. 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 might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

• end-date - 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.

• end-date-type - 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.

  • limited - The Capacity Reservation expires automatically at a specified date and time.

• instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

  • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into 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.

Parameters:

filters - One or more filters.

• instance-type - The type of instance for which the Capacity Reservation reserves capacity.

• owner-id - The ID of the AWS account that owns the Capacity Reservation.

• availability-zone-id - The Availability Zone ID of the Capacity Reservation.

• instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.

• availability-zone - The Availability Zone ID of the Capacity Reservation.

• tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

  • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

• state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

  • active- The Capacity Reservation is active and the capacity is available for your use.

  • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

  • cancelled - The Capacity Reservation was cancelled. 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 might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

• end-date - 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.

• end-date-type - 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.

  • limited - The Capacity Reservation expires automatically at a specified date and time.

• instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

  • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeCapacityReservationsRequest.Builder filters(Consumer<Filter.Builder>... filters)

One or more filters.

• instance-type - The type of instance for which the Capacity Reservation reserves capacity.

• owner-id - The ID of the AWS account that owns the Capacity Reservation.

• availability-zone-id - The Availability Zone ID of the Capacity Reservation.

• instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.

• availability-zone - The Availability Zone ID of the Capacity Reservation.

• tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

  • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

• state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

  • active- The Capacity Reservation is active and the capacity is available for your use.

  • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

  • cancelled - The Capacity Reservation was cancelled. 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 might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

• end-date - 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.

• end-date-type - 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.

  • limited - The Capacity Reservation expires automatically at a specified date and time.

• instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

  • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into 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.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#filters(List)

overrideConfiguration

DescribeCapacityReservationsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeCapacityReservationsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder