Class AbstractAWSKMS
- All Implemented Interfaces:
AWSKMS
- Direct Known Subclasses:
AbstractAWSKMSAsync
AWSKMS
. Convenient method forms pass
through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCancels the deletion of a customer master key (CMK).createAlias
(CreateAliasRequest request) Creates a display name for a customer master key.createGrant
(CreateGrantRequest request) Adds a grant to a key to specify who can use the key and under what conditions.Simplified method form for invoking the CreateKey operation.createKey
(CreateKeyRequest request) Creates a customer master key (CMK).decrypt
(DecryptRequest request) Decrypts ciphertext.deleteAlias
(DeleteAliasRequest request) Deletes the specified alias.describeKey
(DescribeKeyRequest request) Provides detailed information about the specified customer master key.disableKey
(DisableKeyRequest request) Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations.Disables rotation of the specified key.enableKey
(EnableKeyRequest request) Marks a key as enabled, thereby permitting its use.Enables rotation of the specified customer master key.encrypt
(EncryptRequest request) Encrypts plaintext into ciphertext by using a customer master key.generateDataKey
(GenerateDataKeyRequest request) Generates a data key that you can use in your application to locally encrypt data.Returns a data key encrypted by a customer master key without the plaintext copy of that key.Simplified method form for invoking the GenerateRandom operation.generateRandom
(GenerateRandomRequest request) Generates an unpredictable byte string.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.getKeyPolicy
(GetKeyPolicyRequest request) Retrieves a policy attached to the specified key.Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.Simplified method form for invoking the ListAliases operation.listAliases
(ListAliasesRequest request) Lists all of the key aliases in the account.listGrants
(ListGrantsRequest request) List the grants for a specified key.listKeyPolicies
(ListKeyPoliciesRequest request) Retrieves a list of policies attached to a key.listKeys()
Simplified method form for invoking the ListKeys operation.listKeys
(ListKeysRequest request) Lists the customer master keys.Returns a list of all grants for which the grant'sRetiringPrincipal
matches the one specified.putKeyPolicy
(PutKeyPolicyRequest request) Attaches a key policy to the specified customer master key (CMK).reEncrypt
(ReEncryptRequest request) Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side.Simplified method form for invoking the RetireGrant operation.retireGrant
(RetireGrantRequest request) Retires a grant.revokeGrant
(RevokeGrantRequest request) Revokes a grant.Schedules the deletion of a customer master key (CMK).void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("https://kms.us-east-1.amazonaws.com/").void
An alternative toAWSKMS.setEndpoint(String)
, sets the regional endpoint for this client's service calls.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.updateAlias
(UpdateAliasRequest request) Updates an alias to map it to a different key.Updates the description of a key.
-
Constructor Details
-
AbstractAWSKMS
protected AbstractAWSKMS()
-
-
Method Details
-
setEndpoint
Description copied from interface:AWSKMS
Overrides the default endpoint for this client ("https://kms.us-east-1.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "kms.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://kms.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setEndpoint
in interfaceAWSKMS
- Parameters:
endpoint
- The endpoint (ex: "kms.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://kms.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.
-
setRegion
Description copied from interface:AWSKMS
An alternative toAWSKMS.setEndpoint(String)
, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setRegion
in interfaceAWSKMS
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
-
cancelKeyDeletion
Description copied from interface:AWSKMS
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:
cancelKeyDeletion
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the CancelKeyDeletion operation returned by the service.
-
createAlias
Description copied from interface:AWSKMS
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:
createAlias
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the CreateAlias operation returned by the service.
-
createGrant
Description copied from interface:AWSKMS
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:
createGrant
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the CreateGrant operation returned by the service.
-
createKey
Description copied from interface:AWSKMS
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
-
-
createKey
Description copied from interface:AWSKMS
Simplified method form for invoking the CreateKey operation. -
decrypt
Description copied from interface:AWSKMS
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. -
deleteAlias
Description copied from interface:AWSKMS
Deletes the specified alias. To map an alias to a different key, call UpdateAlias.
- Specified by:
deleteAlias
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the DeleteAlias operation returned by the service.
-
describeKey
Description copied from interface:AWSKMS
Provides detailed information about the specified customer master key.
- Specified by:
describeKey
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the DescribeKey operation returned by the service.
-
disableKey
Description copied from interface:AWSKMS
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:
disableKey
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the DisableKey operation returned by the service.
-
disableKeyRotation
Description copied from interface:AWSKMS
Disables rotation of the specified key.
- Specified by:
disableKeyRotation
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the DisableKeyRotation operation returned by the service.
-
enableKey
Description copied from interface:AWSKMS
Marks a key as enabled, thereby permitting its use.
-
enableKeyRotation
Description copied from interface:AWSKMS
Enables rotation of the specified customer master key.
- Specified by:
enableKeyRotation
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the EnableKeyRotation operation returned by the service.
-
encrypt
Description copied from interface:AWSKMS
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. -
-
generateDataKey
Description copied from interface:AWSKMS
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:
generateDataKey
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the GenerateDataKey operation returned by the service.
-
generateDataKeyWithoutPlaintext
public GenerateDataKeyWithoutPlaintextResult generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest request) Description copied from interface:AWSKMS
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:
generateDataKeyWithoutPlaintext
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the GenerateDataKeyWithoutPlaintext operation returned by the service.
-
generateRandom
Description copied from interface:AWSKMS
Generates an unpredictable byte string.
- Specified by:
generateRandom
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the GenerateRandom operation returned by the service.
-
generateRandom
Description copied from interface:AWSKMS
Simplified method form for invoking the GenerateRandom operation.- Specified by:
generateRandom
in interfaceAWSKMS
- See Also:
-
getKeyPolicy
Description copied from interface:AWSKMS
Retrieves a policy attached to the specified key.
- Specified by:
getKeyPolicy
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the GetKeyPolicy operation returned by the service.
-
getKeyRotationStatus
Description copied from interface:AWSKMS
Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
- Specified by:
getKeyRotationStatus
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the GetKeyRotationStatus operation returned by the service.
-
listAliases
Description copied from interface:AWSKMS
Lists all of the key aliases in the account.
- Specified by:
listAliases
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the ListAliases operation returned by the service.
-
listAliases
Description copied from interface:AWSKMS
Simplified method form for invoking the ListAliases operation.- Specified by:
listAliases
in interfaceAWSKMS
- See Also:
-
listGrants
Description copied from interface:AWSKMS
List the grants for a specified key.
- Specified by:
listGrants
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the ListGrants operation returned by the service.
-
listKeyPolicies
Description copied from interface:AWSKMS
Retrieves a list of policies attached to a key.
- Specified by:
listKeyPolicies
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the ListKeyPolicies operation returned by the service.
-
listKeys
Description copied from interface:AWSKMS
Lists the customer master keys.
-
listKeys
Description copied from interface:AWSKMS
Simplified method form for invoking the ListKeys operation. -
listRetirableGrants
Description copied from interface:AWSKMS
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:
listRetirableGrants
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the ListRetirableGrants operation returned by the service.
-
putKeyPolicy
Description copied from interface:AWSKMS
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:
putKeyPolicy
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the PutKeyPolicy operation returned by the service.
-
reEncrypt
Description copied from interface:AWSKMS
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. -
retireGrant
Description copied from interface:AWSKMS
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:
retireGrant
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the RetireGrant operation returned by the service.
-
-
retireGrant
Description copied from interface:AWSKMS
Simplified method form for invoking the RetireGrant operation.- Specified by:
retireGrant
in interfaceAWSKMS
- See Also:
-
revokeGrant
Description copied from interface:AWSKMS
Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
- Specified by:
revokeGrant
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the RevokeGrant operation returned by the service.
-
scheduleKeyDeletion
Description copied from interface:AWSKMS
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:
scheduleKeyDeletion
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the ScheduleKeyDeletion operation returned by the service.
-
updateAlias
Description copied from interface:AWSKMS
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:
updateAlias
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the UpdateAlias operation returned by the service.
-
updateKeyDescription
Description copied from interface:AWSKMS
Updates the description of a key.
- Specified by:
updateKeyDescription
in interfaceAWSKMS
- Parameters:
request
-- Returns:
- Result of the UpdateKeyDescription operation returned by the service.
-
shutdown
public void shutdown()Description copied from interface:AWSKMS
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests. -
getCachedResponseMetadata
Description copied from interface:AWSKMS
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
- Specified by:
getCachedResponseMetadata
in interfaceAWSKMS
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-