public static interface DescribeVolumesRequest.Builder extends Ec2Request.Builder, CopyableBuilder<DescribeVolumesRequest.Builder,DescribeVolumesRequest>
Modifier and Type | Method and Description |
---|---|
DescribeVolumesRequest.Builder |
filters(Collection<Filter> filters)
One or more filters.
|
DescribeVolumesRequest.Builder |
filters(Consumer<Filter.Builder>... filters)
One or more filters.
|
DescribeVolumesRequest.Builder |
filters(Filter... filters)
One or more filters.
|
DescribeVolumesRequest.Builder |
maxResults(Integer maxResults)
The maximum number of volume results returned by
DescribeVolumes in paginated output. |
DescribeVolumesRequest.Builder |
nextToken(String nextToken)
The
NextToken value returned from a previous paginated DescribeVolumes request
where MaxResults was used and the results exceeded the value of that parameter. |
DescribeVolumesRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
DescribeVolumesRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
DescribeVolumesRequest.Builder |
volumeIds(Collection<String> volumeIds)
One or more volume IDs.
|
DescribeVolumesRequest.Builder |
volumeIds(String... volumeIds)
One or more volume IDs.
|
build
overrideConfiguration
copy
applyMutation, build
DescribeVolumesRequest.Builder filters(Collection<Filter> filters)
One or more 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
| detached
).
availability-zone
- The Availability Zone in which the volume was created.
create-time
- The time stamp when the volume was created.
encrypted
- The encryption status of the volume.
size
- The size of the volume, in GiB.
snapshot-id
- The snapshot from which the volume was created.
status
- The status of the volume (creating
| available
|
in-use
| deleting
| deleted
| error
).
tag
:key=value - The key/value combination of a tag assigned to the resource.
Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for
the tag Purpose=X, specify tag:Purpose
for the filter name and X
for the filter
value.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value
is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where
Purpose is X, see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
volume-id
- The volume ID.
volume-type
- The Amazon EBS volume type. This can be gp2
for General Purpose SSD,
io1
for Provisioned IOPS SSD, st1
for Throughput Optimized HDD, sc1
for Cold HDD, or standard
for Magnetic volumes.
filters
- One or more 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
| detached
).
availability-zone
- The Availability Zone in which the volume was created.
create-time
- The time stamp when the volume was created.
encrypted
- The encryption status of the volume.
size
- The size of the volume, in GiB.
snapshot-id
- The snapshot from which the volume was created.
status
- The status of the volume (creating
| available
|
in-use
| deleting
| deleted
| error
).
tag
:key=value - The key/value combination of a tag assigned to the
resource. Specify the key of the tag in the filter name and the value of the tag in the filter value.
For example, for the tag Purpose=X, specify tag:Purpose
for the filter name and
X
for the filter value.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the
filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the
tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of
the tag-key
filter.
volume-id
- The volume ID.
volume-type
- The Amazon EBS volume type. This can be gp2
for General
Purpose SSD, io1
for Provisioned IOPS SSD, st1
for Throughput Optimized HDD,
sc1
for Cold HDD, or standard
for Magnetic volumes.
DescribeVolumesRequest.Builder filters(Filter... filters)
One or more 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
| detached
).
availability-zone
- The Availability Zone in which the volume was created.
create-time
- The time stamp when the volume was created.
encrypted
- The encryption status of the volume.
size
- The size of the volume, in GiB.
snapshot-id
- The snapshot from which the volume was created.
status
- The status of the volume (creating
| available
|
in-use
| deleting
| deleted
| error
).
tag
:key=value - The key/value combination of a tag assigned to the resource.
Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for
the tag Purpose=X, specify tag:Purpose
for the filter name and X
for the filter
value.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value
is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where
Purpose is X, see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
volume-id
- The volume ID.
volume-type
- The Amazon EBS volume type. This can be gp2
for General Purpose SSD,
io1
for Provisioned IOPS SSD, st1
for Throughput Optimized HDD, sc1
for Cold HDD, or standard
for Magnetic volumes.
filters
- One or more 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
| detached
).
availability-zone
- The Availability Zone in which the volume was created.
create-time
- The time stamp when the volume was created.
encrypted
- The encryption status of the volume.
size
- The size of the volume, in GiB.
snapshot-id
- The snapshot from which the volume was created.
status
- The status of the volume (creating
| available
|
in-use
| deleting
| deleted
| error
).
tag
:key=value - The key/value combination of a tag assigned to the
resource. Specify the key of the tag in the filter name and the value of the tag in the filter value.
For example, for the tag Purpose=X, specify tag:Purpose
for the filter name and
X
for the filter value.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the
filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the
tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of
the tag-key
filter.
volume-id
- The volume ID.
volume-type
- The Amazon EBS volume type. This can be gp2
for General
Purpose SSD, io1
for Provisioned IOPS SSD, st1
for Throughput Optimized HDD,
sc1
for Cold HDD, or standard
for Magnetic volumes.
DescribeVolumesRequest.Builder filters(Consumer<Filter.Builder>... filters)
One or more 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
| detached
).
availability-zone
- The Availability Zone in which the volume was created.
create-time
- The time stamp when the volume was created.
encrypted
- The encryption status of the volume.
size
- The size of the volume, in GiB.
snapshot-id
- The snapshot from which the volume was created.
status
- The status of the volume (creating
| available
|
in-use
| deleting
| deleted
| error
).
tag
:key=value - The key/value combination of a tag assigned to the resource.
Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for
the tag Purpose=X, specify tag:Purpose
for the filter name and X
for the filter
value.
tag-key
- The key of a tag assigned to the resource. This filter is independent of the
tag-value
filter. For example, if you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value
is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where
Purpose is X, see the tag
:key=value filter.
tag-value
- The value of a tag assigned to the resource. This filter is independent of the
tag-key
filter.
volume-id
- The volume ID.
volume-type
- The Amazon EBS volume type. This can be gp2
for General Purpose SSD,
io1
for Provisioned IOPS SSD, st1
for Throughput Optimized HDD, sc1
for Cold HDD, or standard
for Magnetic volumes.
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)
.filters
- a consumer that will call methods on List.Builder
#filters(List)
DescribeVolumesRequest.Builder volumeIds(Collection<String> volumeIds)
One or more volume IDs.
volumeIds
- One or more volume IDs.DescribeVolumesRequest.Builder volumeIds(String... volumeIds)
One or more volume IDs.
volumeIds
- One or more volume IDs.DescribeVolumesRequest.Builder maxResults(Integer maxResults)
The maximum number of volume results returned by DescribeVolumes
in paginated output. When this
parameter is used, DescribeVolumes
only returns MaxResults
results in a single page
along with a NextToken
response element. The remaining results of the initial request can be
seen by sending another DescribeVolumes
request with the returned NextToken
value.
This value can be between 5 and 500; if MaxResults
is given a value larger than 500, only 500
results are returned. If this parameter is not used, then DescribeVolumes
returns all results.
You cannot specify this parameter and the volume IDs parameter in the same request.
maxResults
- The maximum number of volume results returned by DescribeVolumes
in paginated output.
When this parameter is used, DescribeVolumes
only returns MaxResults
results
in a single page along with a NextToken
response element. The remaining results of the
initial request can be seen by sending another DescribeVolumes
request with the returned
NextToken
value. This value can be between 5 and 500; if MaxResults
is given
a value larger than 500, only 500 results are returned. If this parameter is not used, then
DescribeVolumes
returns all results. You cannot specify this parameter and the volume IDs
parameter in the same request.DescribeVolumesRequest.Builder nextToken(String nextToken)
The NextToken
value returned from a previous paginated DescribeVolumes
request
where MaxResults
was used and the results exceeded the value of that parameter. Pagination
continues from the end of the previous results that returned the NextToken
value. This value is
null
when there are no more results to return.
nextToken
- The NextToken
value returned from a previous paginated DescribeVolumes
request where MaxResults
was used and the results exceeded the value of that parameter.
Pagination continues from the end of the previous results that returned the NextToken
value. This value is null
when there are no more results to return.DescribeVolumesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.DescribeVolumesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.