Interface RetireGrantRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<RetireGrantRequest.Builder,
,RetireGrantRequest> KmsRequest.Builder
,SdkBuilder<RetireGrantRequest.Builder,
,RetireGrantRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
RetireGrantRequest
-
Method Summary
Modifier and TypeMethodDescriptionChecks if your request will succeed.Identifies the grant to retire.grantToken
(String grantToken) Identifies the grant to be retired.The key ARN KMS key associated with the grant.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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, sdkFields
-
Method Details
-
grantToken
Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.
Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.
- Parameters:
grantToken
- Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
keyId
The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.
For example:
arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Parameters:
keyId
- The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.For example:
arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
grantId
Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.
-
Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
- Parameters:
grantId
- Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.-
Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
dryRun
Checks if your request will succeed.
DryRun
is an optional parameter.To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
- Parameters:
dryRun
- Checks if your request will succeed.DryRun
is an optional parameter.To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
RetireGrantRequest.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
RetireGrantRequest.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.
-