public class AbstractAWSKMS extends Object implements AWSKMS
AWSKMS. Convenient method forms pass
through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException.| Modifier and Type | Method and Description |
|---|---|
CancelKeyDeletionResult |
cancelKeyDeletion(CancelKeyDeletionRequest request)
Cancels the deletion of a customer master key (CMK).
|
CreateAliasResult |
createAlias(CreateAliasRequest request)
Creates a display name for a customer master key.
|
CreateGrantResult |
createGrant(CreateGrantRequest request)
Adds a grant to a key to specify who can use the key and under what
conditions.
|
CreateKeyResult |
createKey()
Simplified method form for invoking the CreateKey operation.
|
CreateKeyResult |
createKey(CreateKeyRequest request)
Creates a customer master key (CMK).
|
DecryptResult |
decrypt(DecryptRequest request)
Decrypts ciphertext.
|
DeleteAliasResult |
deleteAlias(DeleteAliasRequest request)
Deletes the specified alias.
|
DescribeKeyResult |
describeKey(DescribeKeyRequest request)
Provides detailed information about the specified customer master key.
|
DisableKeyResult |
disableKey(DisableKeyRequest request)
Sets the state of a customer master key (CMK) to disabled, thereby
preventing its use for cryptographic operations.
|
DisableKeyRotationResult |
disableKeyRotation(DisableKeyRotationRequest request)
Disables rotation of the specified key.
|
EnableKeyResult |
enableKey(EnableKeyRequest request)
Marks a key as enabled, thereby permitting its use.
|
EnableKeyRotationResult |
enableKeyRotation(EnableKeyRotationRequest request)
Enables rotation of the specified customer master key.
|
EncryptResult |
encrypt(EncryptRequest request)
Encrypts plaintext into ciphertext by using a customer master key.
|
GenerateDataKeyResult |
generateDataKey(GenerateDataKeyRequest request)
Generates a data key that you can use in your application to locally
encrypt data.
|
GenerateDataKeyWithoutPlaintextResult |
generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest request)
Returns a data key encrypted by a customer master key without the
plaintext copy of that key.
|
GenerateRandomResult |
generateRandom()
Simplified method form for invoking the GenerateRandom operation.
|
GenerateRandomResult |
generateRandom(GenerateRandomRequest request)
Generates an unpredictable byte string.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request,
typically used for debugging issues where a service isn't acting as
expected.
|
GetKeyPolicyResult |
getKeyPolicy(GetKeyPolicyRequest request)
Retrieves a policy attached to the specified key.
|
GetKeyRotationStatusResult |
getKeyRotationStatus(GetKeyRotationStatusRequest request)
Retrieves a Boolean value that indicates whether key rotation is enabled
for the specified key.
|
ListAliasesResult |
listAliases()
Simplified method form for invoking the ListAliases operation.
|
ListAliasesResult |
listAliases(ListAliasesRequest request)
Lists all of the key aliases in the account.
|
ListGrantsResult |
listGrants(ListGrantsRequest request)
List the grants for a specified key.
|
ListKeyPoliciesResult |
listKeyPolicies(ListKeyPoliciesRequest request)
Retrieves a list of policies attached to a key.
|
ListKeysResult |
listKeys()
Simplified method form for invoking the ListKeys operation.
|
ListKeysResult |
listKeys(ListKeysRequest request)
Lists the customer master keys.
|
ListRetirableGrantsResult |
listRetirableGrants(ListRetirableGrantsRequest request)
Returns a list of all grants for which the grant's
RetiringPrincipal matches the one specified. |
PutKeyPolicyResult |
putKeyPolicy(PutKeyPolicyRequest request)
Attaches a key policy to the specified customer master key (CMK).
|
ReEncryptResult |
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.
|
RetireGrantResult |
retireGrant()
Simplified method form for invoking the RetireGrant operation.
|
RetireGrantResult |
retireGrant(RetireGrantRequest request)
Retires a grant.
|
RevokeGrantResult |
revokeGrant(RevokeGrantRequest request)
Revokes a grant.
|
ScheduleKeyDeletionResult |
scheduleKeyDeletion(ScheduleKeyDeletionRequest request)
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 |
setRegion(Region region)
An alternative to
AWSKMS.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.
|
UpdateAliasResult |
updateAlias(UpdateAliasRequest request)
Updates an alias to map it to a different key.
|
UpdateKeyDescriptionResult |
updateKeyDescription(UpdateKeyDescriptionRequest request)
Updates the description of a key.
|
public void setEndpoint(String endpoint)
AWSKMS
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.
setEndpoint in interface AWSKMSendpoint - 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.public void setRegion(Region region)
AWSKMSAWSKMS.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.
setRegion in interface AWSKMSregion - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region. Must not be null and must be a region
where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public CancelKeyDeletionResult cancelKeyDeletion(CancelKeyDeletionRequest request)
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.
cancelKeyDeletion in interface AWSKMSpublic CreateAliasResult createAlias(CreateAliasRequest request)
AWSKMSCreates 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.
createAlias in interface AWSKMSpublic CreateGrantResult createGrant(CreateGrantRequest request)
AWSKMSAdds 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.
createGrant in interface AWSKMSpublic CreateKeyResult createKey(CreateKeyRequest request)
AWSKMSCreates 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
public CreateKeyResult createKey()
AWSKMScreateKey in interface AWSKMSAWSKMS.createKey(CreateKeyRequest)public DecryptResult decrypt(DecryptRequest request)
AWSKMSDecrypts 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 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.
public DeleteAliasResult deleteAlias(DeleteAliasRequest request)
AWSKMSDeletes the specified alias. To map an alias to a different key, call UpdateAlias.
deleteAlias in interface AWSKMSpublic DescribeKeyResult describeKey(DescribeKeyRequest request)
AWSKMSProvides detailed information about the specified customer master key.
describeKey in interface AWSKMSpublic DisableKeyResult disableKey(DisableKeyRequest request)
AWSKMSSets 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.
disableKey in interface AWSKMSpublic DisableKeyRotationResult disableKeyRotation(DisableKeyRotationRequest request)
AWSKMSDisables rotation of the specified key.
disableKeyRotation in interface AWSKMSpublic EnableKeyResult enableKey(EnableKeyRequest request)
AWSKMSMarks a key as enabled, thereby permitting its use.
public EnableKeyRotationResult enableKeyRotation(EnableKeyRotationRequest request)
AWSKMSEnables rotation of the specified customer master key.
enableKeyRotation in interface AWSKMSpublic EncryptResult encrypt(EncryptRequest request)
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.
public GenerateDataKeyResult generateDataKey(GenerateDataKeyRequest request)
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 the CiphertextBlob field. The key is encrypted
by using the master key specified by the KeyId field. To
decrypt the encrypted key, pass it to the Decrypt API.
We recommend that you use the following pattern to locally encrypt data:
call the GenerateDataKey API, use the key returned in the
Plaintext response field to locally encrypt data, and then
erase the plaintext data key from memory. Store the encrypted data key
(contained in the CiphertextBlob 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 the
Decrypt 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.
generateDataKey in interface AWSKMSpublic GenerateDataKeyWithoutPlaintextResult generateDataKeyWithoutPlaintext(GenerateDataKeyWithoutPlaintextRequest request)
AWSKMSReturns 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.
generateDataKeyWithoutPlaintext in interface AWSKMSpublic GenerateRandomResult generateRandom(GenerateRandomRequest request)
AWSKMSGenerates an unpredictable byte string.
generateRandom in interface AWSKMSpublic GenerateRandomResult generateRandom()
AWSKMSgenerateRandom in interface AWSKMSAWSKMS.generateRandom(GenerateRandomRequest)public GetKeyPolicyResult getKeyPolicy(GetKeyPolicyRequest request)
AWSKMSRetrieves a policy attached to the specified key.
getKeyPolicy in interface AWSKMSpublic GetKeyRotationStatusResult getKeyRotationStatus(GetKeyRotationStatusRequest request)
AWSKMSRetrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
getKeyRotationStatus in interface AWSKMSpublic ListAliasesResult listAliases(ListAliasesRequest request)
AWSKMSLists all of the key aliases in the account.
listAliases in interface AWSKMSpublic ListAliasesResult listAliases()
AWSKMSlistAliases in interface AWSKMSAWSKMS.listAliases(ListAliasesRequest)public ListGrantsResult listGrants(ListGrantsRequest request)
AWSKMSList the grants for a specified key.
listGrants in interface AWSKMSpublic ListKeyPoliciesResult listKeyPolicies(ListKeyPoliciesRequest request)
AWSKMSRetrieves a list of policies attached to a key.
listKeyPolicies in interface AWSKMSpublic ListKeysResult listKeys(ListKeysRequest request)
AWSKMSLists the customer master keys.
public ListKeysResult listKeys()
AWSKMSlistKeys in interface AWSKMSAWSKMS.listKeys(ListKeysRequest)public ListRetirableGrantsResult listRetirableGrants(ListRetirableGrantsRequest request)
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.
listRetirableGrants in interface AWSKMSpublic PutKeyPolicyResult putKeyPolicy(PutKeyPolicyRequest request)
AWSKMSAttaches 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.
putKeyPolicy in interface AWSKMSpublic ReEncryptResult reEncrypt(ReEncryptRequest request)
AWSKMSEncrypts 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
as ReEncryptFrom on the source key and once as
ReEncryptTo 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.
public RetireGrantResult retireGrant(RetireGrantRequest request)
AWSKMSRetires 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, if RetireGrant 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.
retireGrant in interface AWSKMSpublic RetireGrantResult retireGrant()
AWSKMSretireGrant in interface AWSKMSAWSKMS.retireGrant(RetireGrantRequest)public RevokeGrantResult revokeGrant(RevokeGrantRequest request)
AWSKMSRevokes a grant. You can revoke a grant to actively deny operations that depend on it.
revokeGrant in interface AWSKMSpublic ScheduleKeyDeletionResult scheduleKeyDeletion(ScheduleKeyDeletionRequest request)
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.
scheduleKeyDeletion in interface AWSKMSpublic UpdateAliasResult updateAlias(UpdateAliasRequest request)
AWSKMSUpdates 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.
updateAlias in interface AWSKMSpublic UpdateKeyDescriptionResult updateKeyDescription(UpdateKeyDescriptionRequest request)
AWSKMSUpdates the description of a key.
updateKeyDescription in interface AWSKMSpublic void shutdown()
AWSKMSpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSKMSResponse 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.
getCachedResponseMetadata in interface AWSKMSrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.