Interface DescribeVolumesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeVolumesRequest.Builder,
,DescribeVolumesRequest> Ec2Request.Builder
,SdkBuilder<DescribeVolumesRequest.Builder,
,DescribeVolumesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeVolumesRequest
-
Method Summary
Modifier and TypeMethodDescriptionChecks whether you have the required permissions for the action, without actually making the request, and provides an error response.filters
(Collection<Filter> filters) The filters.filters
(Consumer<Filter.Builder>... filters) The filters.The filters.maxResults
(Integer maxResults) The maximum number of volumes to return for this request.The token returned from a previous paginated request.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The volume IDs.volumeIds
(Collection<String> volumeIds) The volume IDs.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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
)
- Parameters:
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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
)
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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
)
- Parameters:
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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
)
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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
)
Filter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<Filter>)
.- Parameters:
filters
- a consumer that will call methods onFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
volumeIds
The volume IDs.
- Parameters:
volumeIds
- The volume IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
volumeIds
The volume IDs.
- Parameters:
volumeIds
- The volume IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dryRun
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Parameters:
dryRun
- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
The token returned from a previous paginated request. Pagination continues from the end of the items returned from the previous request.
- Parameters:
nextToken
- The token returned from a previous paginated request. Pagination continues from the end of the items returned from the previous request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeVolumesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DescribeVolumesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-