Interface RevokeGrantRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<RevokeGrantRequest.Builder,RevokeGrantRequest>,KmsRequest.Builder,SdkBuilder<RevokeGrantRequest.Builder,RevokeGrantRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- RevokeGrantRequest
@Mutable @NotThreadSafe public static interface RevokeGrantRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<RevokeGrantRequest.Builder,RevokeGrantRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description RevokeGrantRequest.BuilderdryRun(Boolean dryRun)Checks if your request will succeed.RevokeGrantRequest.BuildergrantId(String grantId)Identifies the grant to revoke.RevokeGrantRequest.BuilderkeyId(String keyId)A unique identifier for the KMS key associated with the grant.RevokeGrantRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)RevokeGrantRequest.BuilderoverrideConfiguration(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
RevokeGrantRequest.Builder keyId(String keyId)
A unique identifier for the KMS key associated with the grant. To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.
- Parameters:
keyId- A unique identifier for the KMS key associated with the grant. To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
grantId
RevokeGrantRequest.Builder grantId(String grantId)
Identifies the grant to revoke. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.
- Parameters:
grantId- Identifies the grant to revoke. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dryRun
RevokeGrantRequest.Builder dryRun(Boolean dryRun)
Checks if your request will succeed.
DryRunis an optional parameter.To learn more about how to use this parameter, see Testing your permissions in the Key Management Service Developer Guide.
- Parameters:
dryRun- Checks if your request will succeed.DryRunis an optional parameter.To learn more about how to use this parameter, see Testing your permissions in the Key Management Service Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
RevokeGrantRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
RevokeGrantRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-