CreateKeyRequest (AWS Java SDK for AWS KMS 1.12.114 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 Deprecated 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()` Deprecated.
`String`	`getCustomKeyStoreId()` Creates the KMS key in the specified custom key store and the key material in its associated CloudHSM cluster.
`String`	`getDescription()` A description of the KMS key.
`String`	`getKeySpec()` Specifies the type of KMS key to create.
`String`	`getKeyUsage()` Determines the cryptographic operations for which you can use the KMS key.
`Boolean`	`getMultiRegion()` Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions.
`String`	`getOrigin()` The source of the key material for the KMS key.
`String`	`getPolicy()` The key policy to attach to the KMS key.
`List<Tag>`	`getTags()` Assigns one or more tags to the KMS key.
`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 Amazon Web Services Regions.
`void`	`setBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)` A flag to indicate whether to bypass the key policy lockout safety check.
`void`	`setCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)` Deprecated.
`void`	`setCustomerMasterKeySpec(String customerMasterKeySpec)` Deprecated.
`void`	`setCustomKeyStoreId(String customKeyStoreId)` Creates the KMS key in the specified custom key store and the key material in its associated CloudHSM cluster.
`void`	`setDescription(String description)` A description of the KMS key.
`void`	`setKeySpec(KeySpec keySpec)` Specifies the type of KMS key to create.
`void`	`setKeySpec(String keySpec)` Specifies the type of KMS key to create.
`void`	`setKeyUsage(KeyUsageType keyUsage)` Determines the cryptographic operations for which you can use the KMS key.
`void`	`setKeyUsage(String keyUsage)` Determines the cryptographic operations for which you can use the KMS key.
`void`	`setMultiRegion(Boolean multiRegion)` Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions.
`void`	`setOrigin(OriginType origin)` The source of the key material for the KMS key.
`void`	`setOrigin(String origin)` The source of the key material for the KMS key.
`void`	`setPolicy(String policy)` The key policy to attach to the KMS key.
`void`	`setTags(Collection<Tag> tags)` Assigns one or more tags to the KMS key.
`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)` Deprecated.
`CreateKeyRequest`	`withCustomerMasterKeySpec(String customerMasterKeySpec)` Deprecated.
`CreateKeyRequest`	`withCustomKeyStoreId(String customKeyStoreId)` Creates the KMS key in the specified custom key store and the key material in its associated CloudHSM cluster.
`CreateKeyRequest`	`withDescription(String description)` A description of the KMS key.
`CreateKeyRequest`	`withKeySpec(KeySpec keySpec)` Specifies the type of KMS key to create.
`CreateKeyRequest`	`withKeySpec(String keySpec)` Specifies the type of KMS key to create.
`CreateKeyRequest`	`withKeyUsage(KeyUsageType keyUsage)` Determines the cryptographic operations for which you can use the KMS key.
`CreateKeyRequest`	`withKeyUsage(String keyUsage)` Determines the cryptographic operations for which you can use the KMS key.
`CreateKeyRequest`	`withMultiRegion(Boolean multiRegion)` Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions.
`CreateKeyRequest`	`withOrigin(OriginType origin)` The source of the key material for the KMS key.
`CreateKeyRequest`	`withOrigin(String origin)` The source of the key material for the KMS key.
`CreateKeyRequest`	`withPolicy(String policy)` The key policy to attach to the KMS key.
`CreateKeyRequest`	`withTags(Collection<Tag> tags)` Assigns one or more tags to the KMS key.
`CreateKeyRequest`	`withTags(Tag... tags)` Assigns one or more tags to the KMS key.

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 KMS key.
    
    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 KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the 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 KMS. When you create a new Amazon Web Services 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 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 .
    Parameters:
    policy - The key policy to attach to the KMS key.
    
    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 KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the 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 KMS. When you create a new Amazon Web Services 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 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 .
  - getPolicy
```
public String getPolicy()
```
    The key policy to attach to the KMS key.
    
    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 KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the 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 KMS. When you create a new Amazon Web Services 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 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 .
    Returns:
    The key policy to attach to the KMS key.
    
    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 KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the 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 KMS. When you create a new Amazon Web Services 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 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 .
  - withPolicy
```
public CreateKeyRequest withPolicy(String policy)
```
    The key policy to attach to the KMS key.
    
    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 KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the 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 KMS. When you create a new Amazon Web Services 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 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 .
    Parameters:
    policy - The key policy to attach to the KMS key.
    
    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 KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the 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 KMS. When you create a new Amazon Web Services 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 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 .
    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 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).
    
    To set or change the description after the key is created, use UpdateKeyDescription.
    
    Parameters:
    
    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).
    
    To set or change the description after the key is created, use UpdateKeyDescription.
  - getDescription
```
public String getDescription()
```
    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).
    
    To set or change the description after the key is created, use UpdateKeyDescription.
    
    Returns:
    
    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).
    
    To set or change the description after the key is created, use UpdateKeyDescription.
  - withDescription
```
public CreateKeyRequest withDescription(String 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).
    
    To set or change the description after the key is created, use UpdateKeyDescription.
    
    Parameters:
    
    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).
    
    To set or change the description after the key is created, use UpdateKeyDescription.
    
    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 KMS key. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric KMS keys. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    - For symmetric KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    - For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    - For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
    Parameters:
    keyUsage - Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric KMS keys. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    
    For symmetric KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    
    For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    
    For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
    See Also:
    
    KeyUsageType
  - getKeyUsage
```
public String getKeyUsage()
```
    Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric KMS keys. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    - For symmetric KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    - For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    - For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
    Returns:
    Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric KMS keys. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    
    For symmetric KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    
    For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    
    For asymmetric KMS keys 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 KMS key. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric KMS keys. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    - For symmetric KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    - For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    - For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
    Parameters:
    keyUsage - Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric KMS keys. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    
    For symmetric KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    
    For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    
    For asymmetric KMS keys 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 KMS key. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric KMS keys. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    - For symmetric KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    - For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    - For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
    Parameters:
    keyUsage - Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric KMS keys. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    
    For symmetric KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    
    For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    
    For asymmetric KMS keys 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 KMS key. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric KMS keys. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    - For symmetric KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    - For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    - For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
    Parameters:
    keyUsage - Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric KMS keys. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    
    For symmetric KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    
    For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    
    For asymmetric KMS keys 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
```
@Deprecated
public void setCustomerMasterKeySpec(String customerMasterKeySpec)
```
    Deprecated.
    
    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 will support both parameters.
    
    Parameters:
    
    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 will support both parameters.
    
    See Also:
    
    CustomerMasterKeySpec
  - getCustomerMasterKeySpec
```
@Deprecated
public String getCustomerMasterKeySpec()
```
    Deprecated.
    
    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 will support both parameters.
    
    Returns:
    
    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 will support both parameters.
    
    See Also:
    
    CustomerMasterKeySpec
  - withCustomerMasterKeySpec
```
@Deprecated
public CreateKeyRequest withCustomerMasterKeySpec(String customerMasterKeySpec)
```
    Deprecated.
    
    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 will support both parameters.
    
    Parameters:
    
    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 will support both parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CustomerMasterKeySpec
  - setCustomerMasterKeySpec
```
@Deprecated
public void setCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
```
    Deprecated.
    
    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 will support both parameters.
    
    Parameters:
    
    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 will support both parameters.
    
    See Also:
    
    CustomerMasterKeySpec
  - withCustomerMasterKeySpec
```
@Deprecated
public CreateKeyRequest withCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
```
    Deprecated.
    
    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 will support both parameters.
    
    Parameters:
    
    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 will support both parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CustomerMasterKeySpec
  - setKeySpec
```
public void setKeySpec(String keySpec)
```
    Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your KMS key, see How to Choose Your KMS key Configuration 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 encryption algorithms or signing 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 or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric KMS keys to protect your data. These services do not support asymmetric KMS keys. For help determining whether a KMS key is symmetric or asymmetric, see Identifying Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.
    
    KMS supports the following key specs for KMS keys:
    - 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:
    keySpec - Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your KMS key, see How to Choose Your KMS key Configuration 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 encryption algorithms or signing 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 or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric KMS keys to protect your data. These services do not support asymmetric KMS keys. For help determining whether a KMS key is symmetric or asymmetric, see Identifying Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.
    
    KMS supports the following key specs for KMS keys:
    
    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:
    
    KeySpec
  - getKeySpec
```
public String getKeySpec()
```
    Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your KMS key, see How to Choose Your KMS key Configuration 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 encryption algorithms or signing 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 or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric KMS keys to protect your data. These services do not support asymmetric KMS keys. For help determining whether a KMS key is symmetric or asymmetric, see Identifying Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.
    
    KMS supports the following key specs for KMS keys:
    - 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 KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your KMS key, see How to Choose Your KMS key Configuration 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 encryption algorithms or signing 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 or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric KMS keys to protect your data. These services do not support asymmetric KMS keys. For help determining whether a KMS key is symmetric or asymmetric, see Identifying Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.
    
    KMS supports the following key specs for KMS keys:
    
    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:
    
    KeySpec
  - withKeySpec
```
public CreateKeyRequest withKeySpec(String keySpec)
```
    Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your KMS key, see How to Choose Your KMS key Configuration 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 encryption algorithms or signing 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 or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric KMS keys to protect your data. These services do not support asymmetric KMS keys. For help determining whether a KMS key is symmetric or asymmetric, see Identifying Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.
    
    KMS supports the following key specs for KMS keys:
    - 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:
    keySpec - Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your KMS key, see How to Choose Your KMS key Configuration 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 encryption algorithms or signing 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 or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric KMS keys to protect your data. These services do not support asymmetric KMS keys. For help determining whether a KMS key is symmetric or asymmetric, see Identifying Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.
    
    KMS supports the following key specs for KMS keys:
    
    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:
    
    KeySpec
  - setKeySpec
```
public void setKeySpec(KeySpec keySpec)
```
    Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your KMS key, see How to Choose Your KMS key Configuration 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 encryption algorithms or signing 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 or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric KMS keys to protect your data. These services do not support asymmetric KMS keys. For help determining whether a KMS key is symmetric or asymmetric, see Identifying Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.
    
    KMS supports the following key specs for KMS keys:
    - 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:
    keySpec - Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your KMS key, see How to Choose Your KMS key Configuration 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 encryption algorithms or signing 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 or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric KMS keys to protect your data. These services do not support asymmetric KMS keys. For help determining whether a KMS key is symmetric or asymmetric, see Identifying Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.
    
    KMS supports the following key specs for KMS keys:
    
    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:
    
    KeySpec
  - withKeySpec
```
public CreateKeyRequest withKeySpec(KeySpec keySpec)
```
    Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your KMS key, see How to Choose Your KMS key Configuration 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 encryption algorithms or signing 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 or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric KMS keys to protect your data. These services do not support asymmetric KMS keys. For help determining whether a KMS key is symmetric or asymmetric, see Identifying Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.
    
    KMS supports the following key specs for KMS keys:
    - 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:
    keySpec - Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your KMS key, see How to Choose Your KMS key Configuration 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 encryption algorithms or signing 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 or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric KMS keys to protect your data. These services do not support asymmetric KMS keys. For help determining whether a KMS key is symmetric or asymmetric, see Identifying Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.
    
    KMS supports the following key specs for KMS keys:
    
    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:
    
    KeySpec
  - setOrigin
```
public void setOrigin(String 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 the value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. This value is valid only for symmetric KMS keys.
    
    To create a KMS key in an KMS custom 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 custom key store. This value is valid only for symmetric KMS keys.
    
    Parameters:
    
    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 the value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. This value is valid only for symmetric KMS keys.
    
    To create a KMS key in an KMS custom 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 custom key store. This value is valid only for symmetric KMS keys.
    
    See Also:
    
    OriginType
  - getOrigin
```
public String getOrigin()
```
    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 the value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. This value is valid only for symmetric KMS keys.
    
    To create a KMS key in an KMS custom 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 custom key store. This value is valid only for symmetric KMS keys.
    
    Returns:
    
    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 the value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. This value is valid only for symmetric KMS keys.
    
    To create a KMS key in an KMS custom 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 custom key store. This value is valid only for symmetric KMS keys.
    
    See Also:
    
    OriginType
  - withOrigin
```
public CreateKeyRequest withOrigin(String 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 the value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. This value is valid only for symmetric KMS keys.
    
    To create a KMS key in an KMS custom 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 custom key store. This value is valid only for symmetric KMS keys.
    
    Parameters:
    
    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 the value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. This value is valid only for symmetric KMS keys.
    
    To create a KMS key in an KMS custom 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 custom key store. This value is valid only for symmetric KMS keys.
    
    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 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 the value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. This value is valid only for symmetric KMS keys.
    
    To create a KMS key in an KMS custom 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 custom key store. This value is valid only for symmetric KMS keys.
    
    Parameters:
    
    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 the value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. This value is valid only for symmetric KMS keys.
    
    To create a KMS key in an KMS custom 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 custom key store. This value is valid only for symmetric KMS keys.
    
    See Also:
    
    OriginType
  - withOrigin
```
public CreateKeyRequest withOrigin(OriginType 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 the value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. This value is valid only for symmetric KMS keys.
    
    To create a KMS key in an KMS custom 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 custom key store. This value is valid only for symmetric KMS keys.
    
    Parameters:
    
    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 the value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. This value is valid only for symmetric KMS keys.
    
    To create a KMS key in an KMS custom 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 custom key store. This value is valid only for symmetric KMS keys.
    
    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 KMS key in the specified custom key store and the key material in its associated CloudHSM cluster. To create a KMS key in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The 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 KMS keys and regional KMS keys. You cannot create an asymmetric KMS key or a multi-Region key 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 CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store.
    
    Parameters:
    
    customKeyStoreId - Creates the KMS key in the specified custom key store and the key material in its associated CloudHSM cluster. To create a KMS key in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The 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 KMS keys and regional KMS keys. You cannot create an asymmetric KMS key or a multi-Region key 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 CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store.
  - getCustomKeyStoreId
```
public String getCustomKeyStoreId()
```
    Creates the KMS key in the specified custom key store and the key material in its associated CloudHSM cluster. To create a KMS key in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The 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 KMS keys and regional KMS keys. You cannot create an asymmetric KMS key or a multi-Region key 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 CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store.
    
    Returns:
    
    Creates the KMS key in the specified custom key store and the key material in its associated CloudHSM cluster. To create a KMS key in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The 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 KMS keys and regional KMS keys. You cannot create an asymmetric KMS key or a multi-Region key 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 CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store.
  - withCustomKeyStoreId
```
public CreateKeyRequest withCustomKeyStoreId(String customKeyStoreId)
```
    Creates the KMS key in the specified custom key store and the key material in its associated CloudHSM cluster. To create a KMS key in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The 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 KMS keys and regional KMS keys. You cannot create an asymmetric KMS key or a multi-Region key 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 CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store.
    
    Parameters:
    
    customKeyStoreId - Creates the KMS key in the specified custom key store and the key material in its associated CloudHSM cluster. To create a KMS key in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The 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 KMS keys and regional KMS keys. You cannot create an asymmetric KMS key or a multi-Region key 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 CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in KMS, which combines the convenience and extensive integration of 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 KMS key 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 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 KMS key.
    
    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 KMS key 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 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 KMS key.
    
    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 KMS key 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 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 KMS key.
    
    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 KMS key 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 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 KMS key.
    
    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 KMS key 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 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 KMS key.
    
    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 KMS key 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 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 KMS key.
    
    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 KMS key 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 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 KMS key.
    
    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 KMS key 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 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 KMS key.
    
    The default value is false.
  - getTags
```
public List<Tag> getTags()
```
    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.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in 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.
    
    Returns:
    
    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.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in 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.
  - setTags
```
public void setTags(Collection<Tag> 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.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in 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.
    
    Parameters:
    
    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.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in 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.
  - withTags
```
public CreateKeyRequest withTags(Tag... 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.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in 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 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 KMS key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in 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.
    
    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 KMS key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in 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.
    
    Parameters:
    
    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.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in 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.
    
    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 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 Using multi-Region keys 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.
    
    Parameters:
    
    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 Using multi-Region keys 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.
  - getMultiRegion
```
public Boolean getMultiRegion()
```
    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 Using multi-Region keys 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.
    
    Returns:
    
    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 Using multi-Region keys 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.
  - withMultiRegion
```
public CreateKeyRequest withMultiRegion(Boolean 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 Using multi-Region keys 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.
    
    Parameters:
    
    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 Using multi-Region keys 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.
    
    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 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 Using multi-Region keys 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.
    
    Returns:
    
    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 Using multi-Region keys 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.
  - 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

setKeySpec

getKeySpec

withKeySpec

setKeySpec

withKeySpec

setOrigin

getOrigin

withOrigin

setOrigin

withOrigin

setCustomKeyStoreId

getCustomKeyStoreId

withCustomKeyStoreId

setBypassPolicyLockoutSafetyCheck

getBypassPolicyLockoutSafetyCheck

withBypassPolicyLockoutSafetyCheck

isBypassPolicyLockoutSafetyCheck

getTags

setTags

withTags

withTags

setMultiRegion

getMultiRegion

withMultiRegion

isMultiRegion

toString

equals

hashCode

clone