CreateKeyRequest (AWS SDK for Java

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()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`Boolean`	`getBypassPolicyLockoutSafetyCheck()` Skips ("bypasses") the key policy lockout safety check.
`String`	`getCustomerMasterKeySpec()` Deprecated.
`String`	`getCustomKeyStoreId()` Creates the KMS key in the specified custom key store.
`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.
`String`	`getXksKeyId()` Identifies the external key that serves as key material for the KMS key in an external key store.
`int`	`hashCode()`
`Boolean`	`isBypassPolicyLockoutSafetyCheck()` Skips ("bypasses") 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)` Skips ("bypasses") 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.
`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.
`void`	`setXksKeyId(String xksKeyId)` Identifies the external key that serves as key material for the KMS key in an external key store.
`String`	`toString()` Returns a string representation of this object.
`CreateKeyRequest`	`withBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)` Skips ("bypasses") 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.
`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.
`CreateKeyRequest`	`withXksKeyId(String xksKeyId)` Identifies the external key that serves as key material for the KMS key in an external key store.

Methods inherited from class java.lang.Object
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:
    - The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
    - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
    If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default key policy in the Key Management Service Developer Guide.
    
    The key policy size quota is 32 kilobytes (32768 bytes).
    
    For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
    Parameters:
    policy - The key policy to attach to the KMS key.
    
    If you provide a key policy, it must meet the following criteria:
    
    The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
    
    Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
    
    If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default key policy in the Key Management Service Developer Guide.
    
    The key policy size quota is 32 kilobytes (32768 bytes).
    
    For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
  - 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:
    - The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
    - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
    If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default key policy in the Key Management Service Developer Guide.
    
    The key policy size quota is 32 kilobytes (32768 bytes).
    
    For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
    Returns:
    The key policy to attach to the KMS key.
    
    If you provide a key policy, it must meet the following criteria:
    
    The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
    
    Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
    
    If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default key policy in the Key Management Service Developer Guide.
    
    The key policy size quota is 32 kilobytes (32768 bytes).
    
    For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
  - 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:
    - The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
    - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
    If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default key policy in the Key Management Service Developer Guide.
    
    The key policy size quota is 32 kilobytes (32768 bytes).
    
    For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
    Parameters:
    policy - The key policy to attach to the KMS key.
    
    If you provide a key policy, it must meet the following criteria:
    
    The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)
    
    Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
    
    If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default key policy in the Key Management Service Developer Guide.
    
    The key policy size quota is 32 kilobytes (32768 bytes).
    
    For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
    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).
    
    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
    
    To set or change the description after the key is created, use UpdateKeyDescription.
    
    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).
    
    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
    
    To set or change the description after the key is created, use UpdateKeyDescription.
  - 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).
    
    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
    
    To set or change the description after the key is created, use UpdateKeyDescription.
    
    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).
    
    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
    
    To set or change the description after the key is created, use UpdateKeyDescription.
  - 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).
    
    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
    
    To set or change the description after the key is created, use UpdateKeyDescription.
    
    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).
    
    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
    
    To set or change the description after the key is created, use UpdateKeyDescription.
    
    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 optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    - For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    - For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
    - For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    - For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT.
    - For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
    - For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.
    Parameters:
    keyUsage - Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    
    For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    
    For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
    
    For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    
    For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT.
    
    For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
    
    For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.
    See 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 optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    - For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    - For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
    - For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    - For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT.
    - For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
    - For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.
    Returns:
    Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    
    For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    
    For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
    
    For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    
    For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT.
    
    For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
    
    For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.
    See 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 optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    - For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    - For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
    - For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    - For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT.
    - For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
    - For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.
    Parameters:
    keyUsage - Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    
    For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    
    For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
    
    For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    
    For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT.
    
    For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
    
    For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.
    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 optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    - For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    - For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
    - For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    - For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT.
    - For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
    - For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.
    Parameters:
    keyUsage - Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    
    For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    
    For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
    
    For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    
    For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT.
    
    For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
    
    For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.
    See 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 optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    - For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    - For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
    - For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    - For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT.
    - For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
    - For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.
    Parameters:
    keyUsage - Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is created.
    
    Select only one valid value.
    
    For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
    
    For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.
    
    For asymmetric KMS keys with RSA key pairs, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
    
    For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify SIGN_VERIFY or KEY_AGREEMENT.
    
    For asymmetric KMS keys with ECC_SECG_P256K1 key pairs specify SIGN_VERIFY.
    
    For asymmetric KMS keys with SM2 key pairs (China Regions only), specify ENCRYPT_DECRYPT, SIGN_VERIFY, or KEY_AGREEMENT.
    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 supports 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 supports 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 supports 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 supports 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 supports 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 supports 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 supports 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 supports 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 supports 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 supports 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 AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the Key Management Service Developer Guide .
    
    The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.
    
    KMS supports the following key specs for KMS keys:
    - Symmetric encryption key (default)
      
      SYMMETRIC_DEFAULT
    - HMAC keys (symmetric)
      
      HMAC_224
      
      HMAC_256
      
      HMAC_384
      
      HMAC_512
    - Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
      
      RSA_2048
      
      RSA_3072
      
      RSA_4096
    - Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)
      
      ECC_NIST_P256 (secp256r1)
      
      ECC_NIST_P384 (secp384r1)
      
      ECC_NIST_P521 (secp521r1)
    - Other asymmetric elliptic curve key pairs (signing and verification)
      
      ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    - SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
      
      SM2 (China Regions only)
    Parameters:
    keySpec - Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the Key Management Service Developer Guide .
    
    The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.
    
    KMS supports the following key specs for KMS keys:
    
    Symmetric encryption key (default)
    
    SYMMETRIC_DEFAULT
    
    HMAC keys (symmetric)
    
    HMAC_224
    
    HMAC_256
    
    HMAC_384
    
    HMAC_512
    
    Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
    
    RSA_2048
    
    RSA_3072
    
    RSA_4096
    
    Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)
    
    ECC_NIST_P256 (secp256r1)
    
    ECC_NIST_P384 (secp384r1)
    
    ECC_NIST_P521 (secp521r1)
    
    Other asymmetric elliptic curve key pairs (signing and verification)
    
    ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    
    SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
    
    SM2 (China Regions only)
    See 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 AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the Key Management Service Developer Guide .
    
    The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.
    
    KMS supports the following key specs for KMS keys:
    - Symmetric encryption key (default)
      
      SYMMETRIC_DEFAULT
    - HMAC keys (symmetric)
      
      HMAC_224
      
      HMAC_256
      
      HMAC_384
      
      HMAC_512
    - Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
      
      RSA_2048
      
      RSA_3072
      
      RSA_4096
    - Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)
      
      ECC_NIST_P256 (secp256r1)
      
      ECC_NIST_P384 (secp384r1)
      
      ECC_NIST_P521 (secp521r1)
    - Other asymmetric elliptic curve key pairs (signing and verification)
      
      ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    - SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
      
      SM2 (China Regions only)
    Returns:
    Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the Key Management Service Developer Guide .
    
    The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.
    
    KMS supports the following key specs for KMS keys:
    
    Symmetric encryption key (default)
    
    SYMMETRIC_DEFAULT
    
    HMAC keys (symmetric)
    
    HMAC_224
    
    HMAC_256
    
    HMAC_384
    
    HMAC_512
    
    Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
    
    RSA_2048
    
    RSA_3072
    
    RSA_4096
    
    Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)
    
    ECC_NIST_P256 (secp256r1)
    
    ECC_NIST_P384 (secp384r1)
    
    ECC_NIST_P521 (secp521r1)
    
    Other asymmetric elliptic curve key pairs (signing and verification)
    
    ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    
    SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
    
    SM2 (China Regions only)
    See 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 AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the Key Management Service Developer Guide .
    
    The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.
    
    KMS supports the following key specs for KMS keys:
    - Symmetric encryption key (default)
      
      SYMMETRIC_DEFAULT
    - HMAC keys (symmetric)
      
      HMAC_224
      
      HMAC_256
      
      HMAC_384
      
      HMAC_512
    - Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
      
      RSA_2048
      
      RSA_3072
      
      RSA_4096
    - Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)
      
      ECC_NIST_P256 (secp256r1)
      
      ECC_NIST_P384 (secp384r1)
      
      ECC_NIST_P521 (secp521r1)
    - Other asymmetric elliptic curve key pairs (signing and verification)
      
      ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    - SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
      
      SM2 (China Regions only)
    Parameters:
    keySpec - Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the Key Management Service Developer Guide .
    
    The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.
    
    KMS supports the following key specs for KMS keys:
    
    Symmetric encryption key (default)
    
    SYMMETRIC_DEFAULT
    
    HMAC keys (symmetric)
    
    HMAC_224
    
    HMAC_256
    
    HMAC_384
    
    HMAC_512
    
    Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
    
    RSA_2048
    
    RSA_3072
    
    RSA_4096
    
    Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)
    
    ECC_NIST_P256 (secp256r1)
    
    ECC_NIST_P384 (secp384r1)
    
    ECC_NIST_P521 (secp521r1)
    
    Other asymmetric elliptic curve key pairs (signing and verification)
    
    ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    
    SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
    
    SM2 (China Regions only)
    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 AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the Key Management Service Developer Guide .
    
    The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.
    
    KMS supports the following key specs for KMS keys:
    - Symmetric encryption key (default)
      
      SYMMETRIC_DEFAULT
    - HMAC keys (symmetric)
      
      HMAC_224
      
      HMAC_256
      
      HMAC_384
      
      HMAC_512
    - Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
      
      RSA_2048
      
      RSA_3072
      
      RSA_4096
    - Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)
      
      ECC_NIST_P256 (secp256r1)
      
      ECC_NIST_P384 (secp384r1)
      
      ECC_NIST_P521 (secp521r1)
    - Other asymmetric elliptic curve key pairs (signing and verification)
      
      ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    - SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
      
      SM2 (China Regions only)
    Parameters:
    keySpec - Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the Key Management Service Developer Guide .
    
    The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.
    
    KMS supports the following key specs for KMS keys:
    
    Symmetric encryption key (default)
    
    SYMMETRIC_DEFAULT
    
    HMAC keys (symmetric)
    
    HMAC_224
    
    HMAC_256
    
    HMAC_384
    
    HMAC_512
    
    Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
    
    RSA_2048
    
    RSA_3072
    
    RSA_4096
    
    Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)
    
    ECC_NIST_P256 (secp256r1)
    
    ECC_NIST_P384 (secp384r1)
    
    ECC_NIST_P521 (secp521r1)
    
    Other asymmetric elliptic curve key pairs (signing and verification)
    
    ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    
    SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
    
    SM2 (China Regions only)
    See 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 AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the Key Management Service Developer Guide .
    
    The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.
    
    KMS supports the following key specs for KMS keys:
    - Symmetric encryption key (default)
      
      SYMMETRIC_DEFAULT
    - HMAC keys (symmetric)
      
      HMAC_224
      
      HMAC_256
      
      HMAC_384
      
      HMAC_512
    - Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
      
      RSA_2048
      
      RSA_3072
      
      RSA_4096
    - Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)
      
      ECC_NIST_P256 (secp256r1)
      
      ECC_NIST_P384 (secp384r1)
      
      ECC_NIST_P521 (secp521r1)
    - Other asymmetric elliptic curve key pairs (signing and verification)
      
      ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    - SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
      
      SM2 (China Regions only)
    Parameters:
    keySpec - Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the Key Management Service Developer Guide .
    
    The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It also determines the algorithms that the KMS key supports. You can't change the KeySpec after the KMS key is created. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm, kms:MacAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
    
    Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.
    
    KMS supports the following key specs for KMS keys:
    
    Symmetric encryption key (default)
    
    SYMMETRIC_DEFAULT
    
    HMAC keys (symmetric)
    
    HMAC_224
    
    HMAC_256
    
    HMAC_384
    
    HMAC_512
    
    Asymmetric RSA key pairs (encryption and decryption -or- signing and verification)
    
    RSA_2048
    
    RSA_3072
    
    RSA_4096
    
    Asymmetric NIST-recommended elliptic curve key pairs (signing and verification -or- deriving shared secrets)
    
    ECC_NIST_P256 (secp256r1)
    
    ECC_NIST_P384 (secp384r1)
    
    ECC_NIST_P521 (secp521r1)
    
    Other asymmetric elliptic curve key pairs (signing and verification)
    
    ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
    
    SM2 key pairs (encryption and decryption -or- signing and verification -or- deriving shared secrets)
    
    SM2 (China Regions only)
    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 this value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for symmetric KMS keys.
    
    To create a KMS key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    To create a KMS key in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the CustomKeyStoreId parameter to identify the external key store and the XksKeyId parameter to identify the associated external key. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    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 this value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for symmetric KMS keys.
    
    To create a KMS key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    To create a KMS key in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the CustomKeyStoreId parameter to identify the external key store and the XksKeyId parameter to identify the associated external key. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    See 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 this value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for symmetric KMS keys.
    
    To create a KMS key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    To create a KMS key in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the CustomKeyStoreId parameter to identify the external key store and the XksKeyId parameter to identify the associated external key. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    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 this value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for symmetric KMS keys.
    
    To create a KMS key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    To create a KMS key in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the CustomKeyStoreId parameter to identify the external key store and the XksKeyId parameter to identify the associated external key. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    See 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 this value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for symmetric KMS keys.
    
    To create a KMS key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    To create a KMS key in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the CustomKeyStoreId parameter to identify the external key store and the XksKeyId parameter to identify the associated external key. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    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 this value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for symmetric KMS keys.
    
    To create a KMS key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    To create a KMS key in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the CustomKeyStoreId parameter to identify the external key store and the XksKeyId parameter to identify the associated external key. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    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 this value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for symmetric KMS keys.
    
    To create a KMS key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    To create a KMS key in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the CustomKeyStoreId parameter to identify the external key store and the XksKeyId parameter to identify the associated external key. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    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 this value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for symmetric KMS keys.
    
    To create a KMS key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    To create a KMS key in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the CustomKeyStoreId parameter to identify the external key store and the XksKeyId parameter to identify the associated external key. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    See 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 this value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for symmetric KMS keys.
    
    To create a KMS key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    To create a KMS key in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the CustomKeyStoreId parameter to identify the external key store and the XksKeyId parameter to identify the associated external key. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    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 this value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for symmetric KMS keys.
    
    To create a KMS key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    To create a KMS key in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the CustomKeyStoreId parameter to identify the external key store and the XksKeyId parameter to identify the associated external key. The KeySpec value must be SYMMETRIC_DEFAULT.
    
    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. The ConnectionState of the custom key store must be CONNECTED. To find the CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.
    
    This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other type of KMS key in a custom key store.
    
    When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key in its associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key store, you must use the XksKeyId parameter to specify an external key that serves as key material for the KMS key.
    
    Parameters:
    
    customKeyStoreId - Creates the KMS key in the specified custom key store. The ConnectionState of the custom key store must be CONNECTED. To find the CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.
    
    This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other type of KMS key in a custom key store.
    
    When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key in its associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key store, you must use the XksKeyId parameter to specify an external key that serves as key material for the KMS key.
  - getCustomKeyStoreId
```
public String getCustomKeyStoreId()
```
    Creates the KMS key in the specified custom key store. The ConnectionState of the custom key store must be CONNECTED. To find the CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.
    
    This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other type of KMS key in a custom key store.
    
    When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key in its associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key store, you must use the XksKeyId parameter to specify an external key that serves as key material for the KMS key.
    
    Returns:
    
    Creates the KMS key in the specified custom key store. The ConnectionState of the custom key store must be CONNECTED. To find the CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.
    
    This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other type of KMS key in a custom key store.
    
    When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key in its associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key store, you must use the XksKeyId parameter to specify an external key that serves as key material for the KMS key.
  - withCustomKeyStoreId
```
public CreateKeyRequest withCustomKeyStoreId(String customKeyStoreId)
```
    Creates the KMS key in the specified custom key store. The ConnectionState of the custom key store must be CONNECTED. To find the CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.
    
    This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other type of KMS key in a custom key store.
    
    When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key in its associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key store, you must use the XksKeyId parameter to specify an external key that serves as key material for the KMS key.
    
    Parameters:
    
    customKeyStoreId - Creates the KMS key in the specified custom key store. The ConnectionState of the custom key store must be CONNECTED. To find the CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.
    
    This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other type of KMS key in a custom key store.
    
    When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key in its associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key store, you must use the XksKeyId parameter to specify an external key that serves as key material for the KMS key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBypassPolicyLockoutSafetyCheck
```
public void setBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)
```
    Skips ("bypasses") the key policy lockout safety check. The default value is false.
    
    Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, see Default key policy in the Key Management Service Developer Guide.
    
    Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
    
    Parameters:
    
    bypassPolicyLockoutSafetyCheck - Skips ("bypasses") the key policy lockout safety check. The default value is false.
    
    Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, see Default key policy in the Key Management Service Developer Guide.
    
    Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
  - getBypassPolicyLockoutSafetyCheck
```
public Boolean getBypassPolicyLockoutSafetyCheck()
```
    Skips ("bypasses") the key policy lockout safety check. The default value is false.
    
    Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, see Default key policy in the Key Management Service Developer Guide.
    
    Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
    
    Returns:
    
    Skips ("bypasses") the key policy lockout safety check. The default value is false.
    
    Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, see Default key policy in the Key Management Service Developer Guide.
    
    Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
  - withBypassPolicyLockoutSafetyCheck
```
public CreateKeyRequest withBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)
```
    Skips ("bypasses") the key policy lockout safety check. The default value is false.
    
    Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, see Default key policy in the Key Management Service Developer Guide.
    
    Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
    
    Parameters:
    
    bypassPolicyLockoutSafetyCheck - Skips ("bypasses") the key policy lockout safety check. The default value is false.
    
    Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, see Default key policy in the Key Management Service Developer Guide.
    
    Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isBypassPolicyLockoutSafetyCheck
```
public Boolean isBypassPolicyLockoutSafetyCheck()
```
    Skips ("bypasses") the key policy lockout safety check. The default value is false.
    
    Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, see Default key policy in the Key Management Service Developer Guide.
    
    Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
    
    Returns:
    
    Skips ("bypasses") the key policy lockout safety check. The default value is false.
    
    Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, see Default key policy in the Key Management Service Developer Guide.
    
    Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
  - 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.
    
    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.
    
    To use this parameter, you must have kms:TagResource permission in an IAM policy.
    
    Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
    
    When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
    
    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.
    
    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.
    
    To use this parameter, you must have kms:TagResource permission in an IAM policy.
    
    Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
    
    When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
  - 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.
    
    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.
    
    To use this parameter, you must have kms:TagResource permission in an IAM policy.
    
    Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
    
    When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
    
    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.
    
    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.
    
    To use this parameter, you must have kms:TagResource permission in an IAM policy.
    
    Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
    
    When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
  - 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.
    
    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.
    
    To use this parameter, you must have kms:TagResource permission in an IAM policy.
    
    Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
    
    When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
    
    NOTE: This method appends the values to the existing list (if any). Use 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.
    
    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.
    
    To use this parameter, you must have kms:TagResource permission in an IAM policy.
    
    Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
    
    When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
    
    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.
    
    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.
    
    To use this parameter, you must have kms:TagResource permission in an IAM policy.
    
    Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
    
    When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
    
    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.
    
    Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.
    
    To use this parameter, you must have kms:TagResource permission in an IAM policy.
    
    Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
    
    When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
    
    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 Multi-Region keys in KMS in the Key Management Service Developer Guide.
    
    This value creates a primary key, not a replica. To create a replica key, use the ReplicateKey operation.
    
    You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.
    
    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 Multi-Region keys in KMS in the Key Management Service Developer Guide.
    
    This value creates a primary key, not a replica. To create a replica key, use the ReplicateKey operation.
    
    You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.
  - 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 Multi-Region keys in KMS in the Key Management Service Developer Guide.
    
    This value creates a primary key, not a replica. To create a replica key, use the ReplicateKey operation.
    
    You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.
    
    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 Multi-Region keys in KMS in the Key Management Service Developer Guide.
    
    This value creates a primary key, not a replica. To create a replica key, use the ReplicateKey operation.
    
    You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.
  - 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 Multi-Region keys in KMS in the Key Management Service Developer Guide.
    
    This value creates a primary key, not a replica. To create a replica key, use the ReplicateKey operation.
    
    You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.
    
    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 Multi-Region keys in KMS in the Key Management Service Developer Guide.
    
    This value creates a primary key, not a replica. To create a replica key, use the ReplicateKey operation.
    
    You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.
    
    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 Multi-Region keys in KMS in the Key Management Service Developer Guide.
    
    This value creates a primary key, not a replica. To create a replica key, use the ReplicateKey operation.
    
    You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.
    
    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 Multi-Region keys in KMS in the Key Management Service Developer Guide.
    
    This value creates a primary key, not a replica. To create a replica key, use the ReplicateKey operation.
    
    You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.
  - setXksKeyId
```
public void setXksKeyId(String xksKeyId)
```
    Identifies the external key that serves as key material for the KMS key in an external key store. Specify the ID that the external key store proxy uses to refer to the external key. For help, see the documentation for your external key store proxy.
    
    This parameter is required for a KMS key with an Origin value of EXTERNAL_KEY_STORE. It is not valid for KMS keys with any other Origin value.
    
    The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web Services in an external key manager associated with the external key store specified by the CustomKeyStoreId parameter. This key must be enabled and configured to perform encryption and decryption. Each KMS key in an external key store must use a different external key. For details, see Requirements for a KMS key in an external key store in the Key Management Service Developer Guide.
    
    Each KMS key in an external key store is associated two backing keys. One is key material that KMS generates. The other is the external key specified by this parameter. When you use the KMS key in an external key store to encrypt data, the encryption operation is performed first by KMS using the KMS key material, and then by the external key manager using the specified external key, a process known as double encryption. For details, see Double encryption in the Key Management Service Developer Guide.
    
    Parameters:
    
    xksKeyId - Identifies the external key that serves as key material for the KMS key in an external key store. Specify the ID that the external key store proxy uses to refer to the external key. For help, see the documentation for your external key store proxy.
    
    This parameter is required for a KMS key with an Origin value of EXTERNAL_KEY_STORE. It is not valid for KMS keys with any other Origin value.
    
    The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web Services in an external key manager associated with the external key store specified by the CustomKeyStoreId parameter. This key must be enabled and configured to perform encryption and decryption. Each KMS key in an external key store must use a different external key. For details, see Requirements for a KMS key in an external key store in the Key Management Service Developer Guide.
    
    Each KMS key in an external key store is associated two backing keys. One is key material that KMS generates. The other is the external key specified by this parameter. When you use the KMS key in an external key store to encrypt data, the encryption operation is performed first by KMS using the KMS key material, and then by the external key manager using the specified external key, a process known as double encryption. For details, see Double encryption in the Key Management Service Developer Guide.
  - getXksKeyId
```
public String getXksKeyId()
```
    Identifies the external key that serves as key material for the KMS key in an external key store. Specify the ID that the external key store proxy uses to refer to the external key. For help, see the documentation for your external key store proxy.
    
    This parameter is required for a KMS key with an Origin value of EXTERNAL_KEY_STORE. It is not valid for KMS keys with any other Origin value.
    
    The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web Services in an external key manager associated with the external key store specified by the CustomKeyStoreId parameter. This key must be enabled and configured to perform encryption and decryption. Each KMS key in an external key store must use a different external key. For details, see Requirements for a KMS key in an external key store in the Key Management Service Developer Guide.
    
    Each KMS key in an external key store is associated two backing keys. One is key material that KMS generates. The other is the external key specified by this parameter. When you use the KMS key in an external key store to encrypt data, the encryption operation is performed first by KMS using the KMS key material, and then by the external key manager using the specified external key, a process known as double encryption. For details, see Double encryption in the Key Management Service Developer Guide.
    
    Returns:
    
    Identifies the external key that serves as key material for the KMS key in an external key store. Specify the ID that the external key store proxy uses to refer to the external key. For help, see the documentation for your external key store proxy.
    
    This parameter is required for a KMS key with an Origin value of EXTERNAL_KEY_STORE. It is not valid for KMS keys with any other Origin value.
    
    The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web Services in an external key manager associated with the external key store specified by the CustomKeyStoreId parameter. This key must be enabled and configured to perform encryption and decryption. Each KMS key in an external key store must use a different external key. For details, see Requirements for a KMS key in an external key store in the Key Management Service Developer Guide.
    
    Each KMS key in an external key store is associated two backing keys. One is key material that KMS generates. The other is the external key specified by this parameter. When you use the KMS key in an external key store to encrypt data, the encryption operation is performed first by KMS using the KMS key material, and then by the external key manager using the specified external key, a process known as double encryption. For details, see Double encryption in the Key Management Service Developer Guide.
  - withXksKeyId
```
public CreateKeyRequest withXksKeyId(String xksKeyId)
```
    Identifies the external key that serves as key material for the KMS key in an external key store. Specify the ID that the external key store proxy uses to refer to the external key. For help, see the documentation for your external key store proxy.
    
    This parameter is required for a KMS key with an Origin value of EXTERNAL_KEY_STORE. It is not valid for KMS keys with any other Origin value.
    
    The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web Services in an external key manager associated with the external key store specified by the CustomKeyStoreId parameter. This key must be enabled and configured to perform encryption and decryption. Each KMS key in an external key store must use a different external key. For details, see Requirements for a KMS key in an external key store in the Key Management Service Developer Guide.
    
    Each KMS key in an external key store is associated two backing keys. One is key material that KMS generates. The other is the external key specified by this parameter. When you use the KMS key in an external key store to encrypt data, the encryption operation is performed first by KMS using the KMS key material, and then by the external key manager using the specified external key, a process known as double encryption. For details, see Double encryption in the Key Management Service Developer Guide.
    
    Parameters:
    
    xksKeyId - Identifies the external key that serves as key material for the KMS key in an external key store. Specify the ID that the external key store proxy uses to refer to the external key. For help, see the documentation for your external key store proxy.
    
    This parameter is required for a KMS key with an Origin value of EXTERNAL_KEY_STORE. It is not valid for KMS keys with any other Origin value.
    
    The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web Services in an external key manager associated with the external key store specified by the CustomKeyStoreId parameter. This key must be enabled and configured to perform encryption and decryption. Each KMS key in an external key store must use a different external key. For details, see Requirements for a KMS key in an external key store in the Key Management Service Developer Guide.
    
    Each KMS key in an external key store is associated two backing keys. One is key material that KMS generates. The other is the external key specified by this parameter. When you use the KMS key in an external key store to encrypt data, the encryption operation is performed first by KMS using the KMS key material, and then by the external key manager using the specified external key, a process known as double encryption. For details, see Double encryption in the Key Management Service Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.771

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

setXksKeyId

getXksKeyId

withXksKeyId

toString

equals

hashCode

clone