Interface DescribeKeyPairsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeKeyPairsRequest.Builder,DescribeKeyPairsRequest>
,Ec2Request.Builder
,SdkBuilder<DescribeKeyPairsRequest.Builder,DescribeKeyPairsRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- DescribeKeyPairsRequest
public static interface DescribeKeyPairsRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeKeyPairsRequest.Builder,DescribeKeyPairsRequest>
-
-
Method Summary
-
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 Detail
-
filters
DescribeKeyPairsRequest.Builder filters(Collection<Filter> filters)
The filters.
-
key-pair-id
- The ID of the key pair. -
fingerprint
- The fingerprint of the key pair. -
key-name
- The name of the key pair. -
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. -
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.
- Parameters:
filters
- The filters.-
key-pair-id
- The ID of the key pair. -
fingerprint
- The fingerprint of the key pair. -
key-name
- The name of the key pair. -
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. -
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
DescribeKeyPairsRequest.Builder filters(Filter... filters)
The filters.
-
key-pair-id
- The ID of the key pair. -
fingerprint
- The fingerprint of the key pair. -
key-name
- The name of the key pair. -
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. -
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.
- Parameters:
filters
- The filters.-
key-pair-id
- The ID of the key pair. -
fingerprint
- The fingerprint of the key pair. -
key-name
- The name of the key pair. -
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. -
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
DescribeKeyPairsRequest.Builder filters(Consumer<Filter.Builder>... filters)
The filters.
-
key-pair-id
- The ID of the key pair. -
fingerprint
- The fingerprint of the key pair. -
key-name
- The name of the key pair. -
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. -
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.
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 to#filters(List
.) - 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:
#filters(java.util.Collection
)
-
-
keyNames
DescribeKeyPairsRequest.Builder keyNames(Collection<String> keyNames)
The key pair names.
Default: Describes all of your key pairs.
- Parameters:
keyNames
- The key pair names.Default: Describes all of your key pairs.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyNames
DescribeKeyPairsRequest.Builder keyNames(String... keyNames)
The key pair names.
Default: Describes all of your key pairs.
- Parameters:
keyNames
- The key pair names.Default: Describes all of your key pairs.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyPairIds
DescribeKeyPairsRequest.Builder keyPairIds(Collection<String> keyPairIds)
The IDs of the key pairs.
- Parameters:
keyPairIds
- The IDs of the key pairs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyPairIds
DescribeKeyPairsRequest.Builder keyPairIds(String... keyPairIds)
The IDs of the key pairs.
- Parameters:
keyPairIds
- The IDs of the key pairs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dryRun
DescribeKeyPairsRequest.Builder dryRun(Boolean 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.
-
includePublicKey
DescribeKeyPairsRequest.Builder includePublicKey(Boolean includePublicKey)
If
true
, the public key material is included in the response.Default:
false
- Parameters:
includePublicKey
- Iftrue
, the public key material is included in the response.Default:
false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeKeyPairsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
DescribeKeyPairsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-