Interface ListKeyPoliciesRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListKeyPoliciesRequest.Builder,ListKeyPoliciesRequest>
,KmsRequest.Builder
,SdkBuilder<ListKeyPoliciesRequest.Builder,ListKeyPoliciesRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- ListKeyPoliciesRequest
public static interface ListKeyPoliciesRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<ListKeyPoliciesRequest.Builder,ListKeyPoliciesRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ListKeyPoliciesRequest.Builder
keyId(String keyId)
Gets the names of key policies for the specified KMS key.ListKeyPoliciesRequest.Builder
limit(Integer limit)
Use this parameter to specify the maximum number of items to return.ListKeyPoliciesRequest.Builder
marker(String marker)
Use this parameter in a subsequent request after you receive a response with truncated results.ListKeyPoliciesRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListKeyPoliciesRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
-
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.kms.model.KmsRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
keyId
ListKeyPoliciesRequest.Builder keyId(String keyId)
Gets the names of key policies for the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:
-
Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
- Parameters:
keyId
- Gets the names of key policies for the specified KMS key.Specify the key ID or key ARN of the KMS key.
For example:
-
Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
limit
ListKeyPoliciesRequest.Builder limit(Integer limit)
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.
Only one policy can be attached to a key.
- Parameters:
limit
- Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.
Only one policy can be attached to a key.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
marker
ListKeyPoliciesRequest.Builder marker(String marker)
Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of
NextMarker
from the truncated response you just received.- Parameters:
marker
- Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value ofNextMarker
from the truncated response you just received.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListKeyPoliciesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
ListKeyPoliciesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-