com.amazonaws.services.ec2.model.DescribeCapacityReservationsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeCapacityReservationsRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeCapacityReservationsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* The ID of the Capacity Reservation.
*
*/
private com.amazonaws.internal.SdkInternalList capacityReservationIds;
/**
*
* The token to use to retrieve the next page of results.
*
*/
private String nextToken;
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*/
private Integer maxResults;
/**
*
* One or more filters.
*
*
* -
*
* instance-type - The type of instance for which the Capacity Reservation reserves capacity.
*
*
* -
*
* owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
*
*
* -
*
* instance-platform - The type of operating system for which the Capacity Reservation reserves
* capacity.
*
*
* -
*
* availability-zone - The Availability Zone 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 Amazon Web
* Services accounts.
*
*
* -
*
* dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a
* single Amazon Web Services account.
*
*
*
*
* -
*
* outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was
* created.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* start-date - The date and time at which the Capacity Reservation was started.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was
* created.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The ID of the Capacity Reservation.
*
*
* @return The ID of the Capacity Reservation.
*/
public java.util.List getCapacityReservationIds() {
if (capacityReservationIds == null) {
capacityReservationIds = new com.amazonaws.internal.SdkInternalList();
}
return capacityReservationIds;
}
/**
*
* The ID of the Capacity Reservation.
*
*
* @param capacityReservationIds
* The ID of the Capacity Reservation.
*/
public void setCapacityReservationIds(java.util.Collection capacityReservationIds) {
if (capacityReservationIds == null) {
this.capacityReservationIds = null;
return;
}
this.capacityReservationIds = new com.amazonaws.internal.SdkInternalList(capacityReservationIds);
}
/**
*
* The ID of the Capacity Reservation.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setCapacityReservationIds(java.util.Collection)} or
* {@link #withCapacityReservationIds(java.util.Collection)} if you want to override the existing values.
*
*
* @param capacityReservationIds
* The ID of the Capacity Reservation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeCapacityReservationsRequest withCapacityReservationIds(String... capacityReservationIds) {
if (this.capacityReservationIds == null) {
setCapacityReservationIds(new com.amazonaws.internal.SdkInternalList(capacityReservationIds.length));
}
for (String ele : capacityReservationIds) {
this.capacityReservationIds.add(ele);
}
return this;
}
/**
*
* The ID of the Capacity Reservation.
*
*
* @param capacityReservationIds
* The ID of the Capacity Reservation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeCapacityReservationsRequest withCapacityReservationIds(java.util.Collection capacityReservationIds) {
setCapacityReservationIds(capacityReservationIds);
return this;
}
/**
*
* The token to use to retrieve the next page of results.
*
*
* @param nextToken
* The token to use to retrieve the next page of results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token to use to retrieve the next page of results.
*
*
* @return The token to use to retrieve the next page of results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token to use to retrieve the next page of results.
*
*
* @param nextToken
* The token to use to retrieve the next page of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeCapacityReservationsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*
* @param maxResults
* The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. For more information, see Pagination.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*
* @return The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. For more information, see Pagination.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*
* @param maxResults
* The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. For more information, see Pagination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeCapacityReservationsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* One or more filters.
*
*
* -
*
* instance-type - The type of instance for which the Capacity Reservation reserves capacity.
*
*
* -
*
* owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
*
*
* -
*
* instance-platform - The type of operating system for which the Capacity Reservation reserves
* capacity.
*
*
* -
*
* availability-zone - The Availability Zone 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 Amazon Web
* Services accounts.
*
*
* -
*
* dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a
* single Amazon Web Services account.
*
*
*
*
* -
*
* outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was
* created.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* start-date - The date and time at which the Capacity Reservation was started.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was
* created.
*
*
*
*
* @return One or more filters.
*
* -
*
* instance-type - The type of instance for which the Capacity Reservation reserves capacity.
*
*
* -
*
* owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
*
*
* -
*
* instance-platform - The type of operating system for which the Capacity Reservation reserves
* capacity.
*
*
* -
*
* availability-zone - The Availability Zone 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 Amazon
* Web Services accounts.
*
*
* -
*
* dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated
* to a single Amazon Web Services account.
*
*
*
*
* -
*
* outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity
* Reservation was created.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* start-date - The date and time at which the Capacity Reservation was started.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* placement-group-arn - The ARN of the cluster placement group in which the Capacity
* Reservation was created.
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* One or more filters.
*
*
* -
*
* instance-type - The type of instance for which the Capacity Reservation reserves capacity.
*
*
* -
*
* owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
*
*
* -
*
* instance-platform - The type of operating system for which the Capacity Reservation reserves
* capacity.
*
*
* -
*
* availability-zone - The Availability Zone 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 Amazon Web
* Services accounts.
*
*
* -
*
* dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a
* single Amazon Web Services account.
*
*
*
*
* -
*
* outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was
* created.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* start-date - The date and time at which the Capacity Reservation was started.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was
* created.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* instance-type - The type of instance for which the Capacity Reservation reserves capacity.
*
*
* -
*
* owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
*
*
* -
*
* instance-platform - The type of operating system for which the Capacity Reservation reserves
* capacity.
*
*
* -
*
* availability-zone - The Availability Zone 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 Amazon
* Web Services accounts.
*
*
* -
*
* dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated
* to a single Amazon Web Services account.
*
*
*
*
* -
*
* outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation
* was created.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* start-date - The date and time at which the Capacity Reservation was started.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* placement-group-arn - The ARN of the cluster placement group in which the Capacity
* Reservation was created.
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(filters);
}
/**
*
* One or more filters.
*
*
* -
*
* instance-type - The type of instance for which the Capacity Reservation reserves capacity.
*
*
* -
*
* owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
*
*
* -
*
* instance-platform - The type of operating system for which the Capacity Reservation reserves
* capacity.
*
*
* -
*
* availability-zone - The Availability Zone 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 Amazon Web
* Services accounts.
*
*
* -
*
* dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a
* single Amazon Web Services account.
*
*
*
*
* -
*
* outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was
* created.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* start-date - The date and time at which the Capacity Reservation was started.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was
* created.
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param filters
* One or more filters.
*
* -
*
* instance-type - The type of instance for which the Capacity Reservation reserves capacity.
*
*
* -
*
* owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
*
*
* -
*
* instance-platform - The type of operating system for which the Capacity Reservation reserves
* capacity.
*
*
* -
*
* availability-zone - The Availability Zone 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 Amazon
* Web Services accounts.
*
*
* -
*
* dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated
* to a single Amazon Web Services account.
*
*
*
*
* -
*
* outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation
* was created.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* start-date - The date and time at which the Capacity Reservation was started.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* placement-group-arn - The ARN of the cluster placement group in which the Capacity
* Reservation was created.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeCapacityReservationsRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* One or more filters.
*
*
* -
*
* instance-type - The type of instance for which the Capacity Reservation reserves capacity.
*
*
* -
*
* owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
*
*
* -
*
* instance-platform - The type of operating system for which the Capacity Reservation reserves
* capacity.
*
*
* -
*
* availability-zone - The Availability Zone 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 Amazon Web
* Services accounts.
*
*
* -
*
* dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a
* single Amazon Web Services account.
*
*
*
*
* -
*
* outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was
* created.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* start-date - The date and time at which the Capacity Reservation was started.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was
* created.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* instance-type - The type of instance for which the Capacity Reservation reserves capacity.
*
*
* -
*
* owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
*
*
* -
*
* instance-platform - The type of operating system for which the Capacity Reservation reserves
* capacity.
*
*
* -
*
* availability-zone - The Availability Zone 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 Amazon
* Web Services accounts.
*
*
* -
*
* dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated
* to a single Amazon Web Services account.
*
*
*
*
* -
*
* outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation
* was created.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* start-date - The date and time at which the Capacity Reservation was started.
*
*
* -
*
* 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.
*
*
*
*
* -
*
* placement-group-arn - The ARN of the cluster placement group in which the Capacity
* Reservation was created.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeCapacityReservationsRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new DescribeCapacityReservationsRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCapacityReservationIds() != null)
sb.append("CapacityReservationIds: ").append(getCapacityReservationIds()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeCapacityReservationsRequest == false)
return false;
DescribeCapacityReservationsRequest other = (DescribeCapacityReservationsRequest) obj;
if (other.getCapacityReservationIds() == null ^ this.getCapacityReservationIds() == null)
return false;
if (other.getCapacityReservationIds() != null && other.getCapacityReservationIds().equals(this.getCapacityReservationIds()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCapacityReservationIds() == null) ? 0 : getCapacityReservationIds().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
return hashCode;
}
@Override
public DescribeCapacityReservationsRequest clone() {
return (DescribeCapacityReservationsRequest) super.clone();
}
}