com.amazonaws.services.kms.model.CreateKeyRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kms.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateKeyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The key policy to attach to the KMS key.
*
*
* If you provide a key policy, it must meet the following criteria:
*
*
* -
*
* The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS
* key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set
* BypassPolicyLockoutSafetyCheck to true.)
*
*
* -
*
* Each statement in the key policy must contain one or more principals. The principals in the key policy must exist
* and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay
* before including the new principal in a key policy because the new principal might not be immediately visible to
* KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access
* Management User Guide.
*
*
*
*
* If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see
* Default key
* policy in the Key Management Service Developer Guide.
*
*
* The key policy size quota is 32 kilobytes (32768 bytes).
*
*
* For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in
* the Identity and Access Management User Guide .
*
*/
private String policy;
/**
*
* A description of the KMS key. Use a description that helps you decide whether the KMS key is appropriate for a
* task. The default value is an empty string (no description).
*
*
*
* Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in
* CloudTrail logs and other output.
*
*
*
* To set or change the description after the key is created, use UpdateKeyDescription.
*
*/
private String description;
/**
*
* Determines the cryptographic
* operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This
* parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't
* change the KeyUsage value after the KMS key is created.
*
*
* Select only one valid value.
*
*
* -
*
* For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
*
*
* -
*
* For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
*
*
* -
*
* For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or
* KEY_AGREEMENT.
*
*
* -
*
* For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT,
* SIGN_VERIFY, or KEY_AGREEMENT.
*
*
*
*/
private String keyUsage;
/**
*
* Instead, use the KeySpec parameter.
*
*
* The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the names
* differ. We recommend that you use KeySpec parameter in your code. However, to avoid breaking
* changes, KMS supports both parameters.
*
*/
@Deprecated
private String customerMasterKeySpec;
/**
*
* Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key
* with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates
* a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key
* type in the Key Management Service Developer Guide .
*
*
* The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It
* also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS
* key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its
* key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
*
*
*
* Amazon Web Services services that are
* integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support
* asymmetric KMS keys or HMAC KMS keys.
*
*
*
* KMS supports the following key specs for KMS keys:
*
*
* -
*
* Symmetric encryption key (default)
*
*
* -
*
* SYMMETRIC_DEFAULT
*
*
*
*
* -
*
* HMAC keys (symmetric)
*
*
* -
*
* HMAC_224
*
*
* -
*
* HMAC_256
*
*
* -
*
* HMAC_384
*
*
* -
*
* HMAC_512
*
*
*
*
* -
*
* Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
*
*
* -
*
* RSA_2048
*
*
* -
*
* RSA_3072
*
*
* -
*
* RSA_4096
*
*
*
*
* -
*
* Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)
*
*
* -
*
* ECC_NIST_P256 (secp256r1)
*
*
* -
*
* ECC_NIST_P384 (secp384r1)
*
*
* -
*
* ECC_NIST_P521 (secp521r1)
*
*
*
*
* -
*
* Other asymmetric elliptic curve key pairs (signing and verification)
*
*
* -
*
* ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
*
*
*
*
* -
*
* SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
*
*
* -
*
* SM2 (China Regions only)
*
*
*
*
*
*/
private String keySpec;
/**
*
* The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The
* default is AWS_KMS, which means that KMS creates the key material.
*
*
* To create a KMS
* key with no key material (for imported key material), set this value to EXTERNAL. For more
* information about importing key material into KMS, see Importing Key Material in
* the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for
* symmetric KMS keys.
*
*
* To create a KMS key in
* an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to
* AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM
* key store. The KeySpec value must be SYMMETRIC_DEFAULT.
*
*
* To create a KMS key in an
* external key store, set this value to EXTERNAL_KEY_STORE. You must also use the
* CustomKeyStoreId parameter to identify the external key store and the XksKeyId
* parameter to identify the associated external key. The KeySpec value must be
* SYMMETRIC_DEFAULT.
*
*/
private String origin;
/**
*
* Creates the KMS key in the specified custom key store.
* The ConnectionState of the custom key store must be CONNECTED. To find the
* CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.
*
*
* This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other
* type of KMS key in a custom key store.
*
*
* When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key in its
* associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key
* store, you must use the XksKeyId parameter to specify an external key that serves as key material
* for the KMS key.
*
*/
private String customKeyStoreId;
/**
*
* Skips ("bypasses") the key policy lockout safety check. The default value is false.
*
*
*
* Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to
* true indiscriminately.
*
*
* For more information, see Default key policy in the Key Management Service Developer Guide.
*
*
*
* Use this parameter only when you intend to prevent the principal that is making the request from making a
* subsequent PutKeyPolicy
* request on the KMS key.
*
*/
private Boolean bypassPolicyLockoutSafetyCheck;
/**
*
* Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created. To tag an
* existing KMS key, use the TagResource operation.
*
*
*
* Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in
* CloudTrail logs and other output.
*
*
*
* Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management
* Service Developer Guide.
*
*
*
* To use this parameter, you must have kms:TagResource permission in an IAM policy.
*
*
* Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag
* value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you
* specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified
* one.
*
*
* When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with
* usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You cannot
* change this value after you create the KMS key.
*
*
* For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this parameter
* or set it to False. The default value is False.
*
*
* This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS
* keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and
* other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it
* in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more
* information about multi-Region keys, see Multi-Region keys in
* KMS in the Key Management Service Developer Guide.
*
*
* This value creates a primary key, not a replica. To create a replica key, use the
* ReplicateKey operation.
*
*
* You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported
* key material. However, you cannot create a multi-Region key in a custom key store.
*
*/
private Boolean multiRegion;
/**
*
* Identifies the external
* key that serves as key material for the KMS key in an external key store.
* Specify the ID that the external
* key store proxy uses to refer to the external key. For help, see the documentation for your external key
* store proxy.
*
*
* This parameter is required for a KMS key with an Origin value of EXTERNAL_KEY_STORE. It
* is not valid for KMS keys with any other Origin value.
*
*
* The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web Services
* in an external key manager associated with the external key store specified by the CustomKeyStoreId
* parameter. This key must be enabled and configured to perform encryption and decryption. Each KMS key in an
* external key store must use a different external key. For details, see Requirements for a KMS key in an
* external key store in the Key Management Service Developer Guide.
*
*
* Each KMS key in an external key store is associated two backing keys. One is key material that KMS generates. The
* other is the external key specified by this parameter. When you use the KMS key in an external key store to
* encrypt data, the encryption operation is performed first by KMS using the KMS key material, and then by the
* external key manager using the specified external key, a process known as double encryption. For details,
* see Double encryption in the Key Management Service Developer Guide.
*
*/
private String xksKeyId;
/**
*
* The key policy to attach to the KMS key.
*
*
* If you provide a key policy, it must meet the following criteria:
*
*
* -
*
* The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS
* key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set
* BypassPolicyLockoutSafetyCheck to true.)
*
*
* -
*
* Each statement in the key policy must contain one or more principals. The principals in the key policy must exist
* and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay
* before including the new principal in a key policy because the new principal might not be immediately visible to
* KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access
* Management User Guide.
*
*
*
*
* If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see
* Default key
* policy in the Key Management Service Developer Guide.
*
*
* The key policy size quota is 32 kilobytes (32768 bytes).
*
*
* For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in
* the Identity and Access Management User Guide .
*
*
* @param policy
* The key policy to attach to the KMS key.
*
* If you provide a key policy, it must meet the following criteria:
*
*
* -
*
* The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on
* the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set
* BypassPolicyLockoutSafetyCheck to true.)
*
*
* -
*
* Each statement in the key policy must contain one or more principals. The principals in the key policy
* must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to
* enforce a delay before including the new principal in a key policy because the new principal might not be
* immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and
* Access Management User Guide.
*
*
*
*
* If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more
* information, see Default
* key policy in the Key Management Service Developer Guide.
*
*
* The key policy size quota is 32 kilobytes (32768 bytes).
*
*
* For help writing and formatting a JSON policy document, see the IAM JSON Policy
* Reference in the Identity and Access Management User Guide .
*/
public void setPolicy(String policy) {
this.policy = policy;
}
/**
*
* The key policy to attach to the KMS key.
*
*
* If you provide a key policy, it must meet the following criteria:
*
*
* -
*
* The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS
* key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set
* BypassPolicyLockoutSafetyCheck to true.)
*
*
* -
*
* Each statement in the key policy must contain one or more principals. The principals in the key policy must exist
* and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay
* before including the new principal in a key policy because the new principal might not be immediately visible to
* KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access
* Management User Guide.
*
*
*
*
* If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see
* Default key
* policy in the Key Management Service Developer Guide.
*
*
* The key policy size quota is 32 kilobytes (32768 bytes).
*
*
* For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in
* the Identity and Access Management User Guide .
*
*
* @return The key policy to attach to the KMS key.
*
* If you provide a key policy, it must meet the following criteria:
*
*
* -
*
* The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on
* the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition,
* set BypassPolicyLockoutSafetyCheck to true.)
*
*
* -
*
* Each statement in the key policy must contain one or more principals. The principals in the key policy
* must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to
* enforce a delay before including the new principal in a key policy because the new principal might not be
* immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and
* Access Management User Guide.
*
*
*
*
* If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more
* information, see Default
* key policy in the Key Management Service Developer Guide.
*
*
* The key policy size quota is 32 kilobytes (32768 bytes).
*
*
* For help writing and formatting a JSON policy document, see the IAM JSON Policy
* Reference in the Identity and Access Management User Guide .
*/
public String getPolicy() {
return this.policy;
}
/**
*
* The key policy to attach to the KMS key.
*
*
* If you provide a key policy, it must meet the following criteria:
*
*
* -
*
* The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS
* key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set
* BypassPolicyLockoutSafetyCheck to true.)
*
*
* -
*
* Each statement in the key policy must contain one or more principals. The principals in the key policy must exist
* and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay
* before including the new principal in a key policy because the new principal might not be immediately visible to
* KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access
* Management User Guide.
*
*
*
*
* If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see
* Default key
* policy in the Key Management Service Developer Guide.
*
*
* The key policy size quota is 32 kilobytes (32768 bytes).
*
*
* For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in
* the Identity and Access Management User Guide .
*
*
* @param policy
* The key policy to attach to the KMS key.
*
* If you provide a key policy, it must meet the following criteria:
*
*
* -
*
* The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on
* the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set
* BypassPolicyLockoutSafetyCheck to true.)
*
*
* -
*
* Each statement in the key policy must contain one or more principals. The principals in the key policy
* must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to
* enforce a delay before including the new principal in a key policy because the new principal might not be
* immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and
* Access Management User Guide.
*
*
*
*
* If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more
* information, see Default
* key policy in the Key Management Service Developer Guide.
*
*
* The key policy size quota is 32 kilobytes (32768 bytes).
*
*
* For help writing and formatting a JSON policy document, see the IAM JSON Policy
* Reference in the Identity and Access Management User Guide .
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateKeyRequest withPolicy(String policy) {
setPolicy(policy);
return this;
}
/**
*
* A description of the KMS key. Use a description that helps you decide whether the KMS key is appropriate for a
* task. The default value is an empty string (no description).
*
*
*
* Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in
* CloudTrail logs and other output.
*
*
*
* To set or change the description after the key is created, use UpdateKeyDescription.
*
*
* @param description
* A description of the KMS key. Use a description that helps you decide whether the KMS key is appropriate
* for a task. The default value is an empty string (no description).
*
* Do not include confidential or sensitive information in this field. This field may be displayed in
* plaintext in CloudTrail logs and other output.
*
*
*
* To set or change the description after the key is created, use UpdateKeyDescription.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A description of the KMS key. Use a description that helps you decide whether the KMS key is appropriate for a
* task. The default value is an empty string (no description).
*
*
*
* Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in
* CloudTrail logs and other output.
*
*
*
* To set or change the description after the key is created, use UpdateKeyDescription.
*
*
* @return A description of the KMS key. Use a description that helps you decide whether the KMS key is appropriate
* for a task. The default value is an empty string (no description).
*
* Do not include confidential or sensitive information in this field. This field may be displayed in
* plaintext in CloudTrail logs and other output.
*
*
*
* To set or change the description after the key is created, use UpdateKeyDescription.
*/
public String getDescription() {
return this.description;
}
/**
*
* A description of the KMS key. Use a description that helps you decide whether the KMS key is appropriate for a
* task. The default value is an empty string (no description).
*
*
*
* Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in
* CloudTrail logs and other output.
*
*
*
* To set or change the description after the key is created, use UpdateKeyDescription.
*
*
* @param description
* A description of the KMS key. Use a description that helps you decide whether the KMS key is appropriate
* for a task. The default value is an empty string (no description).
*
* Do not include confidential or sensitive information in this field. This field may be displayed in
* plaintext in CloudTrail logs and other output.
*
*
*
* To set or change the description after the key is created, use UpdateKeyDescription.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateKeyRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* Determines the cryptographic
* operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This
* parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't
* change the KeyUsage value after the KMS key is created.
*
*
* Select only one valid value.
*
*
* -
*
* For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
*
*
* -
*
* For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
*
*
* -
*
* For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or
* KEY_AGREEMENT.
*
*
* -
*
* For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT,
* SIGN_VERIFY, or KEY_AGREEMENT.
*
*
*
*
* @param keyUsage
* Determines the cryptographic operations for which you can use the KMS key. The default value is
* ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption KMS
* key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is
* created.
*
* Select only one valid value.
*
*
* -
*
* For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
*
*
* -
*
* For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
*
*
* -
*
* For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or
* SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY
* or KEY_AGREEMENT.
*
*
* -
*
* For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT,
* SIGN_VERIFY, or KEY_AGREEMENT.
*
*
* @see KeyUsageType
*/
public void setKeyUsage(String keyUsage) {
this.keyUsage = keyUsage;
}
/**
*
* Determines the cryptographic
* operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This
* parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't
* change the KeyUsage value after the KMS key is created.
*
*
* Select only one valid value.
*
*
* -
*
* For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
*
*
* -
*
* For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
*
*
* -
*
* For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or
* KEY_AGREEMENT.
*
*
* -
*
* For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT,
* SIGN_VERIFY, or KEY_AGREEMENT.
*
*
*
*
* @return Determines the cryptographic operations for which you can use the KMS key. The default value is
* ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption KMS
* key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is
* created.
*
* Select only one valid value.
*
*
* -
*
* For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
*
*
* -
*
* For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
*
*
* -
*
* For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or
* SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY
* or KEY_AGREEMENT.
*
*
* -
*
* For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT,
* SIGN_VERIFY, or KEY_AGREEMENT.
*
*
* @see KeyUsageType
*/
public String getKeyUsage() {
return this.keyUsage;
}
/**
*
* Determines the cryptographic
* operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This
* parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't
* change the KeyUsage value after the KMS key is created.
*
*
* Select only one valid value.
*
*
* -
*
* For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
*
*
* -
*
* For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
*
*
* -
*
* For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or
* KEY_AGREEMENT.
*
*
* -
*
* For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT,
* SIGN_VERIFY, or KEY_AGREEMENT.
*
*
*
*
* @param keyUsage
* Determines the cryptographic operations for which you can use the KMS key. The default value is
* ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption KMS
* key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is
* created.
*
* Select only one valid value.
*
*
* -
*
* For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
*
*
* -
*
* For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
*
*
* -
*
* For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or
* SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY
* or KEY_AGREEMENT.
*
*
* -
*
* For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT,
* SIGN_VERIFY, or KEY_AGREEMENT.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeyUsageType
*/
public CreateKeyRequest withKeyUsage(String keyUsage) {
setKeyUsage(keyUsage);
return this;
}
/**
*
* Determines the cryptographic
* operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This
* parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't
* change the KeyUsage value after the KMS key is created.
*
*
* Select only one valid value.
*
*
* -
*
* For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
*
*
* -
*
* For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
*
*
* -
*
* For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or
* KEY_AGREEMENT.
*
*
* -
*
* For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT,
* SIGN_VERIFY, or KEY_AGREEMENT.
*
*
*
*
* @param keyUsage
* Determines the cryptographic operations for which you can use the KMS key. The default value is
* ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption KMS
* key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is
* created.
*
* Select only one valid value.
*
*
* -
*
* For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
*
*
* -
*
* For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
*
*
* -
*
* For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or
* SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY
* or KEY_AGREEMENT.
*
*
* -
*
* For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT,
* SIGN_VERIFY, or KEY_AGREEMENT.
*
*
* @see KeyUsageType
*/
public void setKeyUsage(KeyUsageType keyUsage) {
withKeyUsage(keyUsage);
}
/**
*
* Determines the cryptographic
* operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This
* parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't
* change the KeyUsage value after the KMS key is created.
*
*
* Select only one valid value.
*
*
* -
*
* For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
*
*
* -
*
* For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
*
*
* -
*
* For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or
* KEY_AGREEMENT.
*
*
* -
*
* For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT,
* SIGN_VERIFY, or KEY_AGREEMENT.
*
*
*
*
* @param keyUsage
* Determines the cryptographic operations for which you can use the KMS key. The default value is
* ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption KMS
* key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is
* created.
*
* Select only one valid value.
*
*
* -
*
* For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
*
*
* -
*
* For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
*
*
* -
*
* For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or
* SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY
* or KEY_AGREEMENT.
*
*
* -
*
* For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
*
*
* -
*
* For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT,
* SIGN_VERIFY, or KEY_AGREEMENT.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeyUsageType
*/
public CreateKeyRequest withKeyUsage(KeyUsageType keyUsage) {
this.keyUsage = keyUsage.toString();
return this;
}
/**
*
* Instead, use the KeySpec parameter.
*
*
* The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the names
* differ. We recommend that you use KeySpec parameter in your code. However, to avoid breaking
* changes, KMS supports both parameters.
*
*
* @param customerMasterKeySpec
* Instead, use the KeySpec parameter.
*
* The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the
* names differ. We recommend that you use KeySpec parameter in your code. However, to avoid
* breaking changes, KMS supports both parameters.
* @see CustomerMasterKeySpec
*/
@Deprecated
public void setCustomerMasterKeySpec(String customerMasterKeySpec) {
this.customerMasterKeySpec = customerMasterKeySpec;
}
/**
*
* Instead, use the KeySpec parameter.
*
*
* The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the names
* differ. We recommend that you use KeySpec parameter in your code. However, to avoid breaking
* changes, KMS supports both parameters.
*
*
* @return Instead, use the KeySpec parameter.
*
* The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the
* names differ. We recommend that you use KeySpec parameter in your code. However, to avoid
* breaking changes, KMS supports both parameters.
* @see CustomerMasterKeySpec
*/
@Deprecated
public String getCustomerMasterKeySpec() {
return this.customerMasterKeySpec;
}
/**
*
* Instead, use the KeySpec parameter.
*
*
* The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the names
* differ. We recommend that you use KeySpec parameter in your code. However, to avoid breaking
* changes, KMS supports both parameters.
*
*
* @param customerMasterKeySpec
* Instead, use the KeySpec parameter.
*
* The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the
* names differ. We recommend that you use KeySpec parameter in your code. However, to avoid
* breaking changes, KMS supports both parameters.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CustomerMasterKeySpec
*/
@Deprecated
public CreateKeyRequest withCustomerMasterKeySpec(String customerMasterKeySpec) {
setCustomerMasterKeySpec(customerMasterKeySpec);
return this;
}
/**
*
* Instead, use the KeySpec parameter.
*
*
* The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the names
* differ. We recommend that you use KeySpec parameter in your code. However, to avoid breaking
* changes, KMS supports both parameters.
*
*
* @param customerMasterKeySpec
* Instead, use the KeySpec parameter.
*
* The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the
* names differ. We recommend that you use KeySpec parameter in your code. However, to avoid
* breaking changes, KMS supports both parameters.
* @see CustomerMasterKeySpec
*/
@Deprecated
public void setCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec) {
withCustomerMasterKeySpec(customerMasterKeySpec);
}
/**
*
* Instead, use the KeySpec parameter.
*
*
* The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the names
* differ. We recommend that you use KeySpec parameter in your code. However, to avoid breaking
* changes, KMS supports both parameters.
*
*
* @param customerMasterKeySpec
* Instead, use the KeySpec parameter.
*
* The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the
* names differ. We recommend that you use KeySpec parameter in your code. However, to avoid
* breaking changes, KMS supports both parameters.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CustomerMasterKeySpec
*/
@Deprecated
public CreateKeyRequest withCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec) {
this.customerMasterKeySpec = customerMasterKeySpec.toString();
return this;
}
/**
*
* Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key
* with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates
* a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key
* type in the Key Management Service Developer Guide .
*
*
* The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It
* also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS
* key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its
* key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
*
*
*
* Amazon Web Services services that are
* integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support
* asymmetric KMS keys or HMAC KMS keys.
*
*
*
* KMS supports the following key specs for KMS keys:
*
*
* -
*
* Symmetric encryption key (default)
*
*
* -
*
* SYMMETRIC_DEFAULT
*
*
*
*
* -
*
* HMAC keys (symmetric)
*
*
* -
*
* HMAC_224
*
*
* -
*
* HMAC_256
*
*
* -
*
* HMAC_384
*
*
* -
*
* HMAC_512
*
*
*
*
* -
*
* Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
*
*
* -
*
* RSA_2048
*
*
* -
*
* RSA_3072
*
*
* -
*
* RSA_4096
*
*
*
*
* -
*
* Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)
*
*
* -
*
* ECC_NIST_P256 (secp256r1)
*
*
* -
*
* ECC_NIST_P384 (secp384r1)
*
*
* -
*
* ECC_NIST_P521 (secp521r1)
*
*
*
*
* -
*
* Other asymmetric elliptic curve key pairs (signing and verification)
*
*
* -
*
* ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
*
*
*
*
* -
*
* SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
*
*
* -
*
* SM2 (China Regions only)
*
*
*
*
*
*
* @param keySpec
* Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS
* key with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where
* it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS
* key, see Choosing a
* KMS key type in the Key Management Service Developer Guide .
*
* The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key
* pair. It also determines the algorithms that the KMS key supports. You can't change the
* KeySpec after the KMS key is created. To further restrict the algorithms that can be used
* with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
*
*
*
* Amazon Web Services services that
* are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not
* support asymmetric KMS keys or HMAC KMS keys.
*
*
*
* KMS supports the following key specs for KMS keys:
*
*
* -
*
* Symmetric encryption key (default)
*
*
* -
*
* SYMMETRIC_DEFAULT
*
*
*
*
* -
*
* HMAC keys (symmetric)
*
*
* -
*
* HMAC_224
*
*
* -
*
* HMAC_256
*
*
* -
*
* HMAC_384
*
*
* -
*
* HMAC_512
*
*
*
*
* -
*
* Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
*
*
* -
*
* RSA_2048
*
*
* -
*
* RSA_3072
*
*
* -
*
* RSA_4096
*
*
*
*
* -
*
* Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared
* secrets)
*
*
* -
*
* ECC_NIST_P256 (secp256r1)
*
*
* -
*
* ECC_NIST_P384 (secp384r1)
*
*
* -
*
* ECC_NIST_P521 (secp521r1)
*
*
*
*
* -
*
* Other asymmetric elliptic curve key pairs (signing and verification)
*
*
* -
*
* ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
*
*
*
*
* -
*
* SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
*
*
* -
*
* SM2 (China Regions only)
*
*
*
*
* @see KeySpec
*/
public void setKeySpec(String keySpec) {
this.keySpec = keySpec;
}
/**
*
* Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key
* with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates
* a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key
* type in the Key Management Service Developer Guide .
*
*
* The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It
* also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS
* key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its
* key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
*
*
*
* Amazon Web Services services that are
* integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support
* asymmetric KMS keys or HMAC KMS keys.
*
*
*
* KMS supports the following key specs for KMS keys:
*
*
* -
*
* Symmetric encryption key (default)
*
*
* -
*
* SYMMETRIC_DEFAULT
*
*
*
*
* -
*
* HMAC keys (symmetric)
*
*
* -
*
* HMAC_224
*
*
* -
*
* HMAC_256
*
*
* -
*
* HMAC_384
*
*
* -
*
* HMAC_512
*
*
*
*
* -
*
* Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
*
*
* -
*
* RSA_2048
*
*
* -
*
* RSA_3072
*
*
* -
*
* RSA_4096
*
*
*
*
* -
*
* Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)
*
*
* -
*
* ECC_NIST_P256 (secp256r1)
*
*
* -
*
* ECC_NIST_P384 (secp384r1)
*
*
* -
*
* ECC_NIST_P521 (secp521r1)
*
*
*
*
* -
*
* Other asymmetric elliptic curve key pairs (signing and verification)
*
*
* -
*
* ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
*
*
*
*
* -
*
* SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
*
*
* -
*
* SM2 (China Regions only)
*
*
*
*
*
*
* @return Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS
* key with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where
* it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS
* key, see Choosing a
* KMS key type in the Key Management Service Developer Guide .
*
* The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key
* pair. It also determines the algorithms that the KMS key supports. You can't change the
* KeySpec after the KMS key is created. To further restrict the algorithms that can be used
* with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
*
*
*
* Amazon Web Services services that
* are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not
* support asymmetric KMS keys or HMAC KMS keys.
*
*
*
* KMS supports the following key specs for KMS keys:
*
*
* -
*
* Symmetric encryption key (default)
*
*
* -
*
* SYMMETRIC_DEFAULT
*
*
*
*
* -
*
* HMAC keys (symmetric)
*
*
* -
*
* HMAC_224
*
*
* -
*
* HMAC_256
*
*
* -
*
* HMAC_384
*
*
* -
*
* HMAC_512
*
*
*
*
* -
*
* Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
*
*
* -
*
* RSA_2048
*
*
* -
*
* RSA_3072
*
*
* -
*
* RSA_4096
*
*
*
*
* -
*
* Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared
* secrets)
*
*
* -
*
* ECC_NIST_P256 (secp256r1)
*
*
* -
*
* ECC_NIST_P384 (secp384r1)
*
*
* -
*
* ECC_NIST_P521 (secp521r1)
*
*
*
*
* -
*
* Other asymmetric elliptic curve key pairs (signing and verification)
*
*
* -
*
* ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
*
*
*
*
* -
*
* SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
*
*
* -
*
* SM2 (China Regions only)
*
*
*
*
* @see KeySpec
*/
public String getKeySpec() {
return this.keySpec;
}
/**
*
* Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key
* with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates
* a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key
* type in the Key Management Service Developer Guide .
*
*
* The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It
* also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS
* key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its
* key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
*
*
*
* Amazon Web Services services that are
* integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support
* asymmetric KMS keys or HMAC KMS keys.
*
*
*
* KMS supports the following key specs for KMS keys:
*
*
* -
*
* Symmetric encryption key (default)
*
*
* -
*
* SYMMETRIC_DEFAULT
*
*
*
*
* -
*
* HMAC keys (symmetric)
*
*
* -
*
* HMAC_224
*
*
* -
*
* HMAC_256
*
*
* -
*
* HMAC_384
*
*
* -
*
* HMAC_512
*
*
*
*
* -
*
* Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
*
*
* -
*
* RSA_2048
*
*
* -
*
* RSA_3072
*
*
* -
*
* RSA_4096
*
*
*
*
* -
*
* Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)
*
*
* -
*
* ECC_NIST_P256 (secp256r1)
*
*
* -
*
* ECC_NIST_P384 (secp384r1)
*
*
* -
*
* ECC_NIST_P521 (secp521r1)
*
*
*
*
* -
*
* Other asymmetric elliptic curve key pairs (signing and verification)
*
*
* -
*
* ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
*
*
*
*
* -
*
* SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
*
*
* -
*
* SM2 (China Regions only)
*
*
*
*
*
*
* @param keySpec
* Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS
* key with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where
* it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS
* key, see Choosing a
* KMS key type in the Key Management Service Developer Guide .
*
* The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key
* pair. It also determines the algorithms that the KMS key supports. You can't change the
* KeySpec after the KMS key is created. To further restrict the algorithms that can be used
* with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
*
*
*
* Amazon Web Services services that
* are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not
* support asymmetric KMS keys or HMAC KMS keys.
*
*
*
* KMS supports the following key specs for KMS keys:
*
*
* -
*
* Symmetric encryption key (default)
*
*
* -
*
* SYMMETRIC_DEFAULT
*
*
*
*
* -
*
* HMAC keys (symmetric)
*
*
* -
*
* HMAC_224
*
*
* -
*
* HMAC_256
*
*
* -
*
* HMAC_384
*
*
* -
*
* HMAC_512
*
*
*
*
* -
*
* Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
*
*
* -
*
* RSA_2048
*
*
* -
*
* RSA_3072
*
*
* -
*
* RSA_4096
*
*
*
*
* -
*
* Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared
* secrets)
*
*
* -
*
* ECC_NIST_P256 (secp256r1)
*
*
* -
*
* ECC_NIST_P384 (secp384r1)
*
*
* -
*
* ECC_NIST_P521 (secp521r1)
*
*
*
*
* -
*
* Other asymmetric elliptic curve key pairs (signing and verification)
*
*
* -
*
* ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
*
*
*
*
* -
*
* SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
*
*
* -
*
* SM2 (China Regions only)
*
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeySpec
*/
public CreateKeyRequest withKeySpec(String keySpec) {
setKeySpec(keySpec);
return this;
}
/**
*
* Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key
* with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates
* a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key
* type in the Key Management Service Developer Guide .
*
*
* The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It
* also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS
* key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its
* key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
*
*
*
* Amazon Web Services services that are
* integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support
* asymmetric KMS keys or HMAC KMS keys.
*
*
*
* KMS supports the following key specs for KMS keys:
*
*
* -
*
* Symmetric encryption key (default)
*
*
* -
*
* SYMMETRIC_DEFAULT
*
*
*
*
* -
*
* HMAC keys (symmetric)
*
*
* -
*
* HMAC_224
*
*
* -
*
* HMAC_256
*
*
* -
*
* HMAC_384
*
*
* -
*
* HMAC_512
*
*
*
*
* -
*
* Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
*
*
* -
*
* RSA_2048
*
*
* -
*
* RSA_3072
*
*
* -
*
* RSA_4096
*
*
*
*
* -
*
* Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)
*
*
* -
*
* ECC_NIST_P256 (secp256r1)
*
*
* -
*
* ECC_NIST_P384 (secp384r1)
*
*
* -
*
* ECC_NIST_P521 (secp521r1)
*
*
*
*
* -
*
* Other asymmetric elliptic curve key pairs (signing and verification)
*
*
* -
*
* ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
*
*
*
*
* -
*
* SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
*
*
* -
*
* SM2 (China Regions only)
*
*
*
*
*
*
* @param keySpec
* Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS
* key with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where
* it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS
* key, see Choosing a
* KMS key type in the Key Management Service Developer Guide .
*
* The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key
* pair. It also determines the algorithms that the KMS key supports. You can't change the
* KeySpec after the KMS key is created. To further restrict the algorithms that can be used
* with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
*
*
*
* Amazon Web Services services that
* are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not
* support asymmetric KMS keys or HMAC KMS keys.
*
*
*
* KMS supports the following key specs for KMS keys:
*
*
* -
*
* Symmetric encryption key (default)
*
*
* -
*
* SYMMETRIC_DEFAULT
*
*
*
*
* -
*
* HMAC keys (symmetric)
*
*
* -
*
* HMAC_224
*
*
* -
*
* HMAC_256
*
*
* -
*
* HMAC_384
*
*
* -
*
* HMAC_512
*
*
*
*
* -
*
* Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
*
*
* -
*
* RSA_2048
*
*
* -
*
* RSA_3072
*
*
* -
*
* RSA_4096
*
*
*
*
* -
*
* Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared
* secrets)
*
*
* -
*
* ECC_NIST_P256 (secp256r1)
*
*
* -
*
* ECC_NIST_P384 (secp384r1)
*
*
* -
*
* ECC_NIST_P521 (secp521r1)
*
*
*
*
* -
*
* Other asymmetric elliptic curve key pairs (signing and verification)
*
*
* -
*
* ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
*
*
*
*
* -
*
* SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
*
*
* -
*
* SM2 (China Regions only)
*
*
*
*
* @see KeySpec
*/
public void setKeySpec(KeySpec keySpec) {
withKeySpec(keySpec);
}
/**
*
* Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key
* with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates
* a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key
* type in the Key Management Service Developer Guide .
*
*
* The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It
* also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS
* key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its
* key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
*
*
*
* Amazon Web Services services that are
* integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support
* asymmetric KMS keys or HMAC KMS keys.
*
*
*
* KMS supports the following key specs for KMS keys:
*
*
* -
*
* Symmetric encryption key (default)
*
*
* -
*
* SYMMETRIC_DEFAULT
*
*
*
*
* -
*
* HMAC keys (symmetric)
*
*
* -
*
* HMAC_224
*
*
* -
*
* HMAC_256
*
*
* -
*
* HMAC_384
*
*
* -
*
* HMAC_512
*
*
*
*
* -
*
* Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
*
*
* -
*
* RSA_2048
*
*
* -
*
* RSA_3072
*
*
* -
*
* RSA_4096
*
*
*
*
* -
*
* Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)
*
*
* -
*
* ECC_NIST_P256 (secp256r1)
*
*
* -
*
* ECC_NIST_P384 (secp384r1)
*
*
* -
*
* ECC_NIST_P521 (secp521r1)
*
*
*
*
* -
*
* Other asymmetric elliptic curve key pairs (signing and verification)
*
*
* -
*
* ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
*
*
*
*
* -
*
* SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
*
*
* -
*
* SM2 (China Regions only)
*
*
*
*
*
*
* @param keySpec
* Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS
* key with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where
* it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS
* key, see Choosing a
* KMS key type in the Key Management Service Developer Guide .
*
* The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key
* pair. It also determines the algorithms that the KMS key supports. You can't change the
* KeySpec after the KMS key is created. To further restrict the algorithms that can be used
* with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
*
*
*
* Amazon Web Services services that
* are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not
* support asymmetric KMS keys or HMAC KMS keys.
*
*
*
* KMS supports the following key specs for KMS keys:
*
*
* -
*
* Symmetric encryption key (default)
*
*
* -
*
* SYMMETRIC_DEFAULT
*
*
*
*
* -
*
* HMAC keys (symmetric)
*
*
* -
*
* HMAC_224
*
*
* -
*
* HMAC_256
*
*
* -
*
* HMAC_384
*
*
* -
*
* HMAC_512
*
*
*
*
* -
*
* Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
*
*
* -
*
* RSA_2048
*
*
* -
*
* RSA_3072
*
*
* -
*
* RSA_4096
*
*
*
*
* -
*
* Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared
* secrets)
*
*
* -
*
* ECC_NIST_P256 (secp256r1)
*
*
* -
*
* ECC_NIST_P384 (secp384r1)
*
*
* -
*
* ECC_NIST_P521 (secp521r1)
*
*
*
*
* -
*
* Other asymmetric elliptic curve key pairs (signing and verification)
*
*
* -
*
* ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
*
*
*
*
* -
*
* SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
*
*
* -
*
* SM2 (China Regions only)
*
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see KeySpec
*/
public CreateKeyRequest withKeySpec(KeySpec keySpec) {
this.keySpec = keySpec.toString();
return this;
}
/**
*
* The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The
* default is AWS_KMS, which means that KMS creates the key material.
*
*
* To create a KMS
* key with no key material (for imported key material), set this value to EXTERNAL. For more
* information about importing key material into KMS, see Importing Key Material in
* the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for
* symmetric KMS keys.
*
*
* To create a KMS key in
* an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to
* AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM
* key store. The KeySpec value must be SYMMETRIC_DEFAULT.
*
*
* To create a KMS key in an
* external key store, set this value to EXTERNAL_KEY_STORE. You must also use the
* CustomKeyStoreId parameter to identify the external key store and the XksKeyId
* parameter to identify the associated external key. The KeySpec value must be
* SYMMETRIC_DEFAULT.
*
*
* @param origin
* The source of the key material for the KMS key. You cannot change the origin after you create the KMS key.
* The default is AWS_KMS, which means that KMS creates the key material.
*
* To create a
* KMS key with no key material (for imported key material), set this value to EXTERNAL. For
* more information about importing key material into KMS, see Importing Key
* Material in the Key Management Service Developer Guide. The EXTERNAL origin value
* is valid only for symmetric KMS keys.
*
*
* To create a KMS
* key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this
* value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to
* identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.
*
*
* To create a KMS key
* in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the
* CustomKeyStoreId parameter to identify the external key store and the XksKeyId
* parameter to identify the associated external key. The KeySpec value must be
* SYMMETRIC_DEFAULT.
* @see OriginType
*/
public void setOrigin(String origin) {
this.origin = origin;
}
/**
*
* The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The
* default is AWS_KMS, which means that KMS creates the key material.
*
*
* To create a KMS
* key with no key material (for imported key material), set this value to EXTERNAL. For more
* information about importing key material into KMS, see Importing Key Material in
* the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for
* symmetric KMS keys.
*
*
* To create a KMS key in
* an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to
* AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM
* key store. The KeySpec value must be SYMMETRIC_DEFAULT.
*
*
* To create a KMS key in an
* external key store, set this value to EXTERNAL_KEY_STORE. You must also use the
* CustomKeyStoreId parameter to identify the external key store and the XksKeyId
* parameter to identify the associated external key. The KeySpec value must be
* SYMMETRIC_DEFAULT.
*
*
* @return The source of the key material for the KMS key. You cannot change the origin after you create the KMS
* key. The default is AWS_KMS, which means that KMS creates the key material.
*
* To create
* a KMS key with no key material (for imported key material), set this value to EXTERNAL.
* For more information about importing key material into KMS, see Importing Key
* Material in the Key Management Service Developer Guide. The EXTERNAL origin value
* is valid only for symmetric KMS keys.
*
*
* To create a KMS
* key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this
* value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to
* identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.
*
*
* To create a KMS key
* in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the
* CustomKeyStoreId parameter to identify the external key store and the XksKeyId
* parameter to identify the associated external key. The KeySpec value must be
* SYMMETRIC_DEFAULT.
* @see OriginType
*/
public String getOrigin() {
return this.origin;
}
/**
*
* The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The
* default is AWS_KMS, which means that KMS creates the key material.
*
*
* To create a KMS
* key with no key material (for imported key material), set this value to EXTERNAL. For more
* information about importing key material into KMS, see Importing Key Material in
* the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for
* symmetric KMS keys.
*
*
* To create a KMS key in
* an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to
* AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM
* key store. The KeySpec value must be SYMMETRIC_DEFAULT.
*
*
* To create a KMS key in an
* external key store, set this value to EXTERNAL_KEY_STORE. You must also use the
* CustomKeyStoreId parameter to identify the external key store and the XksKeyId
* parameter to identify the associated external key. The KeySpec value must be
* SYMMETRIC_DEFAULT.
*
*
* @param origin
* The source of the key material for the KMS key. You cannot change the origin after you create the KMS key.
* The default is AWS_KMS, which means that KMS creates the key material.
*
* To create a
* KMS key with no key material (for imported key material), set this value to EXTERNAL. For
* more information about importing key material into KMS, see Importing Key
* Material in the Key Management Service Developer Guide. The EXTERNAL origin value
* is valid only for symmetric KMS keys.
*
*
* To create a KMS
* key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this
* value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to
* identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.
*
*
* To create a KMS key
* in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the
* CustomKeyStoreId parameter to identify the external key store and the XksKeyId
* parameter to identify the associated external key. The KeySpec value must be
* SYMMETRIC_DEFAULT.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OriginType
*/
public CreateKeyRequest withOrigin(String origin) {
setOrigin(origin);
return this;
}
/**
*
* The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The
* default is AWS_KMS, which means that KMS creates the key material.
*
*
* To create a KMS
* key with no key material (for imported key material), set this value to EXTERNAL. For more
* information about importing key material into KMS, see Importing Key Material in
* the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for
* symmetric KMS keys.
*
*
* To create a KMS key in
* an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to
* AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM
* key store. The KeySpec value must be SYMMETRIC_DEFAULT.
*
*
* To create a KMS key in an
* external key store, set this value to EXTERNAL_KEY_STORE. You must also use the
* CustomKeyStoreId parameter to identify the external key store and the XksKeyId
* parameter to identify the associated external key. The KeySpec value must be
* SYMMETRIC_DEFAULT.
*
*
* @param origin
* The source of the key material for the KMS key. You cannot change the origin after you create the KMS key.
* The default is AWS_KMS, which means that KMS creates the key material.
*
* To create a
* KMS key with no key material (for imported key material), set this value to EXTERNAL. For
* more information about importing key material into KMS, see Importing Key
* Material in the Key Management Service Developer Guide. The EXTERNAL origin value
* is valid only for symmetric KMS keys.
*
*
* To create a KMS
* key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this
* value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to
* identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.
*
*
* To create a KMS key
* in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the
* CustomKeyStoreId parameter to identify the external key store and the XksKeyId
* parameter to identify the associated external key. The KeySpec value must be
* SYMMETRIC_DEFAULT.
* @see OriginType
*/
public void setOrigin(OriginType origin) {
withOrigin(origin);
}
/**
*
* The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The
* default is AWS_KMS, which means that KMS creates the key material.
*
*
* To create a KMS
* key with no key material (for imported key material), set this value to EXTERNAL. For more
* information about importing key material into KMS, see Importing Key Material in
* the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for
* symmetric KMS keys.
*
*
* To create a KMS key in
* an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to
* AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM
* key store. The KeySpec value must be SYMMETRIC_DEFAULT.
*
*
* To create a KMS key in an
* external key store, set this value to EXTERNAL_KEY_STORE. You must also use the
* CustomKeyStoreId parameter to identify the external key store and the XksKeyId
* parameter to identify the associated external key. The KeySpec value must be
* SYMMETRIC_DEFAULT.
*
*
* @param origin
* The source of the key material for the KMS key. You cannot change the origin after you create the KMS key.
* The default is AWS_KMS, which means that KMS creates the key material.
*
* To create a
* KMS key with no key material (for imported key material), set this value to EXTERNAL. For
* more information about importing key material into KMS, see Importing Key
* Material in the Key Management Service Developer Guide. The EXTERNAL origin value
* is valid only for symmetric KMS keys.
*
*
* To create a KMS
* key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this
* value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to
* identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.
*
*
* To create a KMS key
* in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the
* CustomKeyStoreId parameter to identify the external key store and the XksKeyId
* parameter to identify the associated external key. The KeySpec value must be
* SYMMETRIC_DEFAULT.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OriginType
*/
public CreateKeyRequest withOrigin(OriginType origin) {
this.origin = origin.toString();
return this;
}
/**
*
* Creates the KMS key in the specified custom key store.
* The ConnectionState of the custom key store must be CONNECTED. To find the
* CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.
*
*
* This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other
* type of KMS key in a custom key store.
*
*
* When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key in its
* associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key
* store, you must use the XksKeyId parameter to specify an external key that serves as key material
* for the KMS key.
*
*
* @param customKeyStoreId
* Creates the KMS key in the specified custom key
* store. The ConnectionState of the custom key store must be CONNECTED. To
* find the CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.
*
* This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any
* other type of KMS key in a custom key store.
*
*
* When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key
* in its associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an
* external key store, you must use the XksKeyId parameter to specify an external key that
* serves as key material for the KMS key.
*/
public void setCustomKeyStoreId(String customKeyStoreId) {
this.customKeyStoreId = customKeyStoreId;
}
/**
*
* Creates the KMS key in the specified custom key store.
* The ConnectionState of the custom key store must be CONNECTED. To find the
* CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.
*
*
* This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other
* type of KMS key in a custom key store.
*
*
* When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key in its
* associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key
* store, you must use the XksKeyId parameter to specify an external key that serves as key material
* for the KMS key.
*
*
* @return Creates the KMS key in the specified custom key
* store. The ConnectionState of the custom key store must be CONNECTED. To
* find the CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.
*
* This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any
* other type of KMS key in a custom key store.
*
*
* When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key
* in its associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an
* external key store, you must use the XksKeyId parameter to specify an external key that
* serves as key material for the KMS key.
*/
public String getCustomKeyStoreId() {
return this.customKeyStoreId;
}
/**
*
* Creates the KMS key in the specified custom key store.
* The ConnectionState of the custom key store must be CONNECTED. To find the
* CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.
*
*
* This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other
* type of KMS key in a custom key store.
*
*
* When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key in its
* associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key
* store, you must use the XksKeyId parameter to specify an external key that serves as key material
* for the KMS key.
*
*
* @param customKeyStoreId
* Creates the KMS key in the specified custom key
* store. The ConnectionState of the custom key store must be CONNECTED. To
* find the CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.
*
* This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any
* other type of KMS key in a custom key store.
*
*
* When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key
* in its associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an
* external key store, you must use the XksKeyId parameter to specify an external key that
* serves as key material for the KMS key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateKeyRequest withCustomKeyStoreId(String customKeyStoreId) {
setCustomKeyStoreId(customKeyStoreId);
return this;
}
/**
*
* Skips ("bypasses") the key policy lockout safety check. The default value is false.
*
*
*
* Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to
* true indiscriminately.
*
*
* For more information, see Default key policy in the Key Management Service Developer Guide.
*
*
*
* Use this parameter only when you intend to prevent the principal that is making the request from making a
* subsequent PutKeyPolicy
* request on the KMS key.
*
*
* @param bypassPolicyLockoutSafetyCheck
* Skips ("bypasses") the key policy lockout safety check. The default value is false.
*
* Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value
* to true indiscriminately.
*
*
* For more information, see Default key policy in the Key Management Service Developer Guide.
*
*
*
* Use this parameter only when you intend to prevent the principal that is making the request from making a
* subsequent PutKeyPolicy request
* on the KMS key.
*/
public void setBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck) {
this.bypassPolicyLockoutSafetyCheck = bypassPolicyLockoutSafetyCheck;
}
/**
*
* Skips ("bypasses") the key policy lockout safety check. The default value is false.
*
*
*
* Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to
* true indiscriminately.
*
*
* For more information, see Default key policy in the Key Management Service Developer Guide.
*
*
*
* Use this parameter only when you intend to prevent the principal that is making the request from making a
* subsequent PutKeyPolicy
* request on the KMS key.
*
*
* @return Skips ("bypasses") the key policy lockout safety check. The default value is false.
*
* Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this
* value to true indiscriminately.
*
*
* For more information, see Default key policy in the Key Management Service Developer Guide.
*
*
*
* Use this parameter only when you intend to prevent the principal that is making the request from making a
* subsequent PutKeyPolicy request
* on the KMS key.
*/
public Boolean getBypassPolicyLockoutSafetyCheck() {
return this.bypassPolicyLockoutSafetyCheck;
}
/**
*
* Skips ("bypasses") the key policy lockout safety check. The default value is false.
*
*
*
* Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to
* true indiscriminately.
*
*
* For more information, see Default key policy in the Key Management Service Developer Guide.
*
*
*
* Use this parameter only when you intend to prevent the principal that is making the request from making a
* subsequent PutKeyPolicy
* request on the KMS key.
*
*
* @param bypassPolicyLockoutSafetyCheck
* Skips ("bypasses") the key policy lockout safety check. The default value is false.
*
* Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value
* to true indiscriminately.
*
*
* For more information, see Default key policy in the Key Management Service Developer Guide.
*
*
*
* Use this parameter only when you intend to prevent the principal that is making the request from making a
* subsequent PutKeyPolicy request
* on the KMS key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateKeyRequest withBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck) {
setBypassPolicyLockoutSafetyCheck(bypassPolicyLockoutSafetyCheck);
return this;
}
/**
*
* Skips ("bypasses") the key policy lockout safety check. The default value is false.
*
*
*
* Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to
* true indiscriminately.
*
*
* For more information, see Default key policy in the Key Management Service Developer Guide.
*
*
*
* Use this parameter only when you intend to prevent the principal that is making the request from making a
* subsequent PutKeyPolicy
* request on the KMS key.
*
*
* @return Skips ("bypasses") the key policy lockout safety check. The default value is false.
*
* Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this
* value to true indiscriminately.
*
*
* For more information, see Default key policy in the Key Management Service Developer Guide.
*
*
*
* Use this parameter only when you intend to prevent the principal that is making the request from making a
* subsequent PutKeyPolicy request
* on the KMS key.
*/
public Boolean isBypassPolicyLockoutSafetyCheck() {
return this.bypassPolicyLockoutSafetyCheck;
}
/**
*
* Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created. To tag an
* existing KMS key, use the TagResource operation.
*
*
*
* Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in
* CloudTrail logs and other output.
*
*
*
* Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management
* Service Developer Guide.
*
*
*
* To use this parameter, you must have kms:TagResource permission in an IAM policy.
*
*
* Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag
* value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you
* specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified
* one.
*
*
* When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with
* usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
*
*
* @return Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created. To tag
* an existing KMS key, use the TagResource operation.
*
* Do not include confidential or sensitive information in this field. This field may be displayed in
* plaintext in CloudTrail logs and other output.
*
*
*
* Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key
* Management Service Developer Guide.
*
*
*
* To use this parameter, you must have kms:TagResource permission in an IAM policy.
*
*
* Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the
* tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag
* key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value
* with the specified one.
*
*
* When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation
* report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For
* details, see Tagging
* Keys.
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return tags;
}
/**
*
* Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created. To tag an
* existing KMS key, use the TagResource operation.
*
*
*
* Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in
* CloudTrail logs and other output.
*
*
*
* Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management
* Service Developer Guide.
*
*
*
* To use this parameter, you must have kms:TagResource permission in an IAM policy.
*
*
* Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag
* value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you
* specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified
* one.
*
*
* When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with
* usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
*
*
* @param tags
* Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created. To tag
* an existing KMS key, use the TagResource operation.
*
* Do not include confidential or sensitive information in this field. This field may be displayed in
* plaintext in CloudTrail logs and other output.
*
*
*
* Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key
* Management Service Developer Guide.
*
*
*
* To use this parameter, you must have kms:TagResource permission in an IAM policy.
*
*
* Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the
* tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag
* key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value
* with the specified one.
*
*
* When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation
* report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For
* details, see Tagging
* Keys.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(tags);
}
/**
*
* Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created. To tag an
* existing KMS key, use the TagResource operation.
*
*
*
* Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in
* CloudTrail logs and other output.
*
*
*
* Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management
* Service Developer Guide.
*
*
*
* To use this parameter, you must have kms:TagResource permission in an IAM policy.
*
*
* Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag
* value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you
* specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified
* one.
*
*
* When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with
* usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created. To tag
* an existing KMS key, use the TagResource operation.
*
* Do not include confidential or sensitive information in this field. This field may be displayed in
* plaintext in CloudTrail logs and other output.
*
*
*
* Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key
* Management Service Developer Guide.
*
*
*
* To use this parameter, you must have kms:TagResource permission in an IAM policy.
*
*
* Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the
* tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag
* key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value
* with the specified one.
*
*
* When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation
* report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For
* details, see Tagging
* Keys.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateKeyRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created. To tag an
* existing KMS key, use the TagResource operation.
*
*
*
* Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in
* CloudTrail logs and other output.
*
*
*
* Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management
* Service Developer Guide.
*
*
*
* To use this parameter, you must have kms:TagResource permission in an IAM policy.
*
*
* Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag
* value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you
* specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified
* one.
*
*
* When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with
* usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
*
*
* @param tags
* Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created. To tag
* an existing KMS key, use the TagResource operation.
*
* Do not include confidential or sensitive information in this field. This field may be displayed in
* plaintext in CloudTrail logs and other output.
*
*
*
* Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key
* Management Service Developer Guide.
*
*
*
* To use this parameter, you must have kms:TagResource permission in an IAM policy.
*
*
* Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the
* tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag
* key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value
* with the specified one.
*
*
* When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation
* report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For
* details, see Tagging
* Keys.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateKeyRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You cannot
* change this value after you create the KMS key.
*
*
* For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this parameter
* or set it to False. The default value is False.
*
*
* This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS
* keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and
* other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it
* in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more
* information about multi-Region keys, see Multi-Region keys in
* KMS in the Key Management Service Developer Guide.
*
*
* This value creates a primary key, not a replica. To create a replica key, use the
* ReplicateKey operation.
*
*
* You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported
* key material. However, you cannot create a multi-Region key in a custom key store.
*
*
* @param multiRegion
* Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You
* cannot change this value after you create the KMS key.
*
* For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this
* parameter or set it to False. The default value is False.
*
*
* This operation supports multi-Region keys, an KMS feature that lets you create multiple
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key
* ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web
* Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or
* making a cross-Region call. For more information about multi-Region keys, see Multi-Region
* keys in KMS in the Key Management Service Developer Guide.
*
*
* This value creates a primary key, not a replica. To create a replica key, use the
* ReplicateKey operation.
*
*
* You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with
* imported key material. However, you cannot create a multi-Region key in a custom key store.
*/
public void setMultiRegion(Boolean multiRegion) {
this.multiRegion = multiRegion;
}
/**
*
* Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You cannot
* change this value after you create the KMS key.
*
*
* For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this parameter
* or set it to False. The default value is False.
*
*
* This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS
* keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and
* other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it
* in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more
* information about multi-Region keys, see Multi-Region keys in
* KMS in the Key Management Service Developer Guide.
*
*
* This value creates a primary key, not a replica. To create a replica key, use the
* ReplicateKey operation.
*
*
* You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported
* key material. However, you cannot create a multi-Region key in a custom key store.
*
*
* @return Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You
* cannot change this value after you create the KMS key.
*
* For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this
* parameter or set it to False. The default value is False.
*
*
* This operation supports multi-Region keys, an KMS feature that lets you create multiple
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key
* ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web
* Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data
* or making a cross-Region call. For more information about multi-Region keys, see Multi-Region
* keys in KMS in the Key Management Service Developer Guide.
*
*
* This value creates a primary key, not a replica. To create a replica key, use the
* ReplicateKey operation.
*
*
* You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with
* imported key material. However, you cannot create a multi-Region key in a custom key store.
*/
public Boolean getMultiRegion() {
return this.multiRegion;
}
/**
*
* Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You cannot
* change this value after you create the KMS key.
*
*
* For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this parameter
* or set it to False. The default value is False.
*
*
* This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS
* keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and
* other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it
* in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more
* information about multi-Region keys, see Multi-Region keys in
* KMS in the Key Management Service Developer Guide.
*
*
* This value creates a primary key, not a replica. To create a replica key, use the
* ReplicateKey operation.
*
*
* You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported
* key material. However, you cannot create a multi-Region key in a custom key store.
*
*
* @param multiRegion
* Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You
* cannot change this value after you create the KMS key.
*
* For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this
* parameter or set it to False. The default value is False.
*
*
* This operation supports multi-Region keys, an KMS feature that lets you create multiple
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key
* ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web
* Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or
* making a cross-Region call. For more information about multi-Region keys, see Multi-Region
* keys in KMS in the Key Management Service Developer Guide.
*
*
* This value creates a primary key, not a replica. To create a replica key, use the
* ReplicateKey operation.
*
*
* You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with
* imported key material. However, you cannot create a multi-Region key in a custom key store.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateKeyRequest withMultiRegion(Boolean multiRegion) {
setMultiRegion(multiRegion);
return this;
}
/**
*
* Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You cannot
* change this value after you create the KMS key.
*
*
* For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this parameter
* or set it to False. The default value is False.
*
*
* This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS
* keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and
* other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it
* in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more
* information about multi-Region keys, see Multi-Region keys in
* KMS in the Key Management Service Developer Guide.
*
*
* This value creates a primary key, not a replica. To create a replica key, use the
* ReplicateKey operation.
*
*
* You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported
* key material. However, you cannot create a multi-Region key in a custom key store.
*
*
* @return Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You
* cannot change this value after you create the KMS key.
*
* For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this
* parameter or set it to False. The default value is False.
*
*
* This operation supports multi-Region keys, an KMS feature that lets you create multiple
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key
* ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web
* Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data
* or making a cross-Region call. For more information about multi-Region keys, see Multi-Region
* keys in KMS in the Key Management Service Developer Guide.
*
*
* This value creates a primary key, not a replica. To create a replica key, use the
* ReplicateKey operation.
*
*
* You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with
* imported key material. However, you cannot create a multi-Region key in a custom key store.
*/
public Boolean isMultiRegion() {
return this.multiRegion;
}
/**
*
* Identifies the external
* key that serves as key material for the KMS key in an external key store.
* Specify the ID that the external
* key store proxy uses to refer to the external key. For help, see the documentation for your external key
* store proxy.
*
*
* This parameter is required for a KMS key with an Origin value of EXTERNAL_KEY_STORE. It
* is not valid for KMS keys with any other Origin value.
*
*
* The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web Services
* in an external key manager associated with the external key store specified by the CustomKeyStoreId
* parameter. This key must be enabled and configured to perform encryption and decryption. Each KMS key in an
* external key store must use a different external key. For details, see Requirements for a KMS key in an
* external key store in the Key Management Service Developer Guide.
*
*
* Each KMS key in an external key store is associated two backing keys. One is key material that KMS generates. The
* other is the external key specified by this parameter. When you use the KMS key in an external key store to
* encrypt data, the encryption operation is performed first by KMS using the KMS key material, and then by the
* external key manager using the specified external key, a process known as double encryption. For details,
* see Double encryption in the Key Management Service Developer Guide.
*
*
* @param xksKeyId
* Identifies the external key that serves as key material for the KMS key in an external key
* store. Specify the ID that the external key store proxy uses to refer to the external key. For help, see the documentation for your
* external key store proxy.
*
* This parameter is required for a KMS key with an Origin value of
* EXTERNAL_KEY_STORE. It is not valid for KMS keys with any other Origin value.
*
*
* The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web
* Services in an external key manager associated with the external key store specified by the
* CustomKeyStoreId parameter. This key must be enabled and configured to perform encryption and
* decryption. Each KMS key in an external key store must use a different external key. For details, see Requirements for a KMS key in
* an external key store in the Key Management Service Developer Guide.
*
*
* Each KMS key in an external key store is associated two backing keys. One is key material that KMS
* generates. The other is the external key specified by this parameter. When you use the KMS key in an
* external key store to encrypt data, the encryption operation is performed first by KMS using the KMS key
* material, and then by the external key manager using the specified external key, a process known as
* double encryption. For details, see Double encryption in the Key Management Service Developer Guide.
*/
public void setXksKeyId(String xksKeyId) {
this.xksKeyId = xksKeyId;
}
/**
*
* Identifies the external
* key that serves as key material for the KMS key in an external key store.
* Specify the ID that the external
* key store proxy uses to refer to the external key. For help, see the documentation for your external key
* store proxy.
*
*
* This parameter is required for a KMS key with an Origin value of EXTERNAL_KEY_STORE. It
* is not valid for KMS keys with any other Origin value.
*
*
* The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web Services
* in an external key manager associated with the external key store specified by the CustomKeyStoreId
* parameter. This key must be enabled and configured to perform encryption and decryption. Each KMS key in an
* external key store must use a different external key. For details, see Requirements for a KMS key in an
* external key store in the Key Management Service Developer Guide.
*
*
* Each KMS key in an external key store is associated two backing keys. One is key material that KMS generates. The
* other is the external key specified by this parameter. When you use the KMS key in an external key store to
* encrypt data, the encryption operation is performed first by KMS using the KMS key material, and then by the
* external key manager using the specified external key, a process known as double encryption. For details,
* see Double encryption in the Key Management Service Developer Guide.
*
*
* @return Identifies the external key that serves as key material for the KMS key in an external key
* store. Specify the ID that the external key store proxy uses to refer to the external key. For help, see the documentation for your
* external key store proxy.
*
* This parameter is required for a KMS key with an Origin value of
* EXTERNAL_KEY_STORE. It is not valid for KMS keys with any other Origin value.
*
*
* The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web
* Services in an external key manager associated with the external key store specified by the
* CustomKeyStoreId parameter. This key must be enabled and configured to perform encryption
* and decryption. Each KMS key in an external key store must use a different external key. For details, see
* Requirements for a KMS
* key in an external key store in the Key Management Service Developer Guide.
*
*
* Each KMS key in an external key store is associated two backing keys. One is key material that KMS
* generates. The other is the external key specified by this parameter. When you use the KMS key in an
* external key store to encrypt data, the encryption operation is performed first by KMS using the KMS key
* material, and then by the external key manager using the specified external key, a process known as
* double encryption. For details, see Double encryption in the Key Management Service Developer Guide.
*/
public String getXksKeyId() {
return this.xksKeyId;
}
/**
*
* Identifies the external
* key that serves as key material for the KMS key in an external key store.
* Specify the ID that the external
* key store proxy uses to refer to the external key. For help, see the documentation for your external key
* store proxy.
*
*
* This parameter is required for a KMS key with an Origin value of EXTERNAL_KEY_STORE. It
* is not valid for KMS keys with any other Origin value.
*
*
* The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web Services
* in an external key manager associated with the external key store specified by the CustomKeyStoreId
* parameter. This key must be enabled and configured to perform encryption and decryption. Each KMS key in an
* external key store must use a different external key. For details, see Requirements for a KMS key in an
* external key store in the Key Management Service Developer Guide.
*
*
* Each KMS key in an external key store is associated two backing keys. One is key material that KMS generates. The
* other is the external key specified by this parameter. When you use the KMS key in an external key store to
* encrypt data, the encryption operation is performed first by KMS using the KMS key material, and then by the
* external key manager using the specified external key, a process known as double encryption. For details,
* see Double encryption in the Key Management Service Developer Guide.
*
*
* @param xksKeyId
* Identifies the external key that serves as key material for the KMS key in an external key
* store. Specify the ID that the external key store proxy uses to refer to the external key. For help, see the documentation for your
* external key store proxy.
*
* This parameter is required for a KMS key with an Origin value of
* EXTERNAL_KEY_STORE. It is not valid for KMS keys with any other Origin value.
*
*
* The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web
* Services in an external key manager associated with the external key store specified by the
* CustomKeyStoreId parameter. This key must be enabled and configured to perform encryption and
* decryption. Each KMS key in an external key store must use a different external key. For details, see Requirements for a KMS key in
* an external key store in the Key Management Service Developer Guide.
*
*
* Each KMS key in an external key store is associated two backing keys. One is key material that KMS
* generates. The other is the external key specified by this parameter. When you use the KMS key in an
* external key store to encrypt data, the encryption operation is performed first by KMS using the KMS key
* material, and then by the external key manager using the specified external key, a process known as
* double encryption. For details, see Double encryption in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateKeyRequest withXksKeyId(String xksKeyId) {
setXksKeyId(xksKeyId);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getPolicy() != null)
sb.append("Policy: ").append(getPolicy()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getKeyUsage() != null)
sb.append("KeyUsage: ").append(getKeyUsage()).append(",");
if (getCustomerMasterKeySpec() != null)
sb.append("CustomerMasterKeySpec: ").append(getCustomerMasterKeySpec()).append(",");
if (getKeySpec() != null)
sb.append("KeySpec: ").append(getKeySpec()).append(",");
if (getOrigin() != null)
sb.append("Origin: ").append(getOrigin()).append(",");
if (getCustomKeyStoreId() != null)
sb.append("CustomKeyStoreId: ").append(getCustomKeyStoreId()).append(",");
if (getBypassPolicyLockoutSafetyCheck() != null)
sb.append("BypassPolicyLockoutSafetyCheck: ").append(getBypassPolicyLockoutSafetyCheck()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getMultiRegion() != null)
sb.append("MultiRegion: ").append(getMultiRegion()).append(",");
if (getXksKeyId() != null)
sb.append("XksKeyId: ").append(getXksKeyId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateKeyRequest == false)
return false;
CreateKeyRequest other = (CreateKeyRequest) obj;
if (other.getPolicy() == null ^ this.getPolicy() == null)
return false;
if (other.getPolicy() != null && other.getPolicy().equals(this.getPolicy()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getKeyUsage() == null ^ this.getKeyUsage() == null)
return false;
if (other.getKeyUsage() != null && other.getKeyUsage().equals(this.getKeyUsage()) == false)
return false;
if (other.getCustomerMasterKeySpec() == null ^ this.getCustomerMasterKeySpec() == null)
return false;
if (other.getCustomerMasterKeySpec() != null && other.getCustomerMasterKeySpec().equals(this.getCustomerMasterKeySpec()) == false)
return false;
if (other.getKeySpec() == null ^ this.getKeySpec() == null)
return false;
if (other.getKeySpec() != null && other.getKeySpec().equals(this.getKeySpec()) == false)
return false;
if (other.getOrigin() == null ^ this.getOrigin() == null)
return false;
if (other.getOrigin() != null && other.getOrigin().equals(this.getOrigin()) == false)
return false;
if (other.getCustomKeyStoreId() == null ^ this.getCustomKeyStoreId() == null)
return false;
if (other.getCustomKeyStoreId() != null && other.getCustomKeyStoreId().equals(this.getCustomKeyStoreId()) == false)
return false;
if (other.getBypassPolicyLockoutSafetyCheck() == null ^ this.getBypassPolicyLockoutSafetyCheck() == null)
return false;
if (other.getBypassPolicyLockoutSafetyCheck() != null
&& other.getBypassPolicyLockoutSafetyCheck().equals(this.getBypassPolicyLockoutSafetyCheck()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getMultiRegion() == null ^ this.getMultiRegion() == null)
return false;
if (other.getMultiRegion() != null && other.getMultiRegion().equals(this.getMultiRegion()) == false)
return false;
if (other.getXksKeyId() == null ^ this.getXksKeyId() == null)
return false;
if (other.getXksKeyId() != null && other.getXksKeyId().equals(this.getXksKeyId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPolicy() == null) ? 0 : getPolicy().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getKeyUsage() == null) ? 0 : getKeyUsage().hashCode());
hashCode = prime * hashCode + ((getCustomerMasterKeySpec() == null) ? 0 : getCustomerMasterKeySpec().hashCode());
hashCode = prime * hashCode + ((getKeySpec() == null) ? 0 : getKeySpec().hashCode());
hashCode = prime * hashCode + ((getOrigin() == null) ? 0 : getOrigin().hashCode());
hashCode = prime * hashCode + ((getCustomKeyStoreId() == null) ? 0 : getCustomKeyStoreId().hashCode());
hashCode = prime * hashCode + ((getBypassPolicyLockoutSafetyCheck() == null) ? 0 : getBypassPolicyLockoutSafetyCheck().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getMultiRegion() == null) ? 0 : getMultiRegion().hashCode());
hashCode = prime * hashCode + ((getXksKeyId() == null) ? 0 : getXksKeyId().hashCode());
return hashCode;
}
@Override
public CreateKeyRequest clone() {
return (CreateKeyRequest) super.clone();
}
}