/*
* Copyright 2018-2023 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.DescribeVolumesRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeVolumesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest
* The filters.
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
* The volume IDs.
*
* The maximum number of volumes to return for this request. This value can be between 5 and 500; if you specify a
* value larger than 500, only 500 items are returned. If this parameter is not used, then all items are returned.
* You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination.
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned
* from the previous request.
*
* The filters.
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
private com.amazonaws.internal.SdkInternalListattachment.attach-time
- The time stamp when the attachment initiated.
* attachment.delete-on-termination
- Whether the volume is deleted on instance termination.
* attachment.device
- The device name specified in the block device mapping (for example,
* /dev/sda1
).
* attachment.instance-id
- The ID of the instance the volume is attached to.
* attachment.status
- The attachment state (attaching
| attached
|
* detaching
).
* availability-zone
- The Availability Zone in which the volume was created.
* create-time
- The time stamp when the volume was created.
* encrypted
- Indicates whether the volume is encrypted (true
| false
)
* multi-attach-enabled
- Indicates whether the volume is enabled for Multi-Attach (true
|
* false
)
* fast-restored
- Indicates whether the volume was created from a snapshot that is enabled for fast
* snapshot restore (true
| false
).
* size
- The size of the volume, in GiB.
* snapshot-id
- The snapshot from which the volume was created.
* status
- The state of the volume (creating
| available
|
* in-use
| deleting
| deleted
| error
).
* tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
* and TeamA
for the filter value.
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
* volume-id
- The volume ID.
* volume-type
- The Amazon EBS volume type (gp2
| gp3
| io1
|
* io2
| st1
| sc1
| standard
)
*
*
*
* @return The filters.attachment.attach-time
- The time stamp when the attachment initiated.
* attachment.delete-on-termination
- Whether the volume is deleted on instance termination.
* attachment.device
- The device name specified in the block device mapping (for example,
* /dev/sda1
).
* attachment.instance-id
- The ID of the instance the volume is attached to.
* attachment.status
- The attachment state (attaching
| attached
|
* detaching
).
* availability-zone
- The Availability Zone in which the volume was created.
* create-time
- The time stamp when the volume was created.
* encrypted
- Indicates whether the volume is encrypted (true
| false
)
* multi-attach-enabled
- Indicates whether the volume is enabled for Multi-Attach (true
|
* false
)
* fast-restored
- Indicates whether the volume was created from a snapshot that is enabled for fast
* snapshot restore (true
| false
).
* size
- The size of the volume, in GiB.
* snapshot-id
- The snapshot from which the volume was created.
* status
- The state of the volume (creating
| available
|
* in-use
| deleting
| deleted
| error
).
* tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
* and TeamA
for the filter value.
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
* volume-id
- The volume ID.
* volume-type
- The Amazon EBS volume type (gp2
| gp3
| io1
|
* io2
| st1
| sc1
| standard
)
*
* attachment.attach-time
- The time stamp when the attachment initiated.
*
* attachment.delete-on-termination
- Whether the volume is deleted on instance termination.
*
* attachment.device
- The device name specified in the block device mapping (for example,
* /dev/sda1
).
*
* attachment.instance-id
- The ID of the instance the volume is attached to.
*
* attachment.status
- The attachment state (attaching
| attached
|
* detaching
).
*
* availability-zone
- The Availability Zone in which the volume was created.
*
* create-time
- The time stamp when the volume was created.
*
* encrypted
- Indicates whether the volume is encrypted (true
|
* false
)
*
* multi-attach-enabled
- Indicates whether the volume is enabled for Multi-Attach (
* true
| false
)
*
* fast-restored
- Indicates whether the volume was created from a snapshot that is enabled for
* fast snapshot restore (true
| false
).
*
* size
- The size of the volume, in GiB.
*
* snapshot-id
- The snapshot from which the volume was created.
*
* status
- The state of the volume (creating
| available
|
* in-use
| deleting
| deleted
| error
).
*
* tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that
* have a tag with the key Owner
and the value TeamA
, specify
* tag:Owner
for the filter name and TeamA
for the filter value.
*
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
* volume-id
- The volume ID.
*
* volume-type
- The Amazon EBS volume type (gp2
| gp3
|
* io1
| io2
| st1
| sc1
| standard
)
*
* The filters. *
*
* attachment.attach-time
- The time stamp when the attachment initiated.
*
* attachment.delete-on-termination
- Whether the volume is deleted on instance termination.
*
* attachment.device
- The device name specified in the block device mapping (for example,
* /dev/sda1
).
*
* attachment.instance-id
- The ID of the instance the volume is attached to.
*
* attachment.status
- The attachment state (attaching
| attached
|
* detaching
).
*
* availability-zone
- The Availability Zone in which the volume was created.
*
* create-time
- The time stamp when the volume was created.
*
* encrypted
- Indicates whether the volume is encrypted (true
| false
)
*
* multi-attach-enabled
- Indicates whether the volume is enabled for Multi-Attach (true
|
* false
)
*
* fast-restored
- Indicates whether the volume was created from a snapshot that is enabled for fast
* snapshot restore (true
| false
).
*
* size
- The size of the volume, in GiB.
*
* snapshot-id
- The snapshot from which the volume was created.
*
* status
- The state of the volume (creating
| available
|
* in-use
| deleting
| deleted
| error
).
*
* tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
* and TeamA
for the filter value.
*
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
* volume-id
- The volume ID.
*
* volume-type
- The Amazon EBS volume type (gp2
| gp3
| io1
|
* io2
| st1
| sc1
| standard
)
*
* attachment.attach-time
- The time stamp when the attachment initiated.
*
* attachment.delete-on-termination
- Whether the volume is deleted on instance termination.
*
* attachment.device
- The device name specified in the block device mapping (for example,
* /dev/sda1
).
*
* attachment.instance-id
- The ID of the instance the volume is attached to.
*
* attachment.status
- The attachment state (attaching
| attached
|
* detaching
).
*
* availability-zone
- The Availability Zone in which the volume was created.
*
* create-time
- The time stamp when the volume was created.
*
* encrypted
- Indicates whether the volume is encrypted (true
| false
* )
*
* multi-attach-enabled
- Indicates whether the volume is enabled for Multi-Attach (
* true
| false
)
*
* fast-restored
- Indicates whether the volume was created from a snapshot that is enabled for
* fast snapshot restore (true
| false
).
*
* size
- The size of the volume, in GiB.
*
* snapshot-id
- The snapshot from which the volume was created.
*
* status
- The state of the volume (creating
| available
|
* in-use
| deleting
| deleted
| error
).
*
* tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner
and the value TeamA
, specify tag:Owner
for
* the filter name and TeamA
for the filter value.
*
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
* volume-id
- The volume ID.
*
* volume-type
- The Amazon EBS volume type (gp2
| gp3
|
* io1
| io2
| st1
| sc1
| standard
)
*
* The filters. *
*
* attachment.attach-time
- The time stamp when the attachment initiated.
*
* attachment.delete-on-termination
- Whether the volume is deleted on instance termination.
*
* attachment.device
- The device name specified in the block device mapping (for example,
* /dev/sda1
).
*
* attachment.instance-id
- The ID of the instance the volume is attached to.
*
* attachment.status
- The attachment state (attaching
| attached
|
* detaching
).
*
* availability-zone
- The Availability Zone in which the volume was created.
*
* create-time
- The time stamp when the volume was created.
*
* encrypted
- Indicates whether the volume is encrypted (true
| false
)
*
* multi-attach-enabled
- Indicates whether the volume is enabled for Multi-Attach (true
|
* false
)
*
* fast-restored
- Indicates whether the volume was created from a snapshot that is enabled for fast
* snapshot restore (true
| false
).
*
* size
- The size of the volume, in GiB.
*
* snapshot-id
- The snapshot from which the volume was created.
*
* status
- The state of the volume (creating
| available
|
* in-use
| deleting
| deleted
| error
).
*
* tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
* and TeamA
for the filter value.
*
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
* volume-id
- The volume ID.
*
* volume-type
- The Amazon EBS volume type (gp2
| gp3
| io1
|
* io2
| st1
| sc1
| standard
)
*
* 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 * The filters. *
* attachment.attach-time
- The time stamp when the attachment initiated.
*
* attachment.delete-on-termination
- Whether the volume is deleted on instance termination.
*
* attachment.device
- The device name specified in the block device mapping (for example,
* /dev/sda1
).
*
* attachment.instance-id
- The ID of the instance the volume is attached to.
*
* attachment.status
- The attachment state (attaching
| attached
|
* detaching
).
*
* availability-zone
- The Availability Zone in which the volume was created.
*
* create-time
- The time stamp when the volume was created.
*
* encrypted
- Indicates whether the volume is encrypted (true
| false
* )
*
* multi-attach-enabled
- Indicates whether the volume is enabled for Multi-Attach (
* true
| false
)
*
* fast-restored
- Indicates whether the volume was created from a snapshot that is enabled for
* fast snapshot restore (true
| false
).
*
* size
- The size of the volume, in GiB.
*
* snapshot-id
- The snapshot from which the volume was created.
*
* status
- The state of the volume (creating
| available
|
* in-use
| deleting
| deleted
| error
).
*
* tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner
and the value TeamA
, specify tag:Owner
for
* the filter name and TeamA
for the filter value.
*
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
* volume-id
- The volume ID.
*
* volume-type
- The Amazon EBS volume type (gp2
| gp3
|
* io1
| io2
| st1
| sc1
| standard
)
*
* The filters. *
*
* attachment.attach-time
- The time stamp when the attachment initiated.
*
* attachment.delete-on-termination
- Whether the volume is deleted on instance termination.
*
* attachment.device
- The device name specified in the block device mapping (for example,
* /dev/sda1
).
*
* attachment.instance-id
- The ID of the instance the volume is attached to.
*
* attachment.status
- The attachment state (attaching
| attached
|
* detaching
).
*
* availability-zone
- The Availability Zone in which the volume was created.
*
* create-time
- The time stamp when the volume was created.
*
* encrypted
- Indicates whether the volume is encrypted (true
| false
)
*
* multi-attach-enabled
- Indicates whether the volume is enabled for Multi-Attach (true
|
* false
)
*
* fast-restored
- Indicates whether the volume was created from a snapshot that is enabled for fast
* snapshot restore (true
| false
).
*
* size
- The size of the volume, in GiB.
*
* snapshot-id
- The snapshot from which the volume was created.
*
* status
- The state of the volume (creating
| available
|
* in-use
| deleting
| deleted
| error
).
*
* tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner
and the value TeamA
, specify tag:Owner
for the filter name
* and TeamA
for the filter value.
*
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
* volume-id
- The volume ID.
*
* volume-type
- The Amazon EBS volume type (gp2
| gp3
| io1
|
* io2
| st1
| sc1
| standard
)
*
* attachment.attach-time
- The time stamp when the attachment initiated.
*
* attachment.delete-on-termination
- Whether the volume is deleted on instance termination.
*
* attachment.device
- The device name specified in the block device mapping (for example,
* /dev/sda1
).
*
* attachment.instance-id
- The ID of the instance the volume is attached to.
*
* attachment.status
- The attachment state (attaching
| attached
|
* detaching
).
*
* availability-zone
- The Availability Zone in which the volume was created.
*
* create-time
- The time stamp when the volume was created.
*
* encrypted
- Indicates whether the volume is encrypted (true
| false
* )
*
* multi-attach-enabled
- Indicates whether the volume is enabled for Multi-Attach (
* true
| false
)
*
* fast-restored
- Indicates whether the volume was created from a snapshot that is enabled for
* fast snapshot restore (true
| false
).
*
* size
- The size of the volume, in GiB.
*
* snapshot-id
- The snapshot from which the volume was created.
*
* status
- The state of the volume (creating
| available
|
* in-use
| deleting
| deleted
| error
).
*
* tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner
and the value TeamA
, specify tag:Owner
for
* the filter name and TeamA
for the filter value.
*
* tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
* volume-id
- The volume ID.
*
* volume-type
- The Amazon EBS volume type (gp2
| gp3
|
* io1
| io2
| st1
| sc1
| standard
)
*
* The volume IDs. *
* * @return The volume IDs. */ public java.util.List* The volume IDs. *
* * @param volumeIds * The volume IDs. */ public void setVolumeIds(java.util.Collection* The volume IDs. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setVolumeIds(java.util.Collection)} or {@link #withVolumeIds(java.util.Collection)} if you want to * override the existing values. *
* * @param volumeIds * The volume IDs. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeVolumesRequest withVolumeIds(String... volumeIds) { if (this.volumeIds == null) { setVolumeIds(new com.amazonaws.internal.SdkInternalList* The volume IDs. *
* * @param volumeIds * The volume IDs. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeVolumesRequest withVolumeIds(java.util.Collection* The maximum number of volumes to return for this request. This value can be between 5 and 500; if you specify a * value larger than 500, only 500 items are returned. If this parameter is not used, then all items are returned. * You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination. *
* * @param maxResults * The maximum number of volumes to return for this request. This value can be between 5 and 500; if you * specify a value larger than 500, only 500 items are returned. If this parameter is not used, then all * items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. * For more information, see Pagination. */ public void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } /** ** The maximum number of volumes to return for this request. This value can be between 5 and 500; if you specify a * value larger than 500, only 500 items are returned. If this parameter is not used, then all items are returned. * You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination. *
* * @return The maximum number of volumes to return for this request. This value can be between 5 and 500; if you * specify a value larger than 500, only 500 items are returned. If this parameter is not used, then all * items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. * For more information, see Pagination. */ public Integer getMaxResults() { return this.maxResults; } /** ** The maximum number of volumes to return for this request. This value can be between 5 and 500; if you specify a * value larger than 500, only 500 items are returned. If this parameter is not used, then all items are returned. * You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination. *
* * @param maxResults * The maximum number of volumes to return for this request. This value can be between 5 and 500; if you * specify a value larger than 500, only 500 items are returned. If this parameter is not used, then all * items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. * For more information, see Pagination. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeVolumesRequest withMaxResults(Integer maxResults) { setMaxResults(maxResults); return this; } /** ** The token returned from a previous paginated request. Pagination continues from the end of the items returned * from the previous request. *
* * @param nextToken * The token returned from a previous paginated request. Pagination continues from the end of the items * returned from the previous request. */ public void setNextToken(String nextToken) { this.nextToken = nextToken; } /** ** The token returned from a previous paginated request. Pagination continues from the end of the items returned * from the previous request. *
* * @return The token returned from a previous paginated request. Pagination continues from the end of the items * returned from the previous request. */ public String getNextToken() { return this.nextToken; } /** ** The token returned from a previous paginated request. Pagination continues from the end of the items returned * from the previous request. *
* * @param nextToken * The token returned from a previous paginated request. Pagination continues from the end of the items * returned from the previous request. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeVolumesRequest withNextToken(String nextToken) { setNextToken(nextToken); 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