@Generated(value="software.amazon.awssdk:codegen") public interface KmsAsyncClient extends SdkClient
builder()
method.
AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide .
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.
Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.
Signing Requests
Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.
All AWS KMS operations require Signature Version 4.
Logging API Requests
AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
Additional Resources
For more information about credentials and request signing, see the following:
AWS Security Credentials - This topic provides general information about the of credentials used for accessing AWS.
Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials.
Signature Version 4 Signing Process - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.
Commonly Used APIs
Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static KmsAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
KmsAsyncClient . |
default CompletableFuture<CancelKeyDeletionResponse> |
cancelKeyDeletion(CancelKeyDeletionRequest cancelKeyDeletionRequest)
Cancels the deletion of a customer master key (CMK).
|
default CompletableFuture<CancelKeyDeletionResponse> |
cancelKeyDeletion(Consumer<CancelKeyDeletionRequest.Builder> cancelKeyDeletionRequest)
Cancels the deletion of a customer master key (CMK).
|
default CompletableFuture<ConnectCustomKeyStoreResponse> |
connectCustomKeyStore(ConnectCustomKeyStoreRequest connectCustomKeyStoreRequest)
Connects or reconnects a custom key store to its
associated AWS CloudHSM cluster.
|
default CompletableFuture<ConnectCustomKeyStoreResponse> |
connectCustomKeyStore(Consumer<ConnectCustomKeyStoreRequest.Builder> connectCustomKeyStoreRequest)
Connects or reconnects a custom key store to its
associated AWS CloudHSM cluster.
|
static KmsAsyncClient |
create()
Create a
KmsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateAliasResponse> |
createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest)
Creates a display name for a customer master key (CMK).
|
default CompletableFuture<CreateAliasResponse> |
createAlias(CreateAliasRequest createAliasRequest)
Creates a display name for a customer master key (CMK).
|
default CompletableFuture<CreateCustomKeyStoreResponse> |
createCustomKeyStore(Consumer<CreateCustomKeyStoreRequest.Builder> createCustomKeyStoreRequest)
Creates a custom key
store that is associated with an AWS CloudHSM cluster that you own
and manage.
|
default CompletableFuture<CreateCustomKeyStoreResponse> |
createCustomKeyStore(CreateCustomKeyStoreRequest createCustomKeyStoreRequest)
Creates a custom key
store that is associated with an AWS CloudHSM cluster that you own
and manage.
|
default CompletableFuture<CreateGrantResponse> |
createGrant(Consumer<CreateGrantRequest.Builder> createGrantRequest)
Adds a grant to a customer master key (CMK).
|
default CompletableFuture<CreateGrantResponse> |
createGrant(CreateGrantRequest createGrantRequest)
Adds a grant to a customer master key (CMK).
|
default CompletableFuture<CreateKeyResponse> |
createKey()
Creates a customer master key (CMK) in the caller's AWS account.
|
default CompletableFuture<CreateKeyResponse> |
createKey(Consumer<CreateKeyRequest.Builder> createKeyRequest)
Creates a customer master key (CMK) in the caller's AWS account.
|
default CompletableFuture<CreateKeyResponse> |
createKey(CreateKeyRequest createKeyRequest)
Creates a customer master key (CMK) in the caller's AWS account.
|
default CompletableFuture<DecryptResponse> |
decrypt(Consumer<DecryptRequest.Builder> decryptRequest)
Decrypts ciphertext.
|
default CompletableFuture<DecryptResponse> |
decrypt(DecryptRequest decryptRequest)
Decrypts ciphertext.
|
default CompletableFuture<DeleteAliasResponse> |
deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest)
Deletes the specified alias.
|
default CompletableFuture<DeleteAliasResponse> |
deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes the specified alias.
|
default CompletableFuture<DeleteCustomKeyStoreResponse> |
deleteCustomKeyStore(Consumer<DeleteCustomKeyStoreRequest.Builder> deleteCustomKeyStoreRequest)
Deletes a custom key
store.
|
default CompletableFuture<DeleteCustomKeyStoreResponse> |
deleteCustomKeyStore(DeleteCustomKeyStoreRequest deleteCustomKeyStoreRequest)
Deletes a custom key
store.
|
default CompletableFuture<DeleteImportedKeyMaterialResponse> |
deleteImportedKeyMaterial(Consumer<DeleteImportedKeyMaterialRequest.Builder> deleteImportedKeyMaterialRequest)
Deletes key material that you previously imported.
|
default CompletableFuture<DeleteImportedKeyMaterialResponse> |
deleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest deleteImportedKeyMaterialRequest)
Deletes key material that you previously imported.
|
default CompletableFuture<DescribeCustomKeyStoresResponse> |
describeCustomKeyStores()
Gets information about custom key stores in the
account and region.
|
default CompletableFuture<DescribeCustomKeyStoresResponse> |
describeCustomKeyStores(Consumer<DescribeCustomKeyStoresRequest.Builder> describeCustomKeyStoresRequest)
Gets information about custom key stores in the
account and region.
|
default CompletableFuture<DescribeCustomKeyStoresResponse> |
describeCustomKeyStores(DescribeCustomKeyStoresRequest describeCustomKeyStoresRequest)
Gets information about custom key stores in the
account and region.
|
default CompletableFuture<DescribeKeyResponse> |
describeKey(Consumer<DescribeKeyRequest.Builder> describeKeyRequest)
Provides detailed information about the specified customer master key (CMK).
|
default CompletableFuture<DescribeKeyResponse> |
describeKey(DescribeKeyRequest describeKeyRequest)
Provides detailed information about the specified customer master key (CMK).
|
default CompletableFuture<DisableKeyResponse> |
disableKey(Consumer<DisableKeyRequest.Builder> disableKeyRequest)
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic
operations.
|
default CompletableFuture<DisableKeyResponse> |
disableKey(DisableKeyRequest disableKeyRequest)
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic
operations.
|
default CompletableFuture<DisableKeyRotationResponse> |
disableKeyRotation(Consumer<DisableKeyRotationRequest.Builder> disableKeyRotationRequest)
Disables automatic rotation of
the key material for the specified customer master key (CMK).
|
default CompletableFuture<DisableKeyRotationResponse> |
disableKeyRotation(DisableKeyRotationRequest disableKeyRotationRequest)
Disables automatic rotation of
the key material for the specified customer master key (CMK).
|
default CompletableFuture<DisconnectCustomKeyStoreResponse> |
disconnectCustomKeyStore(Consumer<DisconnectCustomKeyStoreRequest.Builder> disconnectCustomKeyStoreRequest)
Disconnects the custom key
store from its associated AWS CloudHSM cluster.
|
default CompletableFuture<DisconnectCustomKeyStoreResponse> |
disconnectCustomKeyStore(DisconnectCustomKeyStoreRequest disconnectCustomKeyStoreRequest)
Disconnects the custom key
store from its associated AWS CloudHSM cluster.
|
default CompletableFuture<EnableKeyResponse> |
enableKey(Consumer<EnableKeyRequest.Builder> enableKeyRequest)
Sets the key state of a customer master key (CMK) to enabled.
|
default CompletableFuture<EnableKeyResponse> |
enableKey(EnableKeyRequest enableKeyRequest)
Sets the key state of a customer master key (CMK) to enabled.
|
default CompletableFuture<EnableKeyRotationResponse> |
enableKeyRotation(Consumer<EnableKeyRotationRequest.Builder> enableKeyRotationRequest)
Enables automatic rotation of the
key material for the specified customer master key (CMK).
|
default CompletableFuture<EnableKeyRotationResponse> |
enableKeyRotation(EnableKeyRotationRequest enableKeyRotationRequest)
Enables automatic rotation of the
key material for the specified customer master key (CMK).
|
default CompletableFuture<EncryptResponse> |
encrypt(Consumer<EncryptRequest.Builder> encryptRequest)
Encrypts plaintext into ciphertext by using a customer master key (CMK).
|
default CompletableFuture<EncryptResponse> |
encrypt(EncryptRequest encryptRequest)
Encrypts plaintext into ciphertext by using a customer master key (CMK).
|
default CompletableFuture<GenerateDataKeyResponse> |
generateDataKey(Consumer<GenerateDataKeyRequest.Builder> generateDataKeyRequest)
Returns a data encryption key that you can use in your application to encrypt data locally.
|
default CompletableFuture<GenerateDataKeyResponse> |
generateDataKey(GenerateDataKeyRequest generateDataKeyRequest)
Returns a data encryption key that you can use in your application to encrypt data locally.
|
default CompletableFuture<GenerateDataKeyWithoutPlaintextResponse> |
generateDataKeyWithoutPlaintext(Consumer<GenerateDataKeyWithoutPlaintextRequest.Builder> generateDataKeyWithoutPlaintextRequest)
Returns a data encryption key encrypted under a customer master key (CMK).
|
default CompletableFuture<GenerateDataKeyWithoutPlaintextResponse> |
generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest)
Returns a data encryption key encrypted under a customer master key (CMK).
|
default CompletableFuture<GenerateRandomResponse> |
generateRandom()
Returns a random byte string that is cryptographically secure.
|
default CompletableFuture<GenerateRandomResponse> |
generateRandom(Consumer<GenerateRandomRequest.Builder> generateRandomRequest)
Returns a random byte string that is cryptographically secure.
|
default CompletableFuture<GenerateRandomResponse> |
generateRandom(GenerateRandomRequest generateRandomRequest)
Returns a random byte string that is cryptographically secure.
|
default CompletableFuture<GetKeyPolicyResponse> |
getKeyPolicy(Consumer<GetKeyPolicyRequest.Builder> getKeyPolicyRequest)
Gets a key policy attached to the specified customer master key (CMK).
|
default CompletableFuture<GetKeyPolicyResponse> |
getKeyPolicy(GetKeyPolicyRequest getKeyPolicyRequest)
Gets a key policy attached to the specified customer master key (CMK).
|
default CompletableFuture<GetKeyRotationStatusResponse> |
getKeyRotationStatus(Consumer<GetKeyRotationStatusRequest.Builder> getKeyRotationStatusRequest)
Gets a Boolean value that indicates whether automatic rotation of the key
material is enabled for the specified customer master key (CMK).
|
default CompletableFuture<GetKeyRotationStatusResponse> |
getKeyRotationStatus(GetKeyRotationStatusRequest getKeyRotationStatusRequest)
Gets a Boolean value that indicates whether automatic rotation of the key
material is enabled for the specified customer master key (CMK).
|
default CompletableFuture<GetParametersForImportResponse> |
getParametersForImport(Consumer<GetParametersForImportRequest.Builder> getParametersForImportRequest)
Returns the items you need in order to import key material into AWS KMS from your existing key management
infrastructure.
|
default CompletableFuture<GetParametersForImportResponse> |
getParametersForImport(GetParametersForImportRequest getParametersForImportRequest)
Returns the items you need in order to import key material into AWS KMS from your existing key management
infrastructure.
|
default CompletableFuture<ImportKeyMaterialResponse> |
importKeyMaterial(Consumer<ImportKeyMaterialRequest.Builder> importKeyMaterialRequest)
Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material.
|
default CompletableFuture<ImportKeyMaterialResponse> |
importKeyMaterial(ImportKeyMaterialRequest importKeyMaterialRequest)
Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material.
|
default CompletableFuture<ListAliasesResponse> |
listAliases()
Gets a list of all aliases in the caller's AWS account and region.
|
default CompletableFuture<ListAliasesResponse> |
listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
Gets a list of all aliases in the caller's AWS account and region.
|
default CompletableFuture<ListAliasesResponse> |
listAliases(ListAliasesRequest listAliasesRequest)
Gets a list of all aliases in the caller's AWS account and region.
|
default ListAliasesPublisher |
listAliasesPaginator()
Gets a list of all aliases in the caller's AWS account and region.
|
default ListAliasesPublisher |
listAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
Gets a list of all aliases in the caller's AWS account and region.
|
default ListAliasesPublisher |
listAliasesPaginator(ListAliasesRequest listAliasesRequest)
Gets a list of all aliases in the caller's AWS account and region.
|
default CompletableFuture<ListGrantsResponse> |
listGrants(Consumer<ListGrantsRequest.Builder> listGrantsRequest)
Gets a list of all grants for the specified customer master key (CMK).
|
default CompletableFuture<ListGrantsResponse> |
listGrants(ListGrantsRequest listGrantsRequest)
Gets a list of all grants for the specified customer master key (CMK).
|
default ListGrantsPublisher |
listGrantsPaginator(Consumer<ListGrantsRequest.Builder> listGrantsRequest)
Gets a list of all grants for the specified customer master key (CMK).
|
default ListGrantsPublisher |
listGrantsPaginator(ListGrantsRequest listGrantsRequest)
Gets a list of all grants for the specified customer master key (CMK).
|
default CompletableFuture<ListKeyPoliciesResponse> |
listKeyPolicies(Consumer<ListKeyPoliciesRequest.Builder> listKeyPoliciesRequest)
Gets the names of the key policies that are attached to a customer master key (CMK).
|
default CompletableFuture<ListKeyPoliciesResponse> |
listKeyPolicies(ListKeyPoliciesRequest listKeyPoliciesRequest)
Gets the names of the key policies that are attached to a customer master key (CMK).
|
default ListKeyPoliciesPublisher |
listKeyPoliciesPaginator(Consumer<ListKeyPoliciesRequest.Builder> listKeyPoliciesRequest)
Gets the names of the key policies that are attached to a customer master key (CMK).
|
default ListKeyPoliciesPublisher |
listKeyPoliciesPaginator(ListKeyPoliciesRequest listKeyPoliciesRequest)
Gets the names of the key policies that are attached to a customer master key (CMK).
|
default CompletableFuture<ListKeysResponse> |
listKeys()
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
|
default CompletableFuture<ListKeysResponse> |
listKeys(Consumer<ListKeysRequest.Builder> listKeysRequest)
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
|
default CompletableFuture<ListKeysResponse> |
listKeys(ListKeysRequest listKeysRequest)
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
|
default ListKeysPublisher |
listKeysPaginator()
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
|
default ListKeysPublisher |
listKeysPaginator(Consumer<ListKeysRequest.Builder> listKeysRequest)
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
|
default ListKeysPublisher |
listKeysPaginator(ListKeysRequest listKeysRequest)
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
|
default CompletableFuture<ListResourceTagsResponse> |
listResourceTags(Consumer<ListResourceTagsRequest.Builder> listResourceTagsRequest)
Returns a list of all tags for the specified customer master key (CMK).
|
default CompletableFuture<ListResourceTagsResponse> |
listResourceTags(ListResourceTagsRequest listResourceTagsRequest)
Returns a list of all tags for the specified customer master key (CMK).
|
default CompletableFuture<ListRetirableGrantsResponse> |
listRetirableGrants(Consumer<ListRetirableGrantsRequest.Builder> listRetirableGrantsRequest)
Returns a list of all grants for which the grant's
RetiringPrincipal matches the one specified. |
default CompletableFuture<ListRetirableGrantsResponse> |
listRetirableGrants(ListRetirableGrantsRequest listRetirableGrantsRequest)
Returns a list of all grants for which the grant's
RetiringPrincipal matches the one specified. |
default CompletableFuture<PutKeyPolicyResponse> |
putKeyPolicy(Consumer<PutKeyPolicyRequest.Builder> putKeyPolicyRequest)
Attaches a key policy to the specified customer master key (CMK).
|
default CompletableFuture<PutKeyPolicyResponse> |
putKeyPolicy(PutKeyPolicyRequest putKeyPolicyRequest)
Attaches a key policy to the specified customer master key (CMK).
|
default CompletableFuture<ReEncryptResponse> |
reEncrypt(Consumer<ReEncryptRequest.Builder> reEncryptRequest)
Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data
on the client side.
|
default CompletableFuture<ReEncryptResponse> |
reEncrypt(ReEncryptRequest reEncryptRequest)
Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data
on the client side.
|
default CompletableFuture<RetireGrantResponse> |
retireGrant()
Retires a grant.
|
default CompletableFuture<RetireGrantResponse> |
retireGrant(Consumer<RetireGrantRequest.Builder> retireGrantRequest)
Retires a grant.
|
default CompletableFuture<RetireGrantResponse> |
retireGrant(RetireGrantRequest retireGrantRequest)
Retires a grant.
|
default CompletableFuture<RevokeGrantResponse> |
revokeGrant(Consumer<RevokeGrantRequest.Builder> revokeGrantRequest)
Revokes the specified grant for the specified customer master key (CMK).
|
default CompletableFuture<RevokeGrantResponse> |
revokeGrant(RevokeGrantRequest revokeGrantRequest)
Revokes the specified grant for the specified customer master key (CMK).
|
default CompletableFuture<ScheduleKeyDeletionResponse> |
scheduleKeyDeletion(Consumer<ScheduleKeyDeletionRequest.Builder> scheduleKeyDeletionRequest)
Schedules the deletion of a customer master key (CMK).
|
default CompletableFuture<ScheduleKeyDeletionResponse> |
scheduleKeyDeletion(ScheduleKeyDeletionRequest scheduleKeyDeletionRequest)
Schedules the deletion of a customer master key (CMK).
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or edits tags for a customer master key (CMK).
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Adds or edits tags for a customer master key (CMK).
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the specified tags from the specified customer master key (CMK).
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified customer master key (CMK).
|
default CompletableFuture<UpdateAliasResponse> |
updateAlias(Consumer<UpdateAliasRequest.Builder> updateAliasRequest)
Associates an existing alias with a different customer master key (CMK).
|
default CompletableFuture<UpdateAliasResponse> |
updateAlias(UpdateAliasRequest updateAliasRequest)
Associates an existing alias with a different customer master key (CMK).
|
default CompletableFuture<UpdateCustomKeyStoreResponse> |
updateCustomKeyStore(Consumer<UpdateCustomKeyStoreRequest.Builder> updateCustomKeyStoreRequest)
Changes the properties of a custom key store.
|
default CompletableFuture<UpdateCustomKeyStoreResponse> |
updateCustomKeyStore(UpdateCustomKeyStoreRequest updateCustomKeyStoreRequest)
Changes the properties of a custom key store.
|
default CompletableFuture<UpdateKeyDescriptionResponse> |
updateKeyDescription(Consumer<UpdateKeyDescriptionRequest.Builder> updateKeyDescriptionRequest)
Updates the description of a customer master key (CMK).
|
default CompletableFuture<UpdateKeyDescriptionResponse> |
updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest)
Updates the description of a customer master key (CMK).
|
serviceName
close
static final String SERVICE_NAME
static KmsAsyncClient create()
KmsAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static KmsAsyncClientBuilder builder()
KmsAsyncClient
.default CompletableFuture<CancelKeyDeletionResponse> cancelKeyDeletion(CancelKeyDeletionRequest cancelKeyDeletionRequest)
Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the
Disabled
state. To enable a CMK, use EnableKey. You cannot perform this operation on a CMK in
a different AWS account.
For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
cancelKeyDeletionRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<CancelKeyDeletionResponse> cancelKeyDeletion(Consumer<CancelKeyDeletionRequest.Builder> cancelKeyDeletionRequest)
Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the
Disabled
state. To enable a CMK, use EnableKey. You cannot perform this operation on a CMK in
a different AWS account.
For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the CancelKeyDeletionRequest.Builder
avoiding the need
to create one manually via CancelKeyDeletionRequest.builder()
cancelKeyDeletionRequest
- A Consumer
that will call methods on CancelKeyDeletionRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<ConnectCustomKeyStoreResponse> connectCustomKeyStore(ConnectCustomKeyStoreRequest connectCustomKeyStoreRequest)
Connects or reconnects a custom key store to its associated AWS CloudHSM cluster.
The custom key store must be connected before you can create customer master keys (CMKs) in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key store at any time.
To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs to the cluster, use the CreateHsm operation.
The connection process can take an extended amount of time to complete; up to 20 minutes. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the DescribeCustomKeyStores operation.
During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the custom key
store, creates the connection infrastructure, connects to the cluster, logs into the AWS CloudHSM client as the
kmsuser
crypto user (CU), and rotates its password.
The ConnectCustomKeyStore
operation might fail for various reasons. To find the reason, use the
DescribeCustomKeyStores operation and see the ConnectionErrorCode
in the response. For help
interpreting the ConnectionErrorCode
, see CustomKeyStoresListEntry.
To fix the failure, use the DisconnectCustomKeyStore operation to disconnect the custom key store, correct
the error, use the UpdateCustomKeyStore operation if necessary, and then use
ConnectCustomKeyStore
again.
If you are having trouble connecting or disconnecting a custom key store, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
connectCustomKeyStoreRequest
- ConnectionState
of the custom key store. To get the ConnectionState
of a custom
key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState
is
CONNECTED
.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState
is DISCONNECTED
.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState
of DISCONNECTING
or FAILED
. This operation is
valid for all other ConnectionState
values.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about creating a private subnet for a AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. To add HSMs, use the AWS CloudHSM CreateHsm operation.
default CompletableFuture<ConnectCustomKeyStoreResponse> connectCustomKeyStore(Consumer<ConnectCustomKeyStoreRequest.Builder> connectCustomKeyStoreRequest)
Connects or reconnects a custom key store to its associated AWS CloudHSM cluster.
The custom key store must be connected before you can create customer master keys (CMKs) in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key store at any time.
To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs to the cluster, use the CreateHsm operation.
The connection process can take an extended amount of time to complete; up to 20 minutes. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the DescribeCustomKeyStores operation.
During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the custom key
store, creates the connection infrastructure, connects to the cluster, logs into the AWS CloudHSM client as the
kmsuser
crypto user (CU), and rotates its password.
The ConnectCustomKeyStore
operation might fail for various reasons. To find the reason, use the
DescribeCustomKeyStores operation and see the ConnectionErrorCode
in the response. For help
interpreting the ConnectionErrorCode
, see CustomKeyStoresListEntry.
To fix the failure, use the DisconnectCustomKeyStore operation to disconnect the custom key store, correct
the error, use the UpdateCustomKeyStore operation if necessary, and then use
ConnectCustomKeyStore
again.
If you are having trouble connecting or disconnecting a custom key store, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the ConnectCustomKeyStoreRequest.Builder
avoiding the
need to create one manually via ConnectCustomKeyStoreRequest.builder()
connectCustomKeyStoreRequest
- A Consumer
that will call methods on ConnectCustomKeyStoreRequest.Builder
to create a
request.ConnectionState
of the custom key store. To get the ConnectionState
of a custom
key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState
is
CONNECTED
.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState
is DISCONNECTED
.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState
of DISCONNECTING
or FAILED
. This operation is
valid for all other ConnectionState
values.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about creating a private subnet for a AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. To add HSMs, use the AWS CloudHSM CreateHsm operation.
default CompletableFuture<CreateAliasResponse> createAlias(CreateAliasRequest createAliasRequest)
Creates a display name for a customer master key (CMK). You can use an alias to identify a CMK in selected operations, such as Encrypt and GenerateDataKey.
Each CMK can have multiple aliases, but each alias points to only one CMK. The alias name must be unique in the AWS account and region. To simplify code that runs in multiple regions, use the same alias name, but point it to a different CMK in each region.
Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.
An alias must start with the word alias
followed by a forward slash (alias/
). The alias
name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names
cannot begin with aws
; that alias name prefix is reserved by Amazon Web Services (AWS).
The alias and the CMK it is mapped to must be in the same AWS account and the same region. You cannot perform this operation on an alias in a different AWS account.
To map an existing alias to a different CMK, call UpdateAlias.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
createAliasRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<CreateAliasResponse> createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest)
Creates a display name for a customer master key (CMK). You can use an alias to identify a CMK in selected operations, such as Encrypt and GenerateDataKey.
Each CMK can have multiple aliases, but each alias points to only one CMK. The alias name must be unique in the AWS account and region. To simplify code that runs in multiple regions, use the same alias name, but point it to a different CMK in each region.
Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.
An alias must start with the word alias
followed by a forward slash (alias/
). The alias
name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names
cannot begin with aws
; that alias name prefix is reserved by Amazon Web Services (AWS).
The alias and the CMK it is mapped to must be in the same AWS account and the same region. You cannot perform this operation on an alias in a different AWS account.
To map an existing alias to a different CMK, call UpdateAlias.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the CreateAliasRequest.Builder
avoiding the need to
create one manually via CreateAliasRequest.builder()
createAliasRequest
- A Consumer
that will call methods on CreateAliasRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<CreateCustomKeyStoreResponse> createCustomKeyStore(CreateCustomKeyStoreRequest createCustomKeyStoreRequest)
Creates a custom key store that is associated with an AWS CloudHSM cluster that you own and manage.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its AWS CloudHSM cluster.
The CreateCustomKeyStore
operation requires the following elements.
You must specify an active AWS CloudHSM cluster in the same account and AWS Region as the custom key store. You can use an existing cluster or create and activate a new AWS CloudHSM cluster for the key store. AWS KMS does not require exclusive use of the cluster.
You must include the content of the trust anchor certificate for the cluster. You created this
certificate, and saved it in the customerCA.crt
file, when you initialized the
cluster.
You must provide the password of the dedicated
kmsuser
crypto user (CU) account in the cluster.
Before you create the custom key store, use the createUser
command in cloudhsm_mgmt_util
to create a crypto user
(CU) named kmsuser
in specified AWS CloudHSM cluster. AWS KMS uses the kmsuser
CU
account to create and manage key material on your behalf. For instructions, see Create the
kmsuser Crypto User in the AWS Key Management Service Developer Guide.
The AWS CloudHSM cluster that you specify must meet the following requirements.
The cluster must be active and be in the same AWS account and Region as the custom key store.
Each custom key store must be associated with a different AWS CloudHSM cluster. The cluster cannot be associated with another custom key store or have the same cluster certificate as a cluster that is associated with another custom key store. To view the cluster certificate, use the AWS CloudHSM DescribeClusters operation. Clusters that share a backup history have the same cluster certificate.
The cluster must be configured with subnets in at least two different Availability Zones in the Region. Because AWS CloudHSM is not supported in all Availability Zones, we recommend that the cluster have subnets in all Availability Zones in the Region.
The cluster must contain at least two active HSMs, each in a different Availability Zone.
New custom key stores are not automatically connected. After you create your custom key store, use the ConnectCustomKeyStore operation to connect the custom key store to its associated AWS CloudHSM cluster. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it.
If this operation succeeds, it returns the ID of the new custom key store. For help with failures, see Troubleshoot a Custom Key Store in the AWS KMS Developer Guide.
createCustomKeyStoreRequest
- Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.
When you initialize
the cluster, you create the trust anchor certificate and save it in the customerCA.crt
file.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about creating a private subnet for a AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. To add HSMs, use the AWS CloudHSM CreateHsm operation.
default CompletableFuture<CreateCustomKeyStoreResponse> createCustomKeyStore(Consumer<CreateCustomKeyStoreRequest.Builder> createCustomKeyStoreRequest)
Creates a custom key store that is associated with an AWS CloudHSM cluster that you own and manage.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its AWS CloudHSM cluster.
The CreateCustomKeyStore
operation requires the following elements.
You must specify an active AWS CloudHSM cluster in the same account and AWS Region as the custom key store. You can use an existing cluster or create and activate a new AWS CloudHSM cluster for the key store. AWS KMS does not require exclusive use of the cluster.
You must include the content of the trust anchor certificate for the cluster. You created this
certificate, and saved it in the customerCA.crt
file, when you initialized the
cluster.
You must provide the password of the dedicated
kmsuser
crypto user (CU) account in the cluster.
Before you create the custom key store, use the createUser
command in cloudhsm_mgmt_util
to create a crypto user
(CU) named kmsuser
in specified AWS CloudHSM cluster. AWS KMS uses the kmsuser
CU
account to create and manage key material on your behalf. For instructions, see Create the
kmsuser Crypto User in the AWS Key Management Service Developer Guide.
The AWS CloudHSM cluster that you specify must meet the following requirements.
The cluster must be active and be in the same AWS account and Region as the custom key store.
Each custom key store must be associated with a different AWS CloudHSM cluster. The cluster cannot be associated with another custom key store or have the same cluster certificate as a cluster that is associated with another custom key store. To view the cluster certificate, use the AWS CloudHSM DescribeClusters operation. Clusters that share a backup history have the same cluster certificate.
The cluster must be configured with subnets in at least two different Availability Zones in the Region. Because AWS CloudHSM is not supported in all Availability Zones, we recommend that the cluster have subnets in all Availability Zones in the Region.
The cluster must contain at least two active HSMs, each in a different Availability Zone.
New custom key stores are not automatically connected. After you create your custom key store, use the ConnectCustomKeyStore operation to connect the custom key store to its associated AWS CloudHSM cluster. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it.
If this operation succeeds, it returns the ID of the new custom key store. For help with failures, see Troubleshoot a Custom Key Store in the AWS KMS Developer Guide.
This is a convenience which creates an instance of the CreateCustomKeyStoreRequest.Builder
avoiding the
need to create one manually via CreateCustomKeyStoreRequest.builder()
createCustomKeyStoreRequest
- A Consumer
that will call methods on CreateCustomKeyStoreRequest.Builder
to create a
request.Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.
When you initialize
the cluster, you create the trust anchor certificate and save it in the customerCA.crt
file.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about creating a private subnet for a AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. To add HSMs, use the AWS CloudHSM CreateHsm operation.
default CompletableFuture<CreateGrantResponse> createGrant(CreateGrantRequest createGrantRequest)
Adds a grant to a customer master key (CMK). The grant specifies who can use the CMK and under what conditions. When setting permissions, grants are an alternative to key policies.
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter. For more information about grants, see Grants in the AWS Key Management
Service Developer Guide.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
createGrantRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<CreateGrantResponse> createGrant(Consumer<CreateGrantRequest.Builder> createGrantRequest)
Adds a grant to a customer master key (CMK). The grant specifies who can use the CMK and under what conditions. When setting permissions, grants are an alternative to key policies.
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter. For more information about grants, see Grants in the AWS Key Management
Service Developer Guide.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the CreateGrantRequest.Builder
avoiding the need to
create one manually via CreateGrantRequest.builder()
createGrantRequest
- A Consumer
that will call methods on CreateGrantRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<CreateKeyResponse> createKey(CreateKeyRequest createKeyRequest)
Creates a customer master key (CMK) in the caller's AWS account.
You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data keys, which are used to encrypt raw data. For more information about data keys and the difference between CMKs and data keys, see the following:
The GenerateDataKey operation
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
If you plan to import key
material, use the Origin
parameter with a value of EXTERNAL
to create a CMK with no
key material.
To create a CMK in a custom key store, use
CustomKeyStoreId
parameter to specify the custom key store. You must also use the
Origin
parameter with a value of AWS_CLOUDHSM
. The AWS CloudHSM cluster that is
associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in
the Region.
You cannot use this operation to create a CMK in a different AWS account.
createKeyRequest
- ConnectionState
of the custom key store. To get the ConnectionState
of a custom
key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState
is
CONNECTED
.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState
is DISCONNECTED
.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState
of DISCONNECTING
or FAILED
. This operation is
valid for all other ConnectionState
values.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about creating a private subnet for a AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. To add HSMs, use the AWS CloudHSM CreateHsm operation.
default CompletableFuture<CreateKeyResponse> createKey(Consumer<CreateKeyRequest.Builder> createKeyRequest)
Creates a customer master key (CMK) in the caller's AWS account.
You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data keys, which are used to encrypt raw data. For more information about data keys and the difference between CMKs and data keys, see the following:
The GenerateDataKey operation
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
If you plan to import key
material, use the Origin
parameter with a value of EXTERNAL
to create a CMK with no
key material.
To create a CMK in a custom key store, use
CustomKeyStoreId
parameter to specify the custom key store. You must also use the
Origin
parameter with a value of AWS_CLOUDHSM
. The AWS CloudHSM cluster that is
associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in
the Region.
You cannot use this operation to create a CMK in a different AWS account.
This is a convenience which creates an instance of the CreateKeyRequest.Builder
avoiding the need to
create one manually via CreateKeyRequest.builder()
createKeyRequest
- A Consumer
that will call methods on CreateKeyRequest.Builder
to create a request.ConnectionState
of the custom key store. To get the ConnectionState
of a custom
key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState
is
CONNECTED
.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState
is DISCONNECTED
.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState
of DISCONNECTING
or FAILED
. This operation is
valid for all other ConnectionState
values.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about creating a private subnet for a AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. To add HSMs, use the AWS CloudHSM CreateHsm operation.
default CompletableFuture<CreateKeyResponse> createKey()
Creates a customer master key (CMK) in the caller's AWS account.
You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data keys, which are used to encrypt raw data. For more information about data keys and the difference between CMKs and data keys, see the following:
The GenerateDataKey operation
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
If you plan to import key
material, use the Origin
parameter with a value of EXTERNAL
to create a CMK with no
key material.
To create a CMK in a custom key store, use
CustomKeyStoreId
parameter to specify the custom key store. You must also use the
Origin
parameter with a value of AWS_CLOUDHSM
. The AWS CloudHSM cluster that is
associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in
the Region.
You cannot use this operation to create a CMK in a different AWS account.
ConnectionState
of the custom key store. To get the ConnectionState
of a custom
key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState
is
CONNECTED
.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState
is DISCONNECTED
.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState
of DISCONNECTING
or FAILED
. This operation is
valid for all other ConnectionState
values.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about creating a private subnet for a AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. To add HSMs, use the AWS CloudHSM CreateHsm operation.
default CompletableFuture<DecryptResponse> decrypt(DecryptRequest decryptRequest)
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following operations:
Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies
that grant Decrypt
permission on all resources), then ciphertext encrypted by using keys in other
accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not
grant Decrypt
access in an IAM user policy. Instead grant Decrypt
access only in key
policies. If you must grant Decrypt
access in an IAM user policy, you should scope the resource to
specific keys or to specific trusted accounts.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
decryptRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<DecryptResponse> decrypt(Consumer<DecryptRequest.Builder> decryptRequest)
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following operations:
Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies
that grant Decrypt
permission on all resources), then ciphertext encrypted by using keys in other
accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not
grant Decrypt
access in an IAM user policy. Instead grant Decrypt
access only in key
policies. If you must grant Decrypt
access in an IAM user policy, you should scope the resource to
specific keys or to specific trusted accounts.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the DecryptRequest.Builder
avoiding the need to create
one manually via DecryptRequest.builder()
decryptRequest
- A Consumer
that will call methods on DecryptRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<DeleteAliasResponse> deleteAlias(DeleteAliasRequest deleteAliasRequest)
Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account.
Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.
Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different customer master key (CMK), call UpdateAlias.
deleteAliasRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<DeleteAliasResponse> deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest)
Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account.
Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.
Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different customer master key (CMK), call UpdateAlias.
This is a convenience which creates an instance of the DeleteAliasRequest.Builder
avoiding the need to
create one manually via DeleteAliasRequest.builder()
deleteAliasRequest
- A Consumer
that will call methods on DeleteAliasRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<DeleteCustomKeyStoreResponse> deleteCustomKeyStore(DeleteCustomKeyStoreRequest deleteCustomKeyStoreRequest)
Deletes a custom key store. This operation does not delete the AWS CloudHSM cluster that is associated with the custom key store, or affect any users or keys in the cluster.
The custom key store that you delete cannot contain any AWS KMS customer master keys
(CMKs). Before deleting the key store, verify that you will never need to use any of the CMKs in the key
store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the AWS KMS customer
master keys (CMKs) from the key store. When the scheduled waiting period expires, the
ScheduleKeyDeletion
operation deletes the CMKs. Then it makes a best effort to delete the key
material from the associated cluster. However, you might need to manually delete
the orphaned key material from the cluster and its backups.
After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore to disconnect the key store from AWS KMS. Then, you can delete the custom key store.
Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from AWS KMS. While the key store is disconnected, you cannot create or use the CMKs in the key store. But, you do not need to delete CMKs and you can reconnect a disconnected custom key store at any time.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
deleteCustomKeyStoreRequest
- ConnectionState
of the custom key store. To get the ConnectionState
of a custom
key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState
is
CONNECTED
.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState
is DISCONNECTED
.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState
of DISCONNECTING
or FAILED
. This operation is
valid for all other ConnectionState
values.
default CompletableFuture<DeleteCustomKeyStoreResponse> deleteCustomKeyStore(Consumer<DeleteCustomKeyStoreRequest.Builder> deleteCustomKeyStoreRequest)
Deletes a custom key store. This operation does not delete the AWS CloudHSM cluster that is associated with the custom key store, or affect any users or keys in the cluster.
The custom key store that you delete cannot contain any AWS KMS customer master keys
(CMKs). Before deleting the key store, verify that you will never need to use any of the CMKs in the key
store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the AWS KMS customer
master keys (CMKs) from the key store. When the scheduled waiting period expires, the
ScheduleKeyDeletion
operation deletes the CMKs. Then it makes a best effort to delete the key
material from the associated cluster. However, you might need to manually delete
the orphaned key material from the cluster and its backups.
After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore to disconnect the key store from AWS KMS. Then, you can delete the custom key store.
Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from AWS KMS. While the key store is disconnected, you cannot create or use the CMKs in the key store. But, you do not need to delete CMKs and you can reconnect a disconnected custom key store at any time.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
This is a convenience which creates an instance of the DeleteCustomKeyStoreRequest.Builder
avoiding the
need to create one manually via DeleteCustomKeyStoreRequest.builder()
deleteCustomKeyStoreRequest
- A Consumer
that will call methods on DeleteCustomKeyStoreRequest.Builder
to create a
request.ConnectionState
of the custom key store. To get the ConnectionState
of a custom
key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState
is
CONNECTED
.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState
is DISCONNECTED
.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState
of DISCONNECTING
or FAILED
. This operation is
valid for all other ConnectionState
values.
default CompletableFuture<DeleteImportedKeyMaterialResponse> deleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest deleteImportedKeyMaterialRequest)
Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. You cannot perform this operation on a CMK in a different AWS account.
When the specified CMK is in the PendingDeletion
state, this operation does not change the CMK's
state. Otherwise, it changes the CMK's state to PendingImport
.
After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
deleteImportedKeyMaterialRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<DeleteImportedKeyMaterialResponse> deleteImportedKeyMaterial(Consumer<DeleteImportedKeyMaterialRequest.Builder> deleteImportedKeyMaterialRequest)
Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. You cannot perform this operation on a CMK in a different AWS account.
When the specified CMK is in the PendingDeletion
state, this operation does not change the CMK's
state. Otherwise, it changes the CMK's state to PendingImport
.
After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the DeleteImportedKeyMaterialRequest.Builder
avoiding
the need to create one manually via DeleteImportedKeyMaterialRequest.builder()
deleteImportedKeyMaterialRequest
- A Consumer
that will call methods on DeleteImportedKeyMaterialRequest.Builder
to create a
request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<DescribeCustomKeyStoresResponse> describeCustomKeyStores(DescribeCustomKeyStoresRequest describeCustomKeyStoresRequest)
Gets information about custom key stores in the account and region.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
By default, this operation returns information about all custom key stores in the account and region. To get only
information about a particular custom key store, use either the CustomKeyStoreName
or
CustomKeyStoreId
parameter (but not both).
To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the
ConnectionState
element in the response. If an attempt to connect the custom key store failed, the
ConnectionState
value is FAILED
and the ConnectionErrorCode
element in the
response indicates the cause of the failure. For help interpreting the ConnectionErrorCode
, see
CustomKeyStoresListEntry.
Custom key stores have a DISCONNECTED
connection state if the key store has never been connected or
you use the DisconnectCustomKeyStore operation to disconnect it. If your custom key store state is
CONNECTED
but you are having trouble using it, make sure that its associated AWS CloudHSM cluster is
active and contains the minimum number of HSMs required for the operation, if any.
For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the AWS Key Management Service Developer Guide.
describeCustomKeyStoresRequest
- default CompletableFuture<DescribeCustomKeyStoresResponse> describeCustomKeyStores(Consumer<DescribeCustomKeyStoresRequest.Builder> describeCustomKeyStoresRequest)
Gets information about custom key stores in the account and region.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
By default, this operation returns information about all custom key stores in the account and region. To get only
information about a particular custom key store, use either the CustomKeyStoreName
or
CustomKeyStoreId
parameter (but not both).
To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the
ConnectionState
element in the response. If an attempt to connect the custom key store failed, the
ConnectionState
value is FAILED
and the ConnectionErrorCode
element in the
response indicates the cause of the failure. For help interpreting the ConnectionErrorCode
, see
CustomKeyStoresListEntry.
Custom key stores have a DISCONNECTED
connection state if the key store has never been connected or
you use the DisconnectCustomKeyStore operation to disconnect it. If your custom key store state is
CONNECTED
but you are having trouble using it, make sure that its associated AWS CloudHSM cluster is
active and contains the minimum number of HSMs required for the operation, if any.
For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the DescribeCustomKeyStoresRequest.Builder
avoiding
the need to create one manually via DescribeCustomKeyStoresRequest.builder()
describeCustomKeyStoresRequest
- A Consumer
that will call methods on DescribeCustomKeyStoresRequest.Builder
to create a
request.default CompletableFuture<DescribeCustomKeyStoresResponse> describeCustomKeyStores()
Gets information about custom key stores in the account and region.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
By default, this operation returns information about all custom key stores in the account and region. To get only
information about a particular custom key store, use either the CustomKeyStoreName
or
CustomKeyStoreId
parameter (but not both).
To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the
ConnectionState
element in the response. If an attempt to connect the custom key store failed, the
ConnectionState
value is FAILED
and the ConnectionErrorCode
element in the
response indicates the cause of the failure. For help interpreting the ConnectionErrorCode
, see
CustomKeyStoresListEntry.
Custom key stores have a DISCONNECTED
connection state if the key store has never been connected or
you use the DisconnectCustomKeyStore operation to disconnect it. If your custom key store state is
CONNECTED
but you are having trouble using it, make sure that its associated AWS CloudHSM cluster is
active and contains the minimum number of HSMs required for the operation, if any.
For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the AWS Key Management Service Developer Guide.
default CompletableFuture<DescribeKeyResponse> describeKey(DescribeKeyRequest describeKeyRequest)
Provides detailed information about the specified customer master key (CMK).
If you use DescribeKey
on a predefined AWS alias, that is, an AWS alias with no key ID, AWS KMS
associates the alias with an AWS managed CMK and
returns its KeyId
and Arn
in the response.
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
describeKeyRequest
- default CompletableFuture<DescribeKeyResponse> describeKey(Consumer<DescribeKeyRequest.Builder> describeKeyRequest)
Provides detailed information about the specified customer master key (CMK).
If you use DescribeKey
on a predefined AWS alias, that is, an AWS alias with no key ID, AWS KMS
associates the alias with an AWS managed CMK and
returns its KeyId
and Arn
in the response.
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
This is a convenience which creates an instance of the DescribeKeyRequest.Builder
avoiding the need to
create one manually via DescribeKeyRequest.builder()
describeKeyRequest
- A Consumer
that will call methods on DescribeKeyRequest.Builder
to create a request.default CompletableFuture<DisableKeyResponse> disableKey(DisableKeyRequest disableKeyRequest)
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.
For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
disableKeyRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<DisableKeyResponse> disableKey(Consumer<DisableKeyRequest.Builder> disableKeyRequest)
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.
For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the DisableKeyRequest.Builder
avoiding the need to
create one manually via DisableKeyRequest.builder()
disableKeyRequest
- A Consumer
that will call methods on DisableKeyRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<DisableKeyRotationResponse> disableKeyRotation(DisableKeyRotationRequest disableKeyRotationRequest)
Disables automatic rotation of the key material for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
disableKeyRotationRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<DisableKeyRotationResponse> disableKeyRotation(Consumer<DisableKeyRotationRequest.Builder> disableKeyRotationRequest)
Disables automatic rotation of the key material for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the DisableKeyRotationRequest.Builder
avoiding the
need to create one manually via DisableKeyRotationRequest.builder()
disableKeyRotationRequest
- A Consumer
that will call methods on DisableKeyRotationRequest.Builder
to create a
request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<DisconnectCustomKeyStoreResponse> disconnectCustomKeyStore(DisconnectCustomKeyStoreRequest disconnectCustomKeyStoreRequest)
Disconnects the custom key store from its associated AWS CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its customer master keys (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the custom key store at any time.
While a custom key store is disconnected, all attempts to create customer master keys (CMKs) in the custom key store or to use existing CMKs in cryptographic operations will fail. This action can prevent users from storing and accessing sensitive data.
To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the ConnectCustomKeyStore operation.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
disconnectCustomKeyStoreRequest
- ConnectionState
of the custom key store. To get the ConnectionState
of a custom
key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState
is
CONNECTED
.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState
is DISCONNECTED
.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState
of DISCONNECTING
or FAILED
. This operation is
valid for all other ConnectionState
values.
default CompletableFuture<DisconnectCustomKeyStoreResponse> disconnectCustomKeyStore(Consumer<DisconnectCustomKeyStoreRequest.Builder> disconnectCustomKeyStoreRequest)
Disconnects the custom key store from its associated AWS CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its customer master keys (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the custom key store at any time.
While a custom key store is disconnected, all attempts to create customer master keys (CMKs) in the custom key store or to use existing CMKs in cryptographic operations will fail. This action can prevent users from storing and accessing sensitive data.
To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the ConnectCustomKeyStore operation.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
This is a convenience which creates an instance of the DisconnectCustomKeyStoreRequest.Builder
avoiding
the need to create one manually via DisconnectCustomKeyStoreRequest.builder()
disconnectCustomKeyStoreRequest
- A Consumer
that will call methods on DisconnectCustomKeyStoreRequest.Builder
to create a
request.ConnectionState
of the custom key store. To get the ConnectionState
of a custom
key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState
is
CONNECTED
.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState
is DISCONNECTED
.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState
of DISCONNECTING
or FAILED
. This operation is
valid for all other ConnectionState
values.
default CompletableFuture<EnableKeyResponse> enableKey(EnableKeyRequest enableKeyRequest)
Sets the key state of a customer master key (CMK) to enabled. This allows you to use the CMK for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
enableKeyRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<EnableKeyResponse> enableKey(Consumer<EnableKeyRequest.Builder> enableKeyRequest)
Sets the key state of a customer master key (CMK) to enabled. This allows you to use the CMK for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the EnableKeyRequest.Builder
avoiding the need to
create one manually via EnableKeyRequest.builder()
enableKeyRequest
- A Consumer
that will call methods on EnableKeyRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<EnableKeyRotationResponse> enableKeyRotation(EnableKeyRotationRequest enableKeyRotationRequest)
Enables automatic rotation of the key material for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
You cannot enable automatic rotation of CMKs with imported key material or CMKs in a custom key store.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
enableKeyRotationRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<EnableKeyRotationResponse> enableKeyRotation(Consumer<EnableKeyRotationRequest.Builder> enableKeyRotationRequest)
Enables automatic rotation of the key material for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
You cannot enable automatic rotation of CMKs with imported key material or CMKs in a custom key store.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the EnableKeyRotationRequest.Builder
avoiding the need
to create one manually via EnableKeyRotationRequest.builder()
enableKeyRotationRequest
- A Consumer
that will call methods on EnableKeyRotationRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<EncryptResponse> encrypt(EncryptRequest encryptRequest)
Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt
operation has
two primary use cases:
You can encrypt up to 4 kilobytes (4096 bytes) of arbitrary data such as an RSA key, a database password, or other sensitive information.
To move encrypted data from one AWS region to another, you can use this operation to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Unless you are moving encrypted data from one region to another, you don't use this operation to encrypt a
generated data key within a region. To get data keys that are already encrypted, call the GenerateDataKey
or GenerateDataKeyWithoutPlaintext operation. Data keys don't need to be encrypted again by calling
Encrypt
.
To encrypt data locally in your application, use the GenerateDataKey operation to return a plaintext data encryption key and a copy of the key encrypted under the CMK of your choosing.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
encryptRequest
- KeySpec
value is
not valid.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<EncryptResponse> encrypt(Consumer<EncryptRequest.Builder> encryptRequest)
Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt
operation has
two primary use cases:
You can encrypt up to 4 kilobytes (4096 bytes) of arbitrary data such as an RSA key, a database password, or other sensitive information.
To move encrypted data from one AWS region to another, you can use this operation to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Unless you are moving encrypted data from one region to another, you don't use this operation to encrypt a
generated data key within a region. To get data keys that are already encrypted, call the GenerateDataKey
or GenerateDataKeyWithoutPlaintext operation. Data keys don't need to be encrypted again by calling
Encrypt
.
To encrypt data locally in your application, use the GenerateDataKey operation to return a plaintext data encryption key and a copy of the key encrypted under the CMK of your choosing.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the EncryptRequest.Builder
avoiding the need to create
one manually via EncryptRequest.builder()
encryptRequest
- A Consumer
that will call methods on EncryptRequest.Builder
to create a request.KeySpec
value is
not valid.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<GenerateDataKeyResponse> generateDataKey(GenerateDataKeyRequest generateDataKeyRequest)
Returns a data encryption key that you can use in your application to encrypt data locally.
You must specify the customer master key (CMK) under which to generate the data key. You must also specify the
length of the data key using either the KeySpec
or NumberOfBytes
field. You must
specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we
recommend that you use KeySpec
. To perform this operation on a CMK in a different AWS account,
specify the key ARN or alias ARN in the value of the KeyId parameter.
This operation returns a plaintext copy of the data key in the Plaintext
field of the response, and
an encrypted copy of the data key in the CiphertextBlob
field. The data key is encrypted under the
CMK specified in the KeyId
field of the request.
We recommend that you use the following pattern to encrypt data locally in your application:
Use this operation (GenerateDataKey
) to get a data encryption key.
Use the plaintext data encryption key (returned in the Plaintext
field of the response) to encrypt
data locally, then erase the plaintext data key from memory.
Store the encrypted data key (returned in the CiphertextBlob
field of the response) alongside the
locally encrypted data.
To decrypt data locally:
Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.
Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.
To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To return a random byte string that is cryptographically secure, use GenerateRandom.
If you use the optional EncryptionContext
field, you must store at least enough information to be
able to reconstruct the full encryption context when you later send the ciphertext to the Decrypt
operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better
secure the ciphertext. For more information, see Encryption Context in the
AWS Key Management Service Developer Guide.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
generateDataKeyRequest
- KeySpec
value is
not valid.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<GenerateDataKeyResponse> generateDataKey(Consumer<GenerateDataKeyRequest.Builder> generateDataKeyRequest)
Returns a data encryption key that you can use in your application to encrypt data locally.
You must specify the customer master key (CMK) under which to generate the data key. You must also specify the
length of the data key using either the KeySpec
or NumberOfBytes
field. You must
specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we
recommend that you use KeySpec
. To perform this operation on a CMK in a different AWS account,
specify the key ARN or alias ARN in the value of the KeyId parameter.
This operation returns a plaintext copy of the data key in the Plaintext
field of the response, and
an encrypted copy of the data key in the CiphertextBlob
field. The data key is encrypted under the
CMK specified in the KeyId
field of the request.
We recommend that you use the following pattern to encrypt data locally in your application:
Use this operation (GenerateDataKey
) to get a data encryption key.
Use the plaintext data encryption key (returned in the Plaintext
field of the response) to encrypt
data locally, then erase the plaintext data key from memory.
Store the encrypted data key (returned in the CiphertextBlob
field of the response) alongside the
locally encrypted data.
To decrypt data locally:
Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.
Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.
To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To return a random byte string that is cryptographically secure, use GenerateRandom.
If you use the optional EncryptionContext
field, you must store at least enough information to be
able to reconstruct the full encryption context when you later send the ciphertext to the Decrypt
operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better
secure the ciphertext. For more information, see Encryption Context in the
AWS Key Management Service Developer Guide.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the GenerateDataKeyRequest.Builder
avoiding the need
to create one manually via GenerateDataKeyRequest.builder()
generateDataKeyRequest
- A Consumer
that will call methods on GenerateDataKeyRequest.Builder
to create a request.KeySpec
value is
not valid.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<GenerateDataKeyWithoutPlaintextResponse> generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest generateDataKeyWithoutPlaintextRequest)
Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to GenerateDataKey but returns only the encrypted copy of the data key.
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
This operation is useful in a system that has multiple components with different degrees of trust. For example,
consider a system that stores encrypted data in containers. Each container stores the encrypted data and an
encrypted copy of the data key. One component of the system, called the control plane, creates new
containers. When it creates a new container, it uses this operation (GenerateDataKeyWithoutPlaintext
) to get an encrypted data key and then stores it in the container. Later, a different component of the system,
called the data plane, puts encrypted data into the containers. To do this, it passes the encrypted data
key to the Decrypt operation, then uses the returned plaintext data key to encrypt data, and finally
stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
generateDataKeyWithoutPlaintextRequest
- KeySpec
value is
not valid.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<GenerateDataKeyWithoutPlaintextResponse> generateDataKeyWithoutPlaintext(Consumer<GenerateDataKeyWithoutPlaintextRequest.Builder> generateDataKeyWithoutPlaintextRequest)
Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to GenerateDataKey but returns only the encrypted copy of the data key.
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
This operation is useful in a system that has multiple components with different degrees of trust. For example,
consider a system that stores encrypted data in containers. Each container stores the encrypted data and an
encrypted copy of the data key. One component of the system, called the control plane, creates new
containers. When it creates a new container, it uses this operation (GenerateDataKeyWithoutPlaintext
) to get an encrypted data key and then stores it in the container. Later, a different component of the system,
called the data plane, puts encrypted data into the containers. To do this, it passes the encrypted data
key to the Decrypt operation, then uses the returned plaintext data key to encrypt data, and finally
stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the GenerateDataKeyWithoutPlaintextRequest.Builder
avoiding the need to create one manually via GenerateDataKeyWithoutPlaintextRequest.builder()
generateDataKeyWithoutPlaintextRequest
- A Consumer
that will call methods on GenerateDataKeyWithoutPlaintextRequest.Builder
to
create a request.KeySpec
value is
not valid.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<GenerateRandomResponse> generateRandom(GenerateRandomRequest generateRandomRequest)
Returns a random byte string that is cryptographically secure.
By default, the random byte string is generated in AWS KMS. To generate the byte string in the AWS CloudHSM cluster that is associated with a custom key store, specify the custom key store ID.
For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.
generateRandomRequest
- ConnectionState
of the custom key store. To get the ConnectionState
of a custom
key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState
is
CONNECTED
.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState
is DISCONNECTED
.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState
of DISCONNECTING
or FAILED
. This operation is
valid for all other ConnectionState
values.
default CompletableFuture<GenerateRandomResponse> generateRandom(Consumer<GenerateRandomRequest.Builder> generateRandomRequest)
Returns a random byte string that is cryptographically secure.
By default, the random byte string is generated in AWS KMS. To generate the byte string in the AWS CloudHSM cluster that is associated with a custom key store, specify the custom key store ID.
For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.
This is a convenience which creates an instance of the GenerateRandomRequest.Builder
avoiding the need to
create one manually via GenerateRandomRequest.builder()
generateRandomRequest
- A Consumer
that will call methods on GenerateRandomRequest.Builder
to create a request.ConnectionState
of the custom key store. To get the ConnectionState
of a custom
key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState
is
CONNECTED
.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState
is DISCONNECTED
.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState
of DISCONNECTING
or FAILED
. This operation is
valid for all other ConnectionState
values.
default CompletableFuture<GenerateRandomResponse> generateRandom()
Returns a random byte string that is cryptographically secure.
By default, the random byte string is generated in AWS KMS. To generate the byte string in the AWS CloudHSM cluster that is associated with a custom key store, specify the custom key store ID.
For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.
ConnectionState
of the custom key store. To get the ConnectionState
of a custom
key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState
is
CONNECTED
.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState
is DISCONNECTED
.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState
of DISCONNECTING
or FAILED
. This operation is
valid for all other ConnectionState
values.
default CompletableFuture<GetKeyPolicyResponse> getKeyPolicy(GetKeyPolicyRequest getKeyPolicyRequest)
Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
getKeyPolicyRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<GetKeyPolicyResponse> getKeyPolicy(Consumer<GetKeyPolicyRequest.Builder> getKeyPolicyRequest)
Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
This is a convenience which creates an instance of the GetKeyPolicyRequest.Builder
avoiding the need to
create one manually via GetKeyPolicyRequest.builder()
getKeyPolicyRequest
- A Consumer
that will call methods on GetKeyPolicyRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<GetKeyRotationStatusResponse> getKeyRotationStatus(GetKeyRotationStatusRequest getKeyRotationStatusRequest)
Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Disabled: The key rotation status does not change when you disable a CMK. However, while the CMK is disabled, AWS KMS does not rotate the backing key.
Pending deletion: While a CMK is pending deletion, its key rotation status is false
and AWS KMS does
not rotate the backing key. If you cancel the deletion, the original key rotation status is restored.
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter.
getKeyRotationStatusRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<GetKeyRotationStatusResponse> getKeyRotationStatus(Consumer<GetKeyRotationStatusRequest.Builder> getKeyRotationStatusRequest)
Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Disabled: The key rotation status does not change when you disable a CMK. However, while the CMK is disabled, AWS KMS does not rotate the backing key.
Pending deletion: While a CMK is pending deletion, its key rotation status is false
and AWS KMS does
not rotate the backing key. If you cancel the deletion, the original key rotation status is restored.
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter.
This is a convenience which creates an instance of the GetKeyRotationStatusRequest.Builder
avoiding the
need to create one manually via GetKeyRotationStatusRequest.builder()
getKeyRotationStatusRequest
- A Consumer
that will call methods on GetKeyRotationStatusRequest.Builder
to create a
request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<GetParametersForImportResponse> getParametersForImport(GetParametersForImportRequest getParametersForImportRequest)
Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's
Origin
must be EXTERNAL
. You must also specify the wrapping algorithm and type of
wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on a
CMK in a different AWS account.
This operation returns a public key and an import token. Use the public key to encrypt the key material. Store
the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from
the same response must be used together. These items are valid for 24 hours. When they expire, they cannot be
used for a subsequent ImportKeyMaterial request. To get new ones, send another
GetParametersForImport
request.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
getParametersForImportRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<GetParametersForImportResponse> getParametersForImport(Consumer<GetParametersForImportRequest.Builder> getParametersForImportRequest)
Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's
Origin
must be EXTERNAL
. You must also specify the wrapping algorithm and type of
wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on a
CMK in a different AWS account.
This operation returns a public key and an import token. Use the public key to encrypt the key material. Store
the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from
the same response must be used together. These items are valid for 24 hours. When they expire, they cannot be
used for a subsequent ImportKeyMaterial request. To get new ones, send another
GetParametersForImport
request.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the GetParametersForImportRequest.Builder
avoiding the
need to create one manually via GetParametersForImportRequest.builder()
getParametersForImportRequest
- A Consumer
that will call methods on GetParametersForImportRequest.Builder
to create a
request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<ImportKeyMaterialResponse> importKeyMaterial(ImportKeyMaterialRequest importKeyMaterialRequest)
Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material. You cannot perform this operation on a CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see Importing Key Material in the AWS Key Management Service Developer Guide.
Before using this operation, call GetParametersForImport. Its response includes a public key and an import
token. Use the public key to encrypt the key material. Then, submit the import token from the same
GetParametersForImport
response.
When calling this operation, you must specify the following values:
The key ID or key ARN of a CMK with no key material. Its Origin
must be EXTERNAL
.
To create a CMK with no key material, call CreateKey and set the value of its Origin
parameter to EXTERNAL
. To get the Origin
of a CMK, call DescribeKey.)
The encrypted key material. To get the public key to encrypt the key material, call GetParametersForImport.
The import token that GetParametersForImport returned. This token and the public key used to encrypt the key material must have come from the same response.
Whether the key material expires and if so, when. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date. If the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you must reimport the same key material.
When this operation is successful, the key state of the CMK changes from PendingImport
to
Enabled
, and you can use the CMK. After you successfully import key material into a CMK, you can
reimport the same key material into that CMK, but you cannot import different key material.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
importKeyMaterialRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<ImportKeyMaterialResponse> importKeyMaterial(Consumer<ImportKeyMaterialRequest.Builder> importKeyMaterialRequest)
Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material. You cannot perform this operation on a CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see Importing Key Material in the AWS Key Management Service Developer Guide.
Before using this operation, call GetParametersForImport. Its response includes a public key and an import
token. Use the public key to encrypt the key material. Then, submit the import token from the same
GetParametersForImport
response.
When calling this operation, you must specify the following values:
The key ID or key ARN of a CMK with no key material. Its Origin
must be EXTERNAL
.
To create a CMK with no key material, call CreateKey and set the value of its Origin
parameter to EXTERNAL
. To get the Origin
of a CMK, call DescribeKey.)
The encrypted key material. To get the public key to encrypt the key material, call GetParametersForImport.
The import token that GetParametersForImport returned. This token and the public key used to encrypt the key material must have come from the same response.
Whether the key material expires and if so, when. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date. If the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you must reimport the same key material.
When this operation is successful, the key state of the CMK changes from PendingImport
to
Enabled
, and you can use the CMK. After you successfully import key material into a CMK, you can
reimport the same key material into that CMK, but you cannot import different key material.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the ImportKeyMaterialRequest.Builder
avoiding the need
to create one manually via ImportKeyMaterialRequest.builder()
importKeyMaterialRequest
- A Consumer
that will call methods on ImportKeyMaterialRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<ListAliasesResponse> listAliases(ListAliasesRequest listAliasesRequest)
Gets a list of all aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.
By default, the ListAliases
command returns all aliases in the account and region. To get only the
aliases that point to a particular customer master key (CMK), use the KeyId
parameter.
The ListAliases
response might include several aliases have no TargetKeyId
field. These
are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in
your account, including predefined aliases, do not count against your AWS KMS aliases limit.
listAliasesRequest
- default CompletableFuture<ListAliasesResponse> listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
Gets a list of all aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.
By default, the ListAliases
command returns all aliases in the account and region. To get only the
aliases that point to a particular customer master key (CMK), use the KeyId
parameter.
The ListAliases
response might include several aliases have no TargetKeyId
field. These
are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in
your account, including predefined aliases, do not count against your AWS KMS aliases limit.
This is a convenience which creates an instance of the ListAliasesRequest.Builder
avoiding the need to
create one manually via ListAliasesRequest.builder()
listAliasesRequest
- A Consumer
that will call methods on ListAliasesRequest.Builder
to create a request.default CompletableFuture<ListAliasesResponse> listAliases()
Gets a list of all aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.
By default, the ListAliases
command returns all aliases in the account and region. To get only the
aliases that point to a particular customer master key (CMK), use the KeyId
parameter.
The ListAliases
response might include several aliases have no TargetKeyId
field. These
are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in
your account, including predefined aliases, do not count against your AWS KMS aliases limit.
default ListAliasesPublisher listAliasesPaginator()
Gets a list of all aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.
By default, the ListAliases
command returns all aliases in the account and region. To get only the
aliases that point to a particular customer master key (CMK), use the KeyId
parameter.
The ListAliases
response might include several aliases have no TargetKeyId
field. These
are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in
your account, including predefined aliases, do not count against your AWS KMS aliases limit.
This is a variant of listAliases(software.amazon.awssdk.services.kms.model.ListAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kms.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kms.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kms.model.ListAliasesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kms.model.ListAliasesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listAliases(software.amazon.awssdk.services.kms.model.ListAliasesRequest)
operation.
default ListAliasesPublisher listAliasesPaginator(ListAliasesRequest listAliasesRequest)
Gets a list of all aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.
By default, the ListAliases
command returns all aliases in the account and region. To get only the
aliases that point to a particular customer master key (CMK), use the KeyId
parameter.
The ListAliases
response might include several aliases have no TargetKeyId
field. These
are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in
your account, including predefined aliases, do not count against your AWS KMS aliases limit.
This is a variant of listAliases(software.amazon.awssdk.services.kms.model.ListAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kms.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kms.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kms.model.ListAliasesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kms.model.ListAliasesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listAliases(software.amazon.awssdk.services.kms.model.ListAliasesRequest)
operation.
listAliasesRequest
- default ListAliasesPublisher listAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest)
Gets a list of all aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.
By default, the ListAliases
command returns all aliases in the account and region. To get only the
aliases that point to a particular customer master key (CMK), use the KeyId
parameter.
The ListAliases
response might include several aliases have no TargetKeyId
field. These
are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in
your account, including predefined aliases, do not count against your AWS KMS aliases limit.
This is a variant of listAliases(software.amazon.awssdk.services.kms.model.ListAliasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kms.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kms.paginators.ListAliasesPublisher publisher = client.listAliasesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kms.model.ListAliasesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kms.model.ListAliasesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listAliases(software.amazon.awssdk.services.kms.model.ListAliasesRequest)
operation.
This is a convenience which creates an instance of the ListAliasesRequest.Builder
avoiding the need to
create one manually via ListAliasesRequest.builder()
listAliasesRequest
- A Consumer
that will call methods on ListAliasesRequest.Builder
to create a request.default CompletableFuture<ListGrantsResponse> listGrants(ListGrantsRequest listGrantsRequest)
Gets a list of all grants for the specified customer master key (CMK).
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter.
listGrantsRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<ListGrantsResponse> listGrants(Consumer<ListGrantsRequest.Builder> listGrantsRequest)
Gets a list of all grants for the specified customer master key (CMK).
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter.
This is a convenience which creates an instance of the ListGrantsRequest.Builder
avoiding the need to
create one manually via ListGrantsRequest.builder()
listGrantsRequest
- A Consumer
that will call methods on ListGrantsRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default ListGrantsPublisher listGrantsPaginator(ListGrantsRequest listGrantsRequest)
Gets a list of all grants for the specified customer master key (CMK).
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter.
This is a variant of listGrants(software.amazon.awssdk.services.kms.model.ListGrantsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kms.paginators.ListGrantsPublisher publisher = client.listGrantsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kms.paginators.ListGrantsPublisher publisher = client.listGrantsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kms.model.ListGrantsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kms.model.ListGrantsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listGrants(software.amazon.awssdk.services.kms.model.ListGrantsRequest)
operation.
listGrantsRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default ListGrantsPublisher listGrantsPaginator(Consumer<ListGrantsRequest.Builder> listGrantsRequest)
Gets a list of all grants for the specified customer master key (CMK).
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter.
This is a variant of listGrants(software.amazon.awssdk.services.kms.model.ListGrantsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kms.paginators.ListGrantsPublisher publisher = client.listGrantsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kms.paginators.ListGrantsPublisher publisher = client.listGrantsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kms.model.ListGrantsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kms.model.ListGrantsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listGrants(software.amazon.awssdk.services.kms.model.ListGrantsRequest)
operation.
This is a convenience which creates an instance of the ListGrantsRequest.Builder
avoiding the need to
create one manually via ListGrantsRequest.builder()
listGrantsRequest
- A Consumer
that will call methods on ListGrantsRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<ListKeyPoliciesResponse> listKeyPolicies(ListKeyPoliciesRequest listKeyPoliciesRequest)
Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed
to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is
default
. You cannot perform this operation on a CMK in a different AWS account.
listKeyPoliciesRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<ListKeyPoliciesResponse> listKeyPolicies(Consumer<ListKeyPoliciesRequest.Builder> listKeyPoliciesRequest)
Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed
to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is
default
. You cannot perform this operation on a CMK in a different AWS account.
This is a convenience which creates an instance of the ListKeyPoliciesRequest.Builder
avoiding the need
to create one manually via ListKeyPoliciesRequest.builder()
listKeyPoliciesRequest
- A Consumer
that will call methods on ListKeyPoliciesRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default ListKeyPoliciesPublisher listKeyPoliciesPaginator(ListKeyPoliciesRequest listKeyPoliciesRequest)
Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed
to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is
default
. You cannot perform this operation on a CMK in a different AWS account.
This is a variant of listKeyPolicies(software.amazon.awssdk.services.kms.model.ListKeyPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kms.paginators.ListKeyPoliciesPublisher publisher = client.listKeyPoliciesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kms.paginators.ListKeyPoliciesPublisher publisher = client.listKeyPoliciesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kms.model.ListKeyPoliciesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kms.model.ListKeyPoliciesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listKeyPolicies(software.amazon.awssdk.services.kms.model.ListKeyPoliciesRequest)
operation.
listKeyPoliciesRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default ListKeyPoliciesPublisher listKeyPoliciesPaginator(Consumer<ListKeyPoliciesRequest.Builder> listKeyPoliciesRequest)
Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed
to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is
default
. You cannot perform this operation on a CMK in a different AWS account.
This is a variant of listKeyPolicies(software.amazon.awssdk.services.kms.model.ListKeyPoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kms.paginators.ListKeyPoliciesPublisher publisher = client.listKeyPoliciesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kms.paginators.ListKeyPoliciesPublisher publisher = client.listKeyPoliciesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kms.model.ListKeyPoliciesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kms.model.ListKeyPoliciesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listKeyPolicies(software.amazon.awssdk.services.kms.model.ListKeyPoliciesRequest)
operation.
This is a convenience which creates an instance of the ListKeyPoliciesRequest.Builder
avoiding the need
to create one manually via ListKeyPoliciesRequest.builder()
listKeyPoliciesRequest
- A Consumer
that will call methods on ListKeyPoliciesRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<ListKeysResponse> listKeys(ListKeysRequest listKeysRequest)
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
listKeysRequest
- default CompletableFuture<ListKeysResponse> listKeys(Consumer<ListKeysRequest.Builder> listKeysRequest)
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
This is a convenience which creates an instance of the ListKeysRequest.Builder
avoiding the need to
create one manually via ListKeysRequest.builder()
listKeysRequest
- A Consumer
that will call methods on ListKeysRequest.Builder
to create a request.default CompletableFuture<ListKeysResponse> listKeys()
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
default ListKeysPublisher listKeysPaginator()
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
This is a variant of listKeys(software.amazon.awssdk.services.kms.model.ListKeysRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kms.paginators.ListKeysPublisher publisher = client.listKeysPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kms.paginators.ListKeysPublisher publisher = client.listKeysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kms.model.ListKeysResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kms.model.ListKeysResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listKeys(software.amazon.awssdk.services.kms.model.ListKeysRequest)
operation.
default ListKeysPublisher listKeysPaginator(ListKeysRequest listKeysRequest)
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
This is a variant of listKeys(software.amazon.awssdk.services.kms.model.ListKeysRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kms.paginators.ListKeysPublisher publisher = client.listKeysPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kms.paginators.ListKeysPublisher publisher = client.listKeysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kms.model.ListKeysResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kms.model.ListKeysResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listKeys(software.amazon.awssdk.services.kms.model.ListKeysRequest)
operation.
listKeysRequest
- default ListKeysPublisher listKeysPaginator(Consumer<ListKeysRequest.Builder> listKeysRequest)
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
This is a variant of listKeys(software.amazon.awssdk.services.kms.model.ListKeysRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.kms.paginators.ListKeysPublisher publisher = client.listKeysPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.kms.paginators.ListKeysPublisher publisher = client.listKeysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.kms.model.ListKeysResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.kms.model.ListKeysResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listKeys(software.amazon.awssdk.services.kms.model.ListKeysRequest)
operation.
This is a convenience which creates an instance of the ListKeysRequest.Builder
avoiding the need to
create one manually via ListKeysRequest.builder()
listKeysRequest
- A Consumer
that will call methods on ListKeysRequest.Builder
to create a request.default CompletableFuture<ListResourceTagsResponse> listResourceTags(ListResourceTagsRequest listResourceTagsRequest)
Returns a list of all tags for the specified customer master key (CMK).
You cannot perform this operation on a CMK in a different AWS account.
listResourceTagsRequest
- default CompletableFuture<ListResourceTagsResponse> listResourceTags(Consumer<ListResourceTagsRequest.Builder> listResourceTagsRequest)
Returns a list of all tags for the specified customer master key (CMK).
You cannot perform this operation on a CMK in a different AWS account.
This is a convenience which creates an instance of the ListResourceTagsRequest.Builder
avoiding the need
to create one manually via ListResourceTagsRequest.builder()
listResourceTagsRequest
- A Consumer
that will call methods on ListResourceTagsRequest.Builder
to create a request.default CompletableFuture<ListRetirableGrantsResponse> listRetirableGrants(ListRetirableGrantsRequest listRetirableGrantsRequest)
Returns a list of all grants for which the grant's RetiringPrincipal
matches the one specified.
A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.
listRetirableGrantsRequest
- default CompletableFuture<ListRetirableGrantsResponse> listRetirableGrants(Consumer<ListRetirableGrantsRequest.Builder> listRetirableGrantsRequest)
Returns a list of all grants for which the grant's RetiringPrincipal
matches the one specified.
A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.
This is a convenience which creates an instance of the ListRetirableGrantsRequest.Builder
avoiding the
need to create one manually via ListRetirableGrantsRequest.builder()
listRetirableGrantsRequest
- A Consumer
that will call methods on ListRetirableGrantsRequest.Builder
to create a
request.default CompletableFuture<PutKeyPolicyResponse> putKeyPolicy(PutKeyPolicyRequest putKeyPolicyRequest)
Attaches a key policy to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
putKeyPolicyRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<PutKeyPolicyResponse> putKeyPolicy(Consumer<PutKeyPolicyRequest.Builder> putKeyPolicyRequest)
Attaches a key policy to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the PutKeyPolicyRequest.Builder
avoiding the need to
create one manually via PutKeyPolicyRequest.builder()
putKeyPolicyRequest
- A Consumer
that will call methods on PutKeyPolicyRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<ReEncryptResponse> reEncrypt(ReEncryptRequest reEncryptRequest)
Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext.
You can reencrypt data using CMKs in different AWS accounts.
Unlike other operations, ReEncrypt
is authorized twice, once as ReEncryptFrom
on the
source CMK and once as ReEncryptTo
on the destination CMK. We recommend that you include the
"kms:ReEncrypt*"
permission in your key policies to permit
reencryption from or to the CMK. This permission is automatically included in the key policy when you create a
CMK through the console, but you must include it manually when you create a CMK programmatically or when you set
a key policy with the PutKeyPolicy operation.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
reEncryptRequest
- KeySpec
value is
not valid.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<ReEncryptResponse> reEncrypt(Consumer<ReEncryptRequest.Builder> reEncryptRequest)
Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext.
You can reencrypt data using CMKs in different AWS accounts.
Unlike other operations, ReEncrypt
is authorized twice, once as ReEncryptFrom
on the
source CMK and once as ReEncryptTo
on the destination CMK. We recommend that you include the
"kms:ReEncrypt*"
permission in your key policies to permit
reencryption from or to the CMK. This permission is automatically included in the key policy when you create a
CMK through the console, but you must include it manually when you create a CMK programmatically or when you set
a key policy with the PutKeyPolicy operation.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the ReEncryptRequest.Builder
avoiding the need to
create one manually via ReEncryptRequest.builder()
reEncryptRequest
- A Consumer
that will call methods on ReEncryptRequest.Builder
to create a request.KeySpec
value is
not valid.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<RetireGrantResponse> retireGrant(RetireGrantRequest retireGrantRequest)
Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
The AWS account (root user) under which the grant was created
The RetiringPrincipal
, if present in the grant
The GranteePrincipal
, if RetireGrant
is an operation specified in the grant
You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
retireGrantRequest
- GrantId
is not
valid.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<RetireGrantResponse> retireGrant(Consumer<RetireGrantRequest.Builder> retireGrantRequest)
Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
The AWS account (root user) under which the grant was created
The RetiringPrincipal
, if present in the grant
The GranteePrincipal
, if RetireGrant
is an operation specified in the grant
You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
This is a convenience which creates an instance of the RetireGrantRequest.Builder
avoiding the need to
create one manually via RetireGrantRequest.builder()
retireGrantRequest
- A Consumer
that will call methods on RetireGrantRequest.Builder
to create a request.GrantId
is not
valid.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<RetireGrantResponse> retireGrant()
Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
The AWS account (root user) under which the grant was created
The RetiringPrincipal
, if present in the grant
The GranteePrincipal
, if RetireGrant
is an operation specified in the grant
You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
GrantId
is not
valid.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<RevokeGrantResponse> revokeGrant(RevokeGrantRequest revokeGrantRequest)
Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter.
revokeGrantRequest
- GrantId
is not
valid.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<RevokeGrantResponse> revokeGrant(Consumer<RevokeGrantRequest.Builder> revokeGrantRequest)
Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter.
This is a convenience which creates an instance of the RevokeGrantRequest.Builder
avoiding the need to
create one manually via RevokeGrantRequest.builder()
revokeGrantRequest
- A Consumer
that will call methods on RevokeGrantRequest.Builder
to create a request.GrantId
is not
valid.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<ScheduleKeyDeletionResponse> scheduleKeyDeletion(ScheduleKeyDeletionRequest scheduleKeyDeletionRequest)
Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days,
before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this
operation is successful, the key state of the CMK changes to PendingDeletion
. Before the waiting
period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period
ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.
Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is unrecoverable. To prevent the use of a CMK without deleting it, use DisableKey.
If you schedule deletion of a CMK from a custom key store, when
the waiting period expires, ScheduleKeyDeletion
deletes the CMK from AWS KMS. Then AWS KMS makes a
best effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need to
manually delete
the orphaned key material from the cluster and its backups.
You cannot perform this operation on a CMK in a different AWS account.
For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
scheduleKeyDeletionRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<ScheduleKeyDeletionResponse> scheduleKeyDeletion(Consumer<ScheduleKeyDeletionRequest.Builder> scheduleKeyDeletionRequest)
Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days,
before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this
operation is successful, the key state of the CMK changes to PendingDeletion
. Before the waiting
period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period
ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.
Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is unrecoverable. To prevent the use of a CMK without deleting it, use DisableKey.
If you schedule deletion of a CMK from a custom key store, when
the waiting period expires, ScheduleKeyDeletion
deletes the CMK from AWS KMS. Then AWS KMS makes a
best effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need to
manually delete
the orphaned key material from the cluster and its backups.
You cannot perform this operation on a CMK in a different AWS account.
For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the ScheduleKeyDeletionRequest.Builder
avoiding the
need to create one manually via ScheduleKeyDeletionRequest.builder()
scheduleKeyDeletionRequest
- A Consumer
that will call methods on ScheduleKeyDeletionRequest.Builder
to create a
request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds or edits tags for a customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
You can only use a tag key once for each CMK. If you use the tag key again, AWS KMS replaces the current tag value with the specified value.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
tagResourceRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or edits tags for a customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
You can only use a tag key once for each CMK. If you use the tag key again, AWS KMS replaces the current tag value with the specified value.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
untagResourceRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the specified tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<UpdateAliasResponse> updateAlias(UpdateAliasRequest updateAliasRequest)
Associates an existing alias with a different customer master key (CMK). Each CMK can have multiple aliases, but the aliases must be unique within the account and region. You cannot perform this operation on an alias in a different AWS account.
This operation works only on existing aliases. To change the alias of a CMK to a new value, use CreateAlias to create a new alias and DeleteAlias to delete the old alias.
Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs in the account, use the ListAliases operation.
An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An
alias must start with the word alias
followed by a forward slash (alias/
). The alias
name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names
cannot begin with aws
; that alias name prefix is reserved by Amazon Web Services (AWS).
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
updateAliasRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<UpdateAliasResponse> updateAlias(Consumer<UpdateAliasRequest.Builder> updateAliasRequest)
Associates an existing alias with a different customer master key (CMK). Each CMK can have multiple aliases, but the aliases must be unique within the account and region. You cannot perform this operation on an alias in a different AWS account.
This operation works only on existing aliases. To change the alias of a CMK to a new value, use CreateAlias to create a new alias and DeleteAlias to delete the old alias.
Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs in the account, use the ListAliases operation.
An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An
alias must start with the word alias
followed by a forward slash (alias/
). The alias
name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names
cannot begin with aws
; that alias name prefix is reserved by Amazon Web Services (AWS).
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the UpdateAliasRequest.Builder
avoiding the need to
create one manually via UpdateAliasRequest.builder()
updateAliasRequest
- A Consumer
that will call methods on UpdateAliasRequest.Builder
to create a request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<UpdateCustomKeyStoreResponse> updateCustomKeyStore(UpdateCustomKeyStoreRequest updateCustomKeyStoreRequest)
Changes the properties of a custom key store. Use the CustomKeyStoreId
parameter to identify the
custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store.
You can only update a custom key store that is disconnected. To disconnect the custom key store, use DisconnectCustomKeyStore. To reconnect the custom key store after the update completes, use ConnectCustomKeyStore. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation.
Use the NewCustomKeyStoreName
parameter to change the friendly name of the custom key store to the
value that you specify.
Use the KeyStorePassword
parameter tell AWS KMS the current password of the
kmsuser
crypto user (CU) in the associated AWS CloudHSM cluster. You can use this parameter to
fix connection failures that occur when AWS KMS cannot log into the associated cluster because the
kmsuser
password has changed. This value does not change the password in the AWS CloudHSM cluster.
Use the CloudHsmClusterId
parameter to associate the custom key store with a related AWS CloudHSM
cluster, that is, a cluster that shares a backup history with the original cluster. You can use this parameter to
repair a custom key store if its AWS CloudHSM cluster becomes corrupted or is deleted, or when you need to create
or restore a cluster from a backup.
The cluster ID must identify a AWS CloudHSM cluster with the following requirements.
The cluster must be active and be in the same AWS account and Region as the custom key store.
The cluster must have the same cluster certificate as the original cluster. You cannot use this parameter to associate the custom key store with an unrelated cluster. To view the cluster certificate, use the AWS CloudHSM DescribeClusters operation. Clusters that share a backup history have the same cluster certificate.
The cluster must be configured with subnets in at least two different Availability Zones in the Region. Because AWS CloudHSM is not supported in all Availability Zones, we recommend that the cluster have subnets in all Availability Zones in the Region.
The cluster must contain at least two active HSMs, each in a different Availability Zone.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
updateCustomKeyStoreRequest
- Specify a cluster that shares a backup history with the original cluster. This includes clusters that were created from a backup of the current cluster, and clusters that were created from the same backup that produced the current cluster.
Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.
ConnectionState
of the custom key store. To get the ConnectionState
of a custom
key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState
is
CONNECTED
.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState
is DISCONNECTED
.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState
of DISCONNECTING
or FAILED
. This operation is
valid for all other ConnectionState
values.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about creating a private subnet for a AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. To add HSMs, use the AWS CloudHSM CreateHsm operation.
default CompletableFuture<UpdateCustomKeyStoreResponse> updateCustomKeyStore(Consumer<UpdateCustomKeyStoreRequest.Builder> updateCustomKeyStoreRequest)
Changes the properties of a custom key store. Use the CustomKeyStoreId
parameter to identify the
custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store.
You can only update a custom key store that is disconnected. To disconnect the custom key store, use DisconnectCustomKeyStore. To reconnect the custom key store after the update completes, use ConnectCustomKeyStore. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation.
Use the NewCustomKeyStoreName
parameter to change the friendly name of the custom key store to the
value that you specify.
Use the KeyStorePassword
parameter tell AWS KMS the current password of the
kmsuser
crypto user (CU) in the associated AWS CloudHSM cluster. You can use this parameter to
fix connection failures that occur when AWS KMS cannot log into the associated cluster because the
kmsuser
password has changed. This value does not change the password in the AWS CloudHSM cluster.
Use the CloudHsmClusterId
parameter to associate the custom key store with a related AWS CloudHSM
cluster, that is, a cluster that shares a backup history with the original cluster. You can use this parameter to
repair a custom key store if its AWS CloudHSM cluster becomes corrupted or is deleted, or when you need to create
or restore a cluster from a backup.
The cluster ID must identify a AWS CloudHSM cluster with the following requirements.
The cluster must be active and be in the same AWS account and Region as the custom key store.
The cluster must have the same cluster certificate as the original cluster. You cannot use this parameter to associate the custom key store with an unrelated cluster. To view the cluster certificate, use the AWS CloudHSM DescribeClusters operation. Clusters that share a backup history have the same cluster certificate.
The cluster must be configured with subnets in at least two different Availability Zones in the Region. Because AWS CloudHSM is not supported in all Availability Zones, we recommend that the cluster have subnets in all Availability Zones in the Region.
The cluster must contain at least two active HSMs, each in a different Availability Zone.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
This is a convenience which creates an instance of the UpdateCustomKeyStoreRequest.Builder
avoiding the
need to create one manually via UpdateCustomKeyStoreRequest.builder()
updateCustomKeyStoreRequest
- A Consumer
that will call methods on UpdateCustomKeyStoreRequest.Builder
to create a
request.Specify a cluster that shares a backup history with the original cluster. This includes clusters that were created from a backup of the current cluster, and clusters that were created from the same backup that produced the current cluster.
Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.
ConnectionState
of the custom key store. To get the ConnectionState
of a custom
key store, use the DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
You requested the CreateKey or GenerateRandom operation in a custom key store that is not
connected. These operations are valid only when the custom key store ConnectionState
is
CONNECTED
.
You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key
store that is not disconnected. This operation is valid only when the custom key store
ConnectionState
is DISCONNECTED
.
You requested the ConnectCustomKeyStore operation on a custom key store with a
ConnectionState
of DISCONNECTING
or FAILED
. This operation is
valid for all other ConnectionState
values.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about creating a private subnet for a AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. To add HSMs, use the AWS CloudHSM CreateHsm operation.
default CompletableFuture<UpdateKeyDescriptionResponse> updateKeyDescription(UpdateKeyDescriptionRequest updateKeyDescriptionRequest)
Updates the description of a customer master key (CMK). To see the decription of a CMK, use DescribeKey.
You cannot perform this operation on a CMK in a different AWS account.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
updateKeyDescriptionRequest
- For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
default CompletableFuture<UpdateKeyDescriptionResponse> updateKeyDescription(Consumer<UpdateKeyDescriptionRequest.Builder> updateKeyDescriptionRequest)
Updates the description of a customer master key (CMK). To see the decription of a CMK, use DescribeKey.
You cannot perform this operation on a CMK in a different AWS account.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
This is a convenience which creates an instance of the UpdateKeyDescriptionRequest.Builder
avoiding the
need to create one manually via UpdateKeyDescriptionRequest.builder()
updateKeyDescriptionRequest
- A Consumer
that will call methods on UpdateKeyDescriptionRequest.Builder
to create a
request.For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Copyright © 2019. All rights reserved.