public static interface ListGrantsRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<ListGrantsRequest.Builder,ListGrantsRequest>
Modifier and Type | Method and Description |
---|---|
ListGrantsRequest.Builder |
granteePrincipal(String granteePrincipal)
Returns only grants where the specified principal is the grantee principal for the grant.
|
ListGrantsRequest.Builder |
grantId(String grantId)
Returns only the grant with the specified grant ID.
|
ListGrantsRequest.Builder |
keyId(String keyId)
Returns only grants for the specified customer master key (CMK).
|
ListGrantsRequest.Builder |
limit(Integer limit)
Use this parameter to specify the maximum number of items to return.
|
ListGrantsRequest.Builder |
marker(String marker)
Use this parameter in a subsequent request after you receive a response with truncated results.
|
ListGrantsRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
ListGrantsRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
ListGrantsRequest.Builder limit(Integer limit)
Use this parameter to specify the maximum number of items to return. When this value is present, AWS 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 100, inclusive. If you do not include a value, it defaults to 50.
limit
- Use this parameter to specify the maximum number of items to return. When this value is present, AWS
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 100, inclusive. If you do not include a value, it defaults to 50.
ListGrantsRequest.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.
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.ListGrantsRequest.Builder keyId(String keyId)
Returns only grants for the specified customer master key (CMK). This parameter is required.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
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 CMK, use ListKeys or DescribeKey.
keyId
- Returns only grants for the specified customer master key (CMK). This parameter is required.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
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 CMK, use ListKeys or DescribeKey.
ListGrantsRequest.Builder grantId(String grantId)
Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
grantId
- Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.ListGrantsRequest.Builder granteePrincipal(String granteePrincipal)
Returns only grants where the specified principal is the grantee principal for the grant.
granteePrincipal
- Returns only grants where the specified principal is the grantee principal for the grant.ListGrantsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.ListGrantsRequest.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 © 2021 Amazon Web Services, Inc. All Rights Reserved.