Class AbstractAWSKMSAsync
- java.lang.Object
-
- com.amazonaws.services.kms.AbstractAWSKMS
-
- com.amazonaws.services.kms.AbstractAWSKMSAsync
-
- All Implemented Interfaces:
AWSKMS
,AWSKMSAsync
public class AbstractAWSKMSAsync extends AbstractAWSKMS implements AWSKMSAsync
Abstract implementation ofAWSKMSAsync
. Convenient method forms pass through to the corresponding overload that takes a request object and anAsyncHandler
, which throws anUnsupportedOperationException
.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractAWSKMSAsync()
-
Method Summary
-
Methods inherited from class com.amazonaws.services.kms.AbstractAWSKMS
cancelKeyDeletion, createAlias, createGrant, createKey, createKey, decrypt, deleteAlias, describeKey, disableKey, disableKeyRotation, enableKey, enableKeyRotation, encrypt, generateDataKey, generateDataKeyWithoutPlaintext, generateRandom, generateRandom, getCachedResponseMetadata, getKeyPolicy, getKeyRotationStatus, listAliases, listAliases, listGrants, listKeyPolicies, listKeys, listKeys, listRetirableGrants, putKeyPolicy, reEncrypt, retireGrant, retireGrant, revokeGrant, scheduleKeyDeletion, setEndpoint, setRegion, shutdown, updateAlias, updateKeyDescription
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.amazonaws.services.kms.AWSKMS
cancelKeyDeletion, createAlias, createGrant, createKey, createKey, decrypt, deleteAlias, describeKey, disableKey, disableKeyRotation, enableKey, enableKeyRotation, encrypt, generateDataKey, generateDataKeyWithoutPlaintext, generateRandom, generateRandom, getCachedResponseMetadata, getKeyPolicy, getKeyRotationStatus, listAliases, listAliases, listGrants, listKeyPolicies, listKeys, listKeys, listRetirableGrants, putKeyPolicy, reEncrypt, retireGrant, retireGrant, revokeGrant, scheduleKeyDeletion, setEndpoint, setRegion, shutdown, updateAlias, updateKeyDescription
-
-
-
-
Method Detail
-
cancelKeyDeletionAsync
public Future<CancelKeyDeletionResult> cancelKeyDeletionAsync(CancelKeyDeletionRequest request)
Description copied from interface:AWSKMSAsync
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.For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
- Specified by:
cancelKeyDeletionAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the CancelKeyDeletion operation returned by the service.
-
cancelKeyDeletionAsync
public Future<CancelKeyDeletionResult> cancelKeyDeletionAsync(CancelKeyDeletionRequest request, AsyncHandler<CancelKeyDeletionRequest,CancelKeyDeletionResult> asyncHandler)
Description copied from interface:AWSKMSAsync
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.For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
- Specified by:
cancelKeyDeletionAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the CancelKeyDeletion operation returned by the service.
-
createAliasAsync
public Future<CreateAliasResult> createAliasAsync(CreateAliasRequest request)
Description copied from interface:AWSKMSAsync
Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. 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/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
To map an alias to a different key, call UpdateAlias.
- Specified by:
createAliasAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the CreateAlias operation returned by the service.
-
createAliasAsync
public Future<CreateAliasResult> createAliasAsync(CreateAliasRequest request, AsyncHandler<CreateAliasRequest,CreateAliasResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. 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/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
To map an alias to a different key, call UpdateAlias.
- Specified by:
createAliasAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the CreateAlias operation returned by the service.
-
createGrantAsync
public Future<CreateGrantResult> createGrantAsync(CreateGrantRequest request)
Description copied from interface:AWSKMSAsync
Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.
For more information about grants, see Grants in the AWS Key Management Service Developer Guide.
- Specified by:
createGrantAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the CreateGrant operation returned by the service.
-
createGrantAsync
public Future<CreateGrantResult> createGrantAsync(CreateGrantRequest request, AsyncHandler<CreateGrantRequest,CreateGrantResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.
For more information about grants, see Grants in the AWS Key Management Service Developer Guide.
- Specified by:
createGrantAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the CreateGrant operation returned by the service.
-
createKeyAsync
public Future<CreateKeyResult> createKeyAsync(CreateKeyRequest request)
Description copied from interface:AWSKMSAsync
Creates a customer master key (CMK).
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 encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:
-
The GenerateDataKey operation
-
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
- Specified by:
createKeyAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the CreateKey operation returned by the service.
-
-
createKeyAsync
public Future<CreateKeyResult> createKeyAsync(CreateKeyRequest request, AsyncHandler<CreateKeyRequest,CreateKeyResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Creates a customer master key (CMK).
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 encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:
-
The GenerateDataKey operation
-
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
- Specified by:
createKeyAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the CreateKey operation returned by the service.
-
-
createKeyAsync
public Future<CreateKeyResult> createKeyAsync()
Simplified method form for invoking the CreateKey operation.- Specified by:
createKeyAsync
in interfaceAWSKMSAsync
- See Also:
createKeyAsync(CreateKeyRequest)
-
createKeyAsync
public Future<CreateKeyResult> createKeyAsync(AsyncHandler<CreateKeyRequest,CreateKeyResult> asyncHandler)
Simplified method form for invoking the CreateKey operation with an AsyncHandler.- Specified by:
createKeyAsync
in interfaceAWSKMSAsync
- See Also:
createKeyAsync(CreateKeyRequest, com.amazonaws.handlers.AsyncHandler)
-
decryptAsync
public Future<DecryptResult> decryptAsync(DecryptRequest request)
Description copied from interface:AWSKMSAsync
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:
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 grantDecrypt
access in an IAM user policy. Instead grantDecrypt
access only in key policies. If you must grantDecrypt
access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.- Specified by:
decryptAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the Decrypt operation returned by the service.
-
decryptAsync
public Future<DecryptResult> decryptAsync(DecryptRequest request, AsyncHandler<DecryptRequest,DecryptResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:
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 grantDecrypt
access in an IAM user policy. Instead grantDecrypt
access only in key policies. If you must grantDecrypt
access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.- Specified by:
decryptAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the Decrypt operation returned by the service.
-
deleteAliasAsync
public Future<DeleteAliasResult> deleteAliasAsync(DeleteAliasRequest request)
Description copied from interface:AWSKMSAsync
Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
- Specified by:
deleteAliasAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the DeleteAlias operation returned by the service.
-
deleteAliasAsync
public Future<DeleteAliasResult> deleteAliasAsync(DeleteAliasRequest request, AsyncHandler<DeleteAliasRequest,DeleteAliasResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
- Specified by:
deleteAliasAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DeleteAlias operation returned by the service.
-
describeKeyAsync
public Future<DescribeKeyResult> describeKeyAsync(DescribeKeyRequest request)
Description copied from interface:AWSKMSAsync
Provides detailed information about the specified customer master key.
- Specified by:
describeKeyAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the DescribeKey operation returned by the service.
-
describeKeyAsync
public Future<DescribeKeyResult> describeKeyAsync(DescribeKeyRequest request, AsyncHandler<DescribeKeyRequest,DescribeKeyResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Provides detailed information about the specified customer master key.
- Specified by:
describeKeyAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeKey operation returned by the service.
-
disableKeyAsync
public Future<DisableKeyResult> disableKeyAsync(DisableKeyRequest request)
Description copied from interface:AWSKMSAsync
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. 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.
- Specified by:
disableKeyAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the DisableKey operation returned by the service.
-
disableKeyAsync
public Future<DisableKeyResult> disableKeyAsync(DisableKeyRequest request, AsyncHandler<DisableKeyRequest,DisableKeyResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. 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.
- Specified by:
disableKeyAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DisableKey operation returned by the service.
-
disableKeyRotationAsync
public Future<DisableKeyRotationResult> disableKeyRotationAsync(DisableKeyRotationRequest request)
Description copied from interface:AWSKMSAsync
Disables rotation of the specified key.
- Specified by:
disableKeyRotationAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the DisableKeyRotation operation returned by the service.
-
disableKeyRotationAsync
public Future<DisableKeyRotationResult> disableKeyRotationAsync(DisableKeyRotationRequest request, AsyncHandler<DisableKeyRotationRequest,DisableKeyRotationResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Disables rotation of the specified key.
- Specified by:
disableKeyRotationAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DisableKeyRotation operation returned by the service.
-
enableKeyAsync
public Future<EnableKeyResult> enableKeyAsync(EnableKeyRequest request)
Description copied from interface:AWSKMSAsync
Marks a key as enabled, thereby permitting its use.
- Specified by:
enableKeyAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the EnableKey operation returned by the service.
-
enableKeyAsync
public Future<EnableKeyResult> enableKeyAsync(EnableKeyRequest request, AsyncHandler<EnableKeyRequest,EnableKeyResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Marks a key as enabled, thereby permitting its use.
- Specified by:
enableKeyAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the EnableKey operation returned by the service.
-
enableKeyRotationAsync
public Future<EnableKeyRotationResult> enableKeyRotationAsync(EnableKeyRotationRequest request)
Description copied from interface:AWSKMSAsync
Enables rotation of the specified customer master key.
- Specified by:
enableKeyRotationAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the EnableKeyRotation operation returned by the service.
-
enableKeyRotationAsync
public Future<EnableKeyRotationResult> enableKeyRotationAsync(EnableKeyRotationRequest request, AsyncHandler<EnableKeyRotationRequest,EnableKeyRotationResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Enables rotation of the specified customer master key.
- Specified by:
enableKeyRotationAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the EnableKeyRotation operation returned by the service.
-
encryptAsync
public Future<EncryptResult> encryptAsync(EncryptRequest request)
Description copied from interface:AWSKMSAsync
Encrypts plaintext into ciphertext by using a customer master key. The
Encrypt
function has two primary use cases:-
You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.
-
If you are moving encrypted data from one region to another, you can use this API 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.
Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted again by calling
Encrypt
.If you want to encrypt data locally in your application, you can use the
GenerateDataKey
function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.- Specified by:
encryptAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the Encrypt operation returned by the service.
-
-
encryptAsync
public Future<EncryptResult> encryptAsync(EncryptRequest request, AsyncHandler<EncryptRequest,EncryptResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Encrypts plaintext into ciphertext by using a customer master key. The
Encrypt
function has two primary use cases:-
You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.
-
If you are moving encrypted data from one region to another, you can use this API 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.
Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted again by calling
Encrypt
.If you want to encrypt data locally in your application, you can use the
GenerateDataKey
function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.- Specified by:
encryptAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the Encrypt operation returned by the service.
-
-
generateDataKeyAsync
public Future<GenerateDataKeyResult> generateDataKeyAsync(GenerateDataKeyRequest request)
Description copied from interface:AWSKMSAsync
Generates a data key that you can use in your application to locally encrypt data. This call returns a plaintext version of the key in the
Plaintext
field of the response object and an encrypted copy of the key in theCiphertextBlob
field. The key is encrypted by using the master key specified by theKeyId
field. To decrypt the encrypted key, pass it to theDecrypt
API.We recommend that you use the following pattern to locally encrypt data: call the
GenerateDataKey
API, use the key returned in thePlaintext
response field to locally encrypt data, and then erase the plaintext data key from memory. Store the encrypted data key (contained in theCiphertextBlob
field) alongside of the locally encrypted data.You should not call the
Encrypt
function to re-encrypt your data keys within a region.GenerateDataKey
always returns the data key encrypted and tied to the customer master key that will be used to decrypt it. There is no need to decrypt it twice.If you decide to use the optional
EncryptionContext
parameter, you must also store the context in full or at least store enough information along with the encrypted data to be able to reconstruct the context when submitting the ciphertext to theDecrypt
API. It is a good practice to choose a context that you can reconstruct on the fly to better secure the ciphertext. For more information about how this parameter is used, see Encryption Context.To decrypt data, pass the encrypted data key to the
Decrypt
API.Decrypt
uses the associated master key to decrypt the encrypted data key and returns it as plaintext. Use the plaintext data key to locally decrypt your data and then erase the key from memory. You must specify the encryption context, if any, that you specified when you generated the key. The encryption context is logged by CloudTrail, and you can use this log to help track the use of particular data.- Specified by:
generateDataKeyAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the GenerateDataKey operation returned by the service.
-
generateDataKeyAsync
public Future<GenerateDataKeyResult> generateDataKeyAsync(GenerateDataKeyRequest request, AsyncHandler<GenerateDataKeyRequest,GenerateDataKeyResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Generates a data key that you can use in your application to locally encrypt data. This call returns a plaintext version of the key in the
Plaintext
field of the response object and an encrypted copy of the key in theCiphertextBlob
field. The key is encrypted by using the master key specified by theKeyId
field. To decrypt the encrypted key, pass it to theDecrypt
API.We recommend that you use the following pattern to locally encrypt data: call the
GenerateDataKey
API, use the key returned in thePlaintext
response field to locally encrypt data, and then erase the plaintext data key from memory. Store the encrypted data key (contained in theCiphertextBlob
field) alongside of the locally encrypted data.You should not call the
Encrypt
function to re-encrypt your data keys within a region.GenerateDataKey
always returns the data key encrypted and tied to the customer master key that will be used to decrypt it. There is no need to decrypt it twice.If you decide to use the optional
EncryptionContext
parameter, you must also store the context in full or at least store enough information along with the encrypted data to be able to reconstruct the context when submitting the ciphertext to theDecrypt
API. It is a good practice to choose a context that you can reconstruct on the fly to better secure the ciphertext. For more information about how this parameter is used, see Encryption Context.To decrypt data, pass the encrypted data key to the
Decrypt
API.Decrypt
uses the associated master key to decrypt the encrypted data key and returns it as plaintext. Use the plaintext data key to locally decrypt your data and then erase the key from memory. You must specify the encryption context, if any, that you specified when you generated the key. The encryption context is logged by CloudTrail, and you can use this log to help track the use of particular data.- Specified by:
generateDataKeyAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the GenerateDataKey operation returned by the service.
-
generateDataKeyWithoutPlaintextAsync
public Future<GenerateDataKeyWithoutPlaintextResult> generateDataKeyWithoutPlaintextAsync(GenerateDataKeyWithoutPlaintextRequest request)
Description copied from interface:AWSKMSAsync
Returns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like GenerateDataKey. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key.
- Specified by:
generateDataKeyWithoutPlaintextAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the GenerateDataKeyWithoutPlaintext operation returned by the service.
-
generateDataKeyWithoutPlaintextAsync
public Future<GenerateDataKeyWithoutPlaintextResult> generateDataKeyWithoutPlaintextAsync(GenerateDataKeyWithoutPlaintextRequest request, AsyncHandler<GenerateDataKeyWithoutPlaintextRequest,GenerateDataKeyWithoutPlaintextResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Returns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like GenerateDataKey. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key.
- Specified by:
generateDataKeyWithoutPlaintextAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the GenerateDataKeyWithoutPlaintext operation returned by the service.
-
generateRandomAsync
public Future<GenerateRandomResult> generateRandomAsync(GenerateRandomRequest request)
Description copied from interface:AWSKMSAsync
Generates an unpredictable byte string.
- Specified by:
generateRandomAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the GenerateRandom operation returned by the service.
-
generateRandomAsync
public Future<GenerateRandomResult> generateRandomAsync(GenerateRandomRequest request, AsyncHandler<GenerateRandomRequest,GenerateRandomResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Generates an unpredictable byte string.
- Specified by:
generateRandomAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the GenerateRandom operation returned by the service.
-
generateRandomAsync
public Future<GenerateRandomResult> generateRandomAsync()
Simplified method form for invoking the GenerateRandom operation.- Specified by:
generateRandomAsync
in interfaceAWSKMSAsync
- See Also:
generateRandomAsync(GenerateRandomRequest)
-
generateRandomAsync
public Future<GenerateRandomResult> generateRandomAsync(AsyncHandler<GenerateRandomRequest,GenerateRandomResult> asyncHandler)
Simplified method form for invoking the GenerateRandom operation with an AsyncHandler.- Specified by:
generateRandomAsync
in interfaceAWSKMSAsync
- See Also:
generateRandomAsync(GenerateRandomRequest, com.amazonaws.handlers.AsyncHandler)
-
getKeyPolicyAsync
public Future<GetKeyPolicyResult> getKeyPolicyAsync(GetKeyPolicyRequest request)
Description copied from interface:AWSKMSAsync
Retrieves a policy attached to the specified key.
- Specified by:
getKeyPolicyAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the GetKeyPolicy operation returned by the service.
-
getKeyPolicyAsync
public Future<GetKeyPolicyResult> getKeyPolicyAsync(GetKeyPolicyRequest request, AsyncHandler<GetKeyPolicyRequest,GetKeyPolicyResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Retrieves a policy attached to the specified key.
- Specified by:
getKeyPolicyAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the GetKeyPolicy operation returned by the service.
-
getKeyRotationStatusAsync
public Future<GetKeyRotationStatusResult> getKeyRotationStatusAsync(GetKeyRotationStatusRequest request)
Description copied from interface:AWSKMSAsync
Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
- Specified by:
getKeyRotationStatusAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the GetKeyRotationStatus operation returned by the service.
-
getKeyRotationStatusAsync
public Future<GetKeyRotationStatusResult> getKeyRotationStatusAsync(GetKeyRotationStatusRequest request, AsyncHandler<GetKeyRotationStatusRequest,GetKeyRotationStatusResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
- Specified by:
getKeyRotationStatusAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the GetKeyRotationStatus operation returned by the service.
-
listAliasesAsync
public Future<ListAliasesResult> listAliasesAsync(ListAliasesRequest request)
Description copied from interface:AWSKMSAsync
Lists all of the key aliases in the account.
- Specified by:
listAliasesAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the ListAliases operation returned by the service.
-
listAliasesAsync
public Future<ListAliasesResult> listAliasesAsync(ListAliasesRequest request, AsyncHandler<ListAliasesRequest,ListAliasesResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Lists all of the key aliases in the account.
- Specified by:
listAliasesAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ListAliases operation returned by the service.
-
listAliasesAsync
public Future<ListAliasesResult> listAliasesAsync()
Simplified method form for invoking the ListAliases operation.- Specified by:
listAliasesAsync
in interfaceAWSKMSAsync
- See Also:
listAliasesAsync(ListAliasesRequest)
-
listAliasesAsync
public Future<ListAliasesResult> listAliasesAsync(AsyncHandler<ListAliasesRequest,ListAliasesResult> asyncHandler)
Simplified method form for invoking the ListAliases operation with an AsyncHandler.- Specified by:
listAliasesAsync
in interfaceAWSKMSAsync
- See Also:
listAliasesAsync(ListAliasesRequest, com.amazonaws.handlers.AsyncHandler)
-
listGrantsAsync
public Future<ListGrantsResult> listGrantsAsync(ListGrantsRequest request)
Description copied from interface:AWSKMSAsync
List the grants for a specified key.
- Specified by:
listGrantsAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the ListGrants operation returned by the service.
-
listGrantsAsync
public Future<ListGrantsResult> listGrantsAsync(ListGrantsRequest request, AsyncHandler<ListGrantsRequest,ListGrantsResult> asyncHandler)
Description copied from interface:AWSKMSAsync
List the grants for a specified key.
- Specified by:
listGrantsAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ListGrants operation returned by the service.
-
listKeyPoliciesAsync
public Future<ListKeyPoliciesResult> listKeyPoliciesAsync(ListKeyPoliciesRequest request)
Description copied from interface:AWSKMSAsync
Retrieves a list of policies attached to a key.
- Specified by:
listKeyPoliciesAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the ListKeyPolicies operation returned by the service.
-
listKeyPoliciesAsync
public Future<ListKeyPoliciesResult> listKeyPoliciesAsync(ListKeyPoliciesRequest request, AsyncHandler<ListKeyPoliciesRequest,ListKeyPoliciesResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Retrieves a list of policies attached to a key.
- Specified by:
listKeyPoliciesAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ListKeyPolicies operation returned by the service.
-
listKeysAsync
public Future<ListKeysResult> listKeysAsync(ListKeysRequest request)
Description copied from interface:AWSKMSAsync
Lists the customer master keys.
- Specified by:
listKeysAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the ListKeys operation returned by the service.
-
listKeysAsync
public Future<ListKeysResult> listKeysAsync(ListKeysRequest request, AsyncHandler<ListKeysRequest,ListKeysResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Lists the customer master keys.
- Specified by:
listKeysAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ListKeys operation returned by the service.
-
listKeysAsync
public Future<ListKeysResult> listKeysAsync()
Simplified method form for invoking the ListKeys operation.- Specified by:
listKeysAsync
in interfaceAWSKMSAsync
- See Also:
listKeysAsync(ListKeysRequest)
-
listKeysAsync
public Future<ListKeysResult> listKeysAsync(AsyncHandler<ListKeysRequest,ListKeysResult> asyncHandler)
Simplified method form for invoking the ListKeys operation with an AsyncHandler.- Specified by:
listKeysAsync
in interfaceAWSKMSAsync
- See Also:
listKeysAsync(ListKeysRequest, com.amazonaws.handlers.AsyncHandler)
-
listRetirableGrantsAsync
public Future<ListRetirableGrantsResult> listRetirableGrantsAsync(ListRetirableGrantsRequest request)
Description copied from interface:AWSKMSAsync
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.
- Specified by:
listRetirableGrantsAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the ListRetirableGrants operation returned by the service.
-
listRetirableGrantsAsync
public Future<ListRetirableGrantsResult> listRetirableGrantsAsync(ListRetirableGrantsRequest request, AsyncHandler<ListRetirableGrantsRequest,ListRetirableGrantsResult> asyncHandler)
Description copied from interface:AWSKMSAsync
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.
- Specified by:
listRetirableGrantsAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ListRetirableGrants operation returned by the service.
-
putKeyPolicyAsync
public Future<PutKeyPolicyResult> putKeyPolicyAsync(PutKeyPolicyRequest request)
Description copied from interface:AWSKMSAsync
Attaches a key policy to the specified customer master key (CMK).
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
- Specified by:
putKeyPolicyAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the PutKeyPolicy operation returned by the service.
-
putKeyPolicyAsync
public Future<PutKeyPolicyResult> putKeyPolicyAsync(PutKeyPolicyRequest request, AsyncHandler<PutKeyPolicyRequest,PutKeyPolicyResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Attaches a key policy to the specified customer master key (CMK).
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
- Specified by:
putKeyPolicyAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the PutKeyPolicy operation returned by the service.
-
reEncryptAsync
public Future<ReEncryptResult> reEncryptAsync(ReEncryptRequest request)
Description copied from interface:AWSKMSAsync
Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext.
Unlike other actions,
ReEncrypt
is authorized twice - once asReEncryptFrom
on the source key and once asReEncryptTo
on the destination key. We therefore recommend that you include the"action":"kms:ReEncrypt*"
statement in your key policies to permit re-encryption from or to the key. The statement is included automatically when you authorize use of the key through the console but must be included manually when you set a policy by using the PutKeyPolicy function.- Specified by:
reEncryptAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the ReEncrypt operation returned by the service.
-
reEncryptAsync
public Future<ReEncryptResult> reEncryptAsync(ReEncryptRequest request, AsyncHandler<ReEncryptRequest,ReEncryptResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext.
Unlike other actions,
ReEncrypt
is authorized twice - once asReEncryptFrom
on the source key and once asReEncryptTo
on the destination key. We therefore recommend that you include the"action":"kms:ReEncrypt*"
statement in your key policies to permit re-encryption from or to the key. The statement is included automatically when you authorize use of the key through the console but must be included manually when you set a policy by using the PutKeyPolicy function.- Specified by:
reEncryptAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ReEncrypt operation returned by the service.
-
retireGrantAsync
public Future<RetireGrantResult> retireGrantAsync(RetireGrantRequest request)
Description copied from interface:AWSKMSAsync
Retires a grant. You can retire a grant when you're done using it to clean up. 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 account that created the grant
-
The
RetiringPrincipal
, if present -
The
GranteePrincipal
, ifRetireGrant
is a grantee operation
The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the
CreateGrant
function.- Specified by:
retireGrantAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the RetireGrant operation returned by the service.
-
-
retireGrantAsync
public Future<RetireGrantResult> retireGrantAsync(RetireGrantRequest request, AsyncHandler<RetireGrantRequest,RetireGrantResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Retires a grant. You can retire a grant when you're done using it to clean up. 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 account that created the grant
-
The
RetiringPrincipal
, if present -
The
GranteePrincipal
, ifRetireGrant
is a grantee operation
The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the
CreateGrant
function.- Specified by:
retireGrantAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the RetireGrant operation returned by the service.
-
-
retireGrantAsync
public Future<RetireGrantResult> retireGrantAsync()
Simplified method form for invoking the RetireGrant operation.- Specified by:
retireGrantAsync
in interfaceAWSKMSAsync
- See Also:
retireGrantAsync(RetireGrantRequest)
-
retireGrantAsync
public Future<RetireGrantResult> retireGrantAsync(AsyncHandler<RetireGrantRequest,RetireGrantResult> asyncHandler)
Simplified method form for invoking the RetireGrant operation with an AsyncHandler.- Specified by:
retireGrantAsync
in interfaceAWSKMSAsync
- See Also:
retireGrantAsync(RetireGrantRequest, com.amazonaws.handlers.AsyncHandler)
-
revokeGrantAsync
public Future<RevokeGrantResult> revokeGrantAsync(RevokeGrantRequest request)
Description copied from interface:AWSKMSAsync
Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
- Specified by:
revokeGrantAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the RevokeGrant operation returned by the service.
-
revokeGrantAsync
public Future<RevokeGrantResult> revokeGrantAsync(RevokeGrantRequest request, AsyncHandler<RevokeGrantRequest,RevokeGrantResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
- Specified by:
revokeGrantAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the RevokeGrant operation returned by the service.
-
scheduleKeyDeletionAsync
public Future<ScheduleKeyDeletionResult> scheduleKeyDeletionAsync(ScheduleKeyDeletionRequest request)
Description copied from interface:AWSKMSAsync
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 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 point 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 rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.
For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
- Specified by:
scheduleKeyDeletionAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the ScheduleKeyDeletion operation returned by the service.
-
scheduleKeyDeletionAsync
public Future<ScheduleKeyDeletionResult> scheduleKeyDeletionAsync(ScheduleKeyDeletionRequest request, AsyncHandler<ScheduleKeyDeletionRequest,ScheduleKeyDeletionResult> asyncHandler)
Description copied from interface:AWSKMSAsync
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 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 point 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 rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.
For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
- Specified by:
scheduleKeyDeletionAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ScheduleKeyDeletion operation returned by the service.
-
updateAliasAsync
public Future<UpdateAliasResult> updateAliasAsync(UpdateAliasRequest request)
Description copied from interface:AWSKMSAsync
Updates an alias to map it to a different key.
An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.
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/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
- Specified by:
updateAliasAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the UpdateAlias operation returned by the service.
-
updateAliasAsync
public Future<UpdateAliasResult> updateAliasAsync(UpdateAliasRequest request, AsyncHandler<UpdateAliasRequest,UpdateAliasResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Updates an alias to map it to a different key.
An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.
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/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
- Specified by:
updateAliasAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the UpdateAlias operation returned by the service.
-
updateKeyDescriptionAsync
public Future<UpdateKeyDescriptionResult> updateKeyDescriptionAsync(UpdateKeyDescriptionRequest request)
Description copied from interface:AWSKMSAsync
Updates the description of a key.
- Specified by:
updateKeyDescriptionAsync
in interfaceAWSKMSAsync
- Returns:
- A Java Future containing the result of the UpdateKeyDescription operation returned by the service.
-
updateKeyDescriptionAsync
public Future<UpdateKeyDescriptionResult> updateKeyDescriptionAsync(UpdateKeyDescriptionRequest request, AsyncHandler<UpdateKeyDescriptionRequest,UpdateKeyDescriptionResult> asyncHandler)
Description copied from interface:AWSKMSAsync
Updates the description of a key.
- Specified by:
updateKeyDescriptionAsync
in interfaceAWSKMSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the UpdateKeyDescription operation returned by the service.
-
-