CreateKeyRequest (AWS Java SDK for AWS KMS 1.12.48 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kms.model.CreateKeyRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateKeyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateKeyRequest()

Constructors
Constructor and Description
`CreateKeyRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateKeyRequest`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getBypassPolicyLockoutSafetyCheck()` A flag to indicate whether to bypass the key policy lockout safety check.
`String`	`getCustomerMasterKeySpec()` Specifies the type of CMK to create.
`String`	`getCustomKeyStoreId()` Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster.
`String`	`getDescription()` A description of the CMK.
`String`	`getKeyUsage()` Determines the cryptographic operations for which you can use the CMK.
`Boolean`	`getMultiRegion()` Creates a multi-Region primary key that you can replicate into other AWS Regions.
`String`	`getOrigin()` The source of the key material for the CMK.
`String`	`getPolicy()` The key policy to attach to the CMK.
`List<Tag>`	`getTags()` Assigns one or more tags to the CMK.
`int`	`hashCode()`
`Boolean`	`isBypassPolicyLockoutSafetyCheck()` A flag to indicate whether to bypass the key policy lockout safety check.
`Boolean`	`isMultiRegion()` Creates a multi-Region primary key that you can replicate into other AWS Regions.
`void`	`setBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)` A flag to indicate whether to bypass the key policy lockout safety check.
`void`	`setCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)` Specifies the type of CMK to create.
`void`	`setCustomerMasterKeySpec(String customerMasterKeySpec)` Specifies the type of CMK to create.
`void`	`setCustomKeyStoreId(String customKeyStoreId)` Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster.
`void`	`setDescription(String description)` A description of the CMK.
`void`	`setKeyUsage(KeyUsageType keyUsage)` Determines the cryptographic operations for which you can use the CMK.
`void`	`setKeyUsage(String keyUsage)` Determines the cryptographic operations for which you can use the CMK.
`void`	`setMultiRegion(Boolean multiRegion)` Creates a multi-Region primary key that you can replicate into other AWS Regions.
`void`	`setOrigin(OriginType origin)` The source of the key material for the CMK.
`void`	`setOrigin(String origin)` The source of the key material for the CMK.
`void`	`setPolicy(String policy)` The key policy to attach to the CMK.
`void`	`setTags(Collection<Tag> tags)` Assigns one or more tags to the CMK.
`String`	`toString()` Returns a string representation of this object.
`CreateKeyRequest`	`withBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)` A flag to indicate whether to bypass the key policy lockout safety check.
`CreateKeyRequest`	`withCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)` Specifies the type of CMK to create.
`CreateKeyRequest`	`withCustomerMasterKeySpec(String customerMasterKeySpec)` Specifies the type of CMK to create.
`CreateKeyRequest`	`withCustomKeyStoreId(String customKeyStoreId)` Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster.
`CreateKeyRequest`	`withDescription(String description)` A description of the CMK.
`CreateKeyRequest`	`withKeyUsage(KeyUsageType keyUsage)` Determines the cryptographic operations for which you can use the CMK.
`CreateKeyRequest`	`withKeyUsage(String keyUsage)` Determines the cryptographic operations for which you can use the CMK.
`CreateKeyRequest`	`withMultiRegion(Boolean multiRegion)` Creates a multi-Region primary key that you can replicate into other AWS Regions.
`CreateKeyRequest`	`withOrigin(OriginType origin)` The source of the key material for the CMK.
`CreateKeyRequest`	`withOrigin(String origin)` The source of the key material for the CMK.
`CreateKeyRequest`	`withPolicy(String policy)` The key policy to attach to the CMK.
`CreateKeyRequest`	`withTags(Collection<Tag> tags)` Assigns one or more tags to the CMK.
`CreateKeyRequest`	`withTags(Tag... tags)` Assigns one or more tags to the CMK.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateKeyRequest
```
public CreateKeyRequest()
```
- Method Detail
  - setPolicy
```
public void setPolicy(String policy)
```
    The key policy to attach to the CMK.
    
    If you provide a key policy, it must meet the following criteria:
    - If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
    - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), 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 AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
    If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS 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 IAM User Guide .
    Parameters:
    policy - The key policy to attach to the CMK.
    
    If you provide a key policy, it must meet the following criteria:
    
    If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
    
    Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), 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 AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
    
    If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS 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 IAM User Guide .
  - getPolicy
```
public String getPolicy()
```
    The key policy to attach to the CMK.
    
    If you provide a key policy, it must meet the following criteria:
    - If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
    - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), 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 AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
    If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS 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 IAM User Guide .
    Returns:
    The key policy to attach to the CMK.
    
    If you provide a key policy, it must meet the following criteria:
    
    If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
    
    Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), 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 AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
    
    If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS 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 IAM User Guide .
  - withPolicy
```
public CreateKeyRequest withPolicy(String policy)
```
    The key policy to attach to the CMK.
    
    If you provide a key policy, it must meet the following criteria:
    - If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
    - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), 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 AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
    If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS 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 IAM User Guide .
    Parameters:
    policy - The key policy to attach to the CMK.
    
    If you provide a key policy, it must meet the following criteria:
    
    If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
    
    Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), 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 AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
    
    If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS 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 IAM User Guide .
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the CMK.
    
    Use a description that helps you decide whether the CMK is appropriate for a task. The default value is an empty string (no description).
    
    Parameters:
    
    description - A description of the CMK.
    
    Use a description that helps you decide whether the CMK is appropriate for a task. The default value is an empty string (no description).
  - getDescription
```
public String getDescription()
```
    A description of the CMK.
    
    Use a description that helps you decide whether the CMK is appropriate for a task. The default value is an empty string (no description).
    
    Returns:
    
    A description of the CMK.
    
    Use a description that helps you decide whether the CMK is appropriate for a task. The default value is an empty string (no description).
  - withDescription
```
public CreateKeyRequest withDescription(String description)
```
    A description of the CMK.
    
    Use a description that helps you decide whether the CMK is appropriate for a task. The default value is an empty string (no description).
    
    Parameters:
    
    description - A description of the CMK.
    
    Use a description that helps you decide whether the CMK is appropriate for a task. The default value is an empty string (no description).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyUsage
```
public void setKeyUsage(String keyUsage)
```
    Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
    
    Select only one valid value.
    - For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
    - For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    - For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
    Parameters:
    keyUsage - Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
    
    Select only one valid value.
    
    For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
    
    For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    
    For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
    See Also:
    
    KeyUsageType
  - getKeyUsage
```
public String getKeyUsage()
```
    Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
    
    Select only one valid value.
    - For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
    - For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    - For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
    Returns:
    Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
    
    Select only one valid value.
    
    For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
    
    For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    
    For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
    See Also:
    
    KeyUsageType
  - withKeyUsage
```
public CreateKeyRequest withKeyUsage(String keyUsage)
```
    Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
    
    Select only one valid value.
    - For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
    - For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    - For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
    Parameters:
    keyUsage - Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
    
    Select only one valid value.
    
    For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
    
    For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    
    For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyUsageType
  - setKeyUsage
```
public void setKeyUsage(KeyUsageType keyUsage)
```
    Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
    
    Select only one valid value.
    - For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
    - For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    - For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
    Parameters:
    keyUsage - Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
    
    Select only one valid value.
    
    For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
    
    For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    
    For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
    See Also:
    
    KeyUsageType
  - withKeyUsage
```
public CreateKeyRequest withKeyUsage(KeyUsageType keyUsage)
```
    Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
    
    Select only one valid value.
    - For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
    - For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    - For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
    Parameters:
    keyUsage - Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.
    
    Select only one valid value.
    
    For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
    
    For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    
    For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyUsageType
  - setCustomerMasterKeySpec
```
public void setCustomerMasterKeySpec(String customerMasterKeySpec)
```
    Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
    
    The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
    
    AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
    
    AWS KMS supports the following key specs for CMKs:
    - Symmetric key (default)
      
      SYMMETRIC_DEFAULT (AES-256-GCM)
    - Asymmetric RSA key pairs
      
      RSA_2048
      
      RSA_3072
      
      RSA_4096
    - Asymmetric NIST-recommended elliptic curve key pairs
      
      ECC_NIST_P256 (secp256r1)
      
      ECC_NIST_P384 (secp384r1)
      
      ECC_NIST_P521 (secp521r1)
    - Other asymmetric elliptic curve key pairs
      
      ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    Parameters:
    customerMasterKeySpec - Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
    
    The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
    
    AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
    
    AWS KMS supports the following key specs for CMKs:
    
    Symmetric key (default)
    
    SYMMETRIC_DEFAULT (AES-256-GCM)
    
    Asymmetric RSA key pairs
    
    RSA_2048
    
    RSA_3072
    
    RSA_4096
    
    Asymmetric NIST-recommended elliptic curve key pairs
    
    ECC_NIST_P256 (secp256r1)
    
    ECC_NIST_P384 (secp384r1)
    
    ECC_NIST_P521 (secp521r1)
    
    Other asymmetric elliptic curve key pairs
    
    ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    See Also:
    
    CustomerMasterKeySpec
  - getCustomerMasterKeySpec
```
public String getCustomerMasterKeySpec()
```
    Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
    
    The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
    
    AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
    
    AWS KMS supports the following key specs for CMKs:
    - Symmetric key (default)
      
      SYMMETRIC_DEFAULT (AES-256-GCM)
    - Asymmetric RSA key pairs
      
      RSA_2048
      
      RSA_3072
      
      RSA_4096
    - Asymmetric NIST-recommended elliptic curve key pairs
      
      ECC_NIST_P256 (secp256r1)
      
      ECC_NIST_P384 (secp384r1)
      
      ECC_NIST_P521 (secp521r1)
    - Other asymmetric elliptic curve key pairs
      
      ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    Returns:
    Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
    
    The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
    
    AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
    
    AWS KMS supports the following key specs for CMKs:
    
    Symmetric key (default)
    
    SYMMETRIC_DEFAULT (AES-256-GCM)
    
    Asymmetric RSA key pairs
    
    RSA_2048
    
    RSA_3072
    
    RSA_4096
    
    Asymmetric NIST-recommended elliptic curve key pairs
    
    ECC_NIST_P256 (secp256r1)
    
    ECC_NIST_P384 (secp384r1)
    
    ECC_NIST_P521 (secp521r1)
    
    Other asymmetric elliptic curve key pairs
    
    ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    See Also:
    
    CustomerMasterKeySpec
  - withCustomerMasterKeySpec
```
public CreateKeyRequest withCustomerMasterKeySpec(String customerMasterKeySpec)
```
    Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
    
    The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
    
    AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
    
    AWS KMS supports the following key specs for CMKs:
    - Symmetric key (default)
      
      SYMMETRIC_DEFAULT (AES-256-GCM)
    - Asymmetric RSA key pairs
      
      RSA_2048
      
      RSA_3072
      
      RSA_4096
    - Asymmetric NIST-recommended elliptic curve key pairs
      
      ECC_NIST_P256 (secp256r1)
      
      ECC_NIST_P384 (secp384r1)
      
      ECC_NIST_P521 (secp521r1)
    - Other asymmetric elliptic curve key pairs
      
      ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    Parameters:
    customerMasterKeySpec - Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
    
    The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
    
    AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
    
    AWS KMS supports the following key specs for CMKs:
    
    Symmetric key (default)
    
    SYMMETRIC_DEFAULT (AES-256-GCM)
    
    Asymmetric RSA key pairs
    
    RSA_2048
    
    RSA_3072
    
    RSA_4096
    
    Asymmetric NIST-recommended elliptic curve key pairs
    
    ECC_NIST_P256 (secp256r1)
    
    ECC_NIST_P384 (secp384r1)
    
    ECC_NIST_P521 (secp521r1)
    
    Other asymmetric elliptic curve key pairs
    
    ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CustomerMasterKeySpec
  - setCustomerMasterKeySpec
```
public void setCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
```
    Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
    
    The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
    
    AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
    
    AWS KMS supports the following key specs for CMKs:
    - Symmetric key (default)
      
      SYMMETRIC_DEFAULT (AES-256-GCM)
    - Asymmetric RSA key pairs
      
      RSA_2048
      
      RSA_3072
      
      RSA_4096
    - Asymmetric NIST-recommended elliptic curve key pairs
      
      ECC_NIST_P256 (secp256r1)
      
      ECC_NIST_P384 (secp384r1)
      
      ECC_NIST_P521 (secp521r1)
    - Other asymmetric elliptic curve key pairs
      
      ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    Parameters:
    customerMasterKeySpec - Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
    
    The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
    
    AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
    
    AWS KMS supports the following key specs for CMKs:
    
    Symmetric key (default)
    
    SYMMETRIC_DEFAULT (AES-256-GCM)
    
    Asymmetric RSA key pairs
    
    RSA_2048
    
    RSA_3072
    
    RSA_4096
    
    Asymmetric NIST-recommended elliptic curve key pairs
    
    ECC_NIST_P256 (secp256r1)
    
    ECC_NIST_P384 (secp384r1)
    
    ECC_NIST_P521 (secp521r1)
    
    Other asymmetric elliptic curve key pairs
    
    ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    See Also:
    
    CustomerMasterKeySpec
  - withCustomerMasterKeySpec
```
public CreateKeyRequest withCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
```
    Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
    
    The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
    
    AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
    
    AWS KMS supports the following key specs for CMKs:
    - Symmetric key (default)
      
      SYMMETRIC_DEFAULT (AES-256-GCM)
    - Asymmetric RSA key pairs
      
      RSA_2048
      
      RSA_3072
      
      RSA_4096
    - Asymmetric NIST-recommended elliptic curve key pairs
      
      ECC_NIST_P256 (secp256r1)
      
      ECC_NIST_P384 (secp384r1)
      
      ECC_NIST_P521 (secp521r1)
    - Other asymmetric elliptic curve key pairs
      
      ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    Parameters:
    customerMasterKeySpec - Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.
    
    The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
    
    AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
    
    AWS KMS supports the following key specs for CMKs:
    
    Symmetric key (default)
    
    SYMMETRIC_DEFAULT (AES-256-GCM)
    
    Asymmetric RSA key pairs
    
    RSA_2048
    
    RSA_3072
    
    RSA_4096
    
    Asymmetric NIST-recommended elliptic curve key pairs
    
    ECC_NIST_P256 (secp256r1)
    
    ECC_NIST_P384 (secp384r1)
    
    ECC_NIST_P521 (secp521r1)
    
    Other asymmetric elliptic curve key pairs
    
    ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CustomerMasterKeySpec
  - setOrigin
```
public void setOrigin(String origin)
```
    The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means that AWS KMS creates the key material.
    
    To create a CMK with no key material (for imported key material), set the value to EXTERNAL. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
    
    To create a CMK in an AWS KMS custom key store and create its key material in the associated AWS CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
    
    Parameters:
    
    origin - The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means that AWS KMS creates the key material.
    
    To create a CMK with no key material (for imported key material), set the value to EXTERNAL. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
    
    To create a CMK in an AWS KMS custom key store and create its key material in the associated AWS CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
    
    See Also:
    
    OriginType
  - getOrigin
```
public String getOrigin()
```
    The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means that AWS KMS creates the key material.
    
    To create a CMK with no key material (for imported key material), set the value to EXTERNAL. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
    
    To create a CMK in an AWS KMS custom key store and create its key material in the associated AWS CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
    
    Returns:
    
    The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means that AWS KMS creates the key material.
    
    To create a CMK with no key material (for imported key material), set the value to EXTERNAL. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
    
    To create a CMK in an AWS KMS custom key store and create its key material in the associated AWS CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
    
    See Also:
    
    OriginType
  - withOrigin
```
public CreateKeyRequest withOrigin(String origin)
```
    The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means that AWS KMS creates the key material.
    
    To create a CMK with no key material (for imported key material), set the value to EXTERNAL. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
    
    To create a CMK in an AWS KMS custom key store and create its key material in the associated AWS CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
    
    Parameters:
    
    origin - The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means that AWS KMS creates the key material.
    
    To create a CMK with no key material (for imported key material), set the value to EXTERNAL. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
    
    To create a CMK in an AWS KMS custom key store and create its key material in the associated AWS CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OriginType
  - setOrigin
```
public void setOrigin(OriginType origin)
```
    The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means that AWS KMS creates the key material.
    
    To create a CMK with no key material (for imported key material), set the value to EXTERNAL. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
    
    To create a CMK in an AWS KMS custom key store and create its key material in the associated AWS CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
    
    Parameters:
    
    origin - The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means that AWS KMS creates the key material.
    
    To create a CMK with no key material (for imported key material), set the value to EXTERNAL. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
    
    To create a CMK in an AWS KMS custom key store and create its key material in the associated AWS CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
    
    See Also:
    
    OriginType
  - withOrigin
```
public CreateKeyRequest withOrigin(OriginType origin)
```
    The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means that AWS KMS creates the key material.
    
    To create a CMK with no key material (for imported key material), set the value to EXTERNAL. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
    
    To create a CMK in an AWS KMS custom key store and create its key material in the associated AWS CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
    
    Parameters:
    
    origin - The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means that AWS KMS creates the key material.
    
    To create a CMK with no key material (for imported key material), set the value to EXTERNAL. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
    
    To create a CMK in an AWS KMS custom key store and create its key material in the associated AWS CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OriginType
  - setCustomKeyStoreId
```
public void setCustomKeyStoreId(String customKeyStoreId)
```
    Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
    
    This parameter is valid only for symmetric CMKs and regional CMKs. You cannot create an asymmetric CMK or a multi-Region CMK in a custom key store.
    
    To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
    
    The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
    
    Parameters:
    
    customKeyStoreId - Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
    
    This parameter is valid only for symmetric CMKs and regional CMKs. You cannot create an asymmetric CMK or a multi-Region CMK in a custom key store.
    
    To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
    
    The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
  - getCustomKeyStoreId
```
public String getCustomKeyStoreId()
```
    Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
    
    This parameter is valid only for symmetric CMKs and regional CMKs. You cannot create an asymmetric CMK or a multi-Region CMK in a custom key store.
    
    To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
    
    The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
    
    Returns:
    
    Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
    
    This parameter is valid only for symmetric CMKs and regional CMKs. You cannot create an asymmetric CMK or a multi-Region CMK in a custom key store.
    
    To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
    
    The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
  - withCustomKeyStoreId
```
public CreateKeyRequest withCustomKeyStoreId(String customKeyStoreId)
```
    Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
    
    This parameter is valid only for symmetric CMKs and regional CMKs. You cannot create an asymmetric CMK or a multi-Region CMK in a custom key store.
    
    To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
    
    The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
    
    Parameters:
    
    customKeyStoreId - Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
    
    This parameter is valid only for symmetric CMKs and regional CMKs. You cannot create an asymmetric CMK or a multi-Region CMK in a custom key store.
    
    To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
    
    The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBypassPolicyLockoutSafetyCheck
```
public void setBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)
```
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
    
    Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
    
    The default value is false.
    
    Parameters:
    
    bypassPolicyLockoutSafetyCheck - A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
    
    Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
    
    The default value is false.
  - getBypassPolicyLockoutSafetyCheck
```
public Boolean getBypassPolicyLockoutSafetyCheck()
```
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
    
    Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
    
    The default value is false.
    
    Returns:
    
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
    
    Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
    
    The default value is false.
  - withBypassPolicyLockoutSafetyCheck
```
public CreateKeyRequest withBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)
```
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
    
    Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
    
    The default value is false.
    
    Parameters:
    
    bypassPolicyLockoutSafetyCheck - A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
    
    Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
    
    The default value is false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isBypassPolicyLockoutSafetyCheck
```
public Boolean isBypassPolicyLockoutSafetyCheck()
```
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
    
    Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
    
    The default value is false.
    
    Returns:
    
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
    
    Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
    
    The default value is false.
  - getTags
```
public List<Tag> getTags()
```
    Assigns one or more tags to the CMK. Use this parameter to tag the CMK when it is created. To tag an existing CMK, use the TagResource operation.
    
    Tagging or untagging a CMK can allow or deny permission to the CMK. For details, see Using ABAC in AWS KMS in the AWS 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 CMK with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.
    
    When you assign tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a CMK. For details, see Tagging Keys.
    
    Returns:
    
    Assigns one or more tags to the CMK. Use this parameter to tag the CMK when it is created. To tag an existing CMK, use the TagResource operation.
    
    Tagging or untagging a CMK can allow or deny permission to the CMK. For details, see Using ABAC in AWS KMS in the AWS 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 CMK with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.
    
    When you assign tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a CMK. For details, see Tagging Keys.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Assigns one or more tags to the CMK. Use this parameter to tag the CMK when it is created. To tag an existing CMK, use the TagResource operation.
    
    Tagging or untagging a CMK can allow or deny permission to the CMK. For details, see Using ABAC in AWS KMS in the AWS 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 CMK with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.
    
    When you assign tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a CMK. For details, see Tagging Keys.
    
    Parameters:
    
    tags - Assigns one or more tags to the CMK. Use this parameter to tag the CMK when it is created. To tag an existing CMK, use the TagResource operation.
    
    Tagging or untagging a CMK can allow or deny permission to the CMK. For details, see Using ABAC in AWS KMS in the AWS 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 CMK with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.
    
    When you assign tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a CMK. For details, see Tagging Keys.
  - withTags
```
public CreateKeyRequest withTags(Tag... tags)
```
    Assigns one or more tags to the CMK. Use this parameter to tag the CMK when it is created. To tag an existing CMK, use the TagResource operation.
    
    Tagging or untagging a CMK can allow or deny permission to the CMK. For details, see Using ABAC in AWS KMS in the AWS 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 CMK with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.
    
    When you assign tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a CMK. For details, see Tagging Keys.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - Assigns one or more tags to the CMK. Use this parameter to tag the CMK when it is created. To tag an existing CMK, use the TagResource operation.
    
    Tagging or untagging a CMK can allow or deny permission to the CMK. For details, see Using ABAC in AWS KMS in the AWS 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 CMK with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.
    
    When you assign tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a CMK. For details, see Tagging Keys.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreateKeyRequest withTags(Collection<Tag> tags)
```
    Assigns one or more tags to the CMK. Use this parameter to tag the CMK when it is created. To tag an existing CMK, use the TagResource operation.
    
    Tagging or untagging a CMK can allow or deny permission to the CMK. For details, see Using ABAC in AWS KMS in the AWS 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 CMK with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.
    
    When you assign tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a CMK. For details, see Tagging Keys.
    
    Parameters:
    
    tags - Assigns one or more tags to the CMK. Use this parameter to tag the CMK when it is created. To tag an existing CMK, use the TagResource operation.
    
    Tagging or untagging a CMK can allow or deny permission to the CMK. For details, see Using ABAC in AWS KMS in the AWS 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 CMK with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.
    
    When you assign tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a CMK. For details, see Tagging Keys.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMultiRegion
```
public void setMultiRegion(Boolean multiRegion)
```
    Creates a multi-Region primary key that you can replicate into other AWS Regions. You cannot change this value after you create the CMK.
    
    For a multi-Region key, set this parameter to True. For a single-Region CMK, omit this parameter or set it to False. The default value is False.
    
    This operation supports multi-Region keys, an AWS KMS feature that lets you create multiple interoperable CMKs in different AWS Regions. Because these CMKs have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information about multi-Region keys, see Using multi-Region keys in the AWS 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 CMK, and you can create a multi-Region CMK with imported key material. However, you cannot create a multi-Region CMK in a custom key store.
    
    Parameters:
    
    multiRegion - Creates a multi-Region primary key that you can replicate into other AWS Regions. You cannot change this value after you create the CMK.
    
    For a multi-Region key, set this parameter to True. For a single-Region CMK, omit this parameter or set it to False. The default value is False.
    
    This operation supports multi-Region keys, an AWS KMS feature that lets you create multiple interoperable CMKs in different AWS Regions. Because these CMKs have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information about multi-Region keys, see Using multi-Region keys in the AWS 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 CMK, and you can create a multi-Region CMK with imported key material. However, you cannot create a multi-Region CMK in a custom key store.
  - getMultiRegion
```
public Boolean getMultiRegion()
```
    Creates a multi-Region primary key that you can replicate into other AWS Regions. You cannot change this value after you create the CMK.
    
    For a multi-Region key, set this parameter to True. For a single-Region CMK, omit this parameter or set it to False. The default value is False.
    
    This operation supports multi-Region keys, an AWS KMS feature that lets you create multiple interoperable CMKs in different AWS Regions. Because these CMKs have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information about multi-Region keys, see Using multi-Region keys in the AWS 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 CMK, and you can create a multi-Region CMK with imported key material. However, you cannot create a multi-Region CMK in a custom key store.
    
    Returns:
    
    Creates a multi-Region primary key that you can replicate into other AWS Regions. You cannot change this value after you create the CMK.
    
    For a multi-Region key, set this parameter to True. For a single-Region CMK, omit this parameter or set it to False. The default value is False.
    
    This operation supports multi-Region keys, an AWS KMS feature that lets you create multiple interoperable CMKs in different AWS Regions. Because these CMKs have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information about multi-Region keys, see Using multi-Region keys in the AWS 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 CMK, and you can create a multi-Region CMK with imported key material. However, you cannot create a multi-Region CMK in a custom key store.
  - withMultiRegion
```
public CreateKeyRequest withMultiRegion(Boolean multiRegion)
```
    Creates a multi-Region primary key that you can replicate into other AWS Regions. You cannot change this value after you create the CMK.
    
    For a multi-Region key, set this parameter to True. For a single-Region CMK, omit this parameter or set it to False. The default value is False.
    
    This operation supports multi-Region keys, an AWS KMS feature that lets you create multiple interoperable CMKs in different AWS Regions. Because these CMKs have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information about multi-Region keys, see Using multi-Region keys in the AWS 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 CMK, and you can create a multi-Region CMK with imported key material. However, you cannot create a multi-Region CMK in a custom key store.
    
    Parameters:
    
    multiRegion - Creates a multi-Region primary key that you can replicate into other AWS Regions. You cannot change this value after you create the CMK.
    
    For a multi-Region key, set this parameter to True. For a single-Region CMK, omit this parameter or set it to False. The default value is False.
    
    This operation supports multi-Region keys, an AWS KMS feature that lets you create multiple interoperable CMKs in different AWS Regions. Because these CMKs have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information about multi-Region keys, see Using multi-Region keys in the AWS 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 CMK, and you can create a multi-Region CMK with imported key material. However, you cannot create a multi-Region CMK in a custom key store.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isMultiRegion
```
public Boolean isMultiRegion()
```
    Creates a multi-Region primary key that you can replicate into other AWS Regions. You cannot change this value after you create the CMK.
    
    For a multi-Region key, set this parameter to True. For a single-Region CMK, omit this parameter or set it to False. The default value is False.
    
    This operation supports multi-Region keys, an AWS KMS feature that lets you create multiple interoperable CMKs in different AWS Regions. Because these CMKs have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information about multi-Region keys, see Using multi-Region keys in the AWS 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 CMK, and you can create a multi-Region CMK with imported key material. However, you cannot create a multi-Region CMK in a custom key store.
    
    Returns:
    
    Creates a multi-Region primary key that you can replicate into other AWS Regions. You cannot change this value after you create the CMK.
    
    For a multi-Region key, set this parameter to True. For a single-Region CMK, omit this parameter or set it to False. The default value is False.
    
    This operation supports multi-Region keys, an AWS KMS feature that lets you create multiple interoperable CMKs in different AWS Regions. Because these CMKs have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information about multi-Region keys, see Using multi-Region keys in the AWS 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 CMK, and you can create a multi-Region CMK with imported key material. However, you cannot create a multi-Region CMK in a custom key store.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateKeyRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class CreateKeyRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateKeyRequest

Method Detail

setPolicy

getPolicy

withPolicy

setDescription

getDescription

withDescription

setKeyUsage

getKeyUsage

withKeyUsage

setKeyUsage

withKeyUsage

setCustomerMasterKeySpec

getCustomerMasterKeySpec

withCustomerMasterKeySpec

setCustomerMasterKeySpec

withCustomerMasterKeySpec

setOrigin

getOrigin

withOrigin

setOrigin

withOrigin

setCustomKeyStoreId

getCustomKeyStoreId

withCustomKeyStoreId

setBypassPolicyLockoutSafetyCheck

getBypassPolicyLockoutSafetyCheck

withBypassPolicyLockoutSafetyCheck

isBypassPolicyLockoutSafetyCheck

getTags

setTags

withTags

withTags

setMultiRegion

getMultiRegion

withMultiRegion

isMultiRegion

toString

equals

hashCode

clone