CreateKeyRequest (AWS SDK for Android

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class CreateKeyRequest
extends AmazonWebServiceRequest
implements Serializable
```
Creates a customer managed customer master key (CMK) in your AWS account.

You can use a CMK to encrypt small amounts of data (up to 4096 bytes) directly. But CMKs are more commonly used to encrypt the data keys that are used to encrypt data.

To create a CMK for imported key material, use the Origin parameter with a value of EXTERNAL.

To create a CMK in a custom key store, use the CustomKeyStoreId parameter to specify the custom key store. You must also use the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the AWS Region.

You cannot use this operation to create a CMK in a different AWS account.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateKeyRequest()

Constructors
Constructor and Description
`CreateKeyRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Boolean`	`getBypassPolicyLockoutSafetyCheck()` A flag to indicate whether to bypass the key policy lockout safety check.
`String`	`getCustomKeyStoreId()` Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster.
`String`	`getDescription()` A description of the CMK.
`String`	`getKeyUsage()` The cryptographic operations for which you can use the CMK.
`String`	`getOrigin()` The source of the key material for the CMK.
`String`	`getPolicy()` The key policy to attach to the CMK.
`List<Tag>`	`getTags()` One or more tags.
`int`	`hashCode()`
`Boolean`	`isBypassPolicyLockoutSafetyCheck()` A flag to indicate whether to bypass the key policy lockout safety check.
`void`	`setBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)` A flag to indicate whether to bypass the key policy lockout safety check.
`void`	`setCustomKeyStoreId(String customKeyStoreId)` Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster.
`void`	`setDescription(String description)` A description of the CMK.
`void`	`setKeyUsage(KeyUsageType keyUsage)` The cryptographic operations for which you can use the CMK.
`void`	`setKeyUsage(String keyUsage)` The cryptographic operations for which you can use the CMK.
`void`	`setOrigin(OriginType origin)` The source of the key material for the CMK.
`void`	`setOrigin(String origin)` The source of the key material for the CMK.
`void`	`setPolicy(String policy)` The key policy to attach to the CMK.
`void`	`setTags(Collection<Tag> tags)` One or more tags.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateKeyRequest`	`withBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)` A flag to indicate whether to bypass the key policy lockout safety check.
`CreateKeyRequest`	`withCustomKeyStoreId(String customKeyStoreId)` Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster.
`CreateKeyRequest`	`withDescription(String description)` A description of the CMK.
`CreateKeyRequest`	`withKeyUsage(KeyUsageType keyUsage)` The cryptographic operations for which you can use the CMK.
`CreateKeyRequest`	`withKeyUsage(String keyUsage)` The cryptographic operations for which you can use the CMK.
`CreateKeyRequest`	`withOrigin(OriginType origin)` The source of the key material for the CMK.
`CreateKeyRequest`	`withOrigin(String origin)` The source of the key material for the CMK.
`CreateKeyRequest`	`withPolicy(String policy)` The key policy to attach to the CMK.
`CreateKeyRequest`	`withTags(Collection<Tag> tags)` One or more tags.
`CreateKeyRequest`	`withTags(Tag... tags)` One or more tags.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - CreateKeyRequest
```
public CreateKeyRequest()
```
- Method Detail
  - getPolicy
```
public String getPolicy()
```
    The key policy to attach to the CMK.
    
    If you provide a key policy, it must meet the following criteria:
    - If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
    - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
    If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
    
    The key policy size limit is 32 kilobytes (32768 bytes).
    
    Constraints:
    Length: 1 - 131072
    Pattern: [ -ÿ]+
    Returns:
    The key policy to attach to the CMK.
    
    If you provide a key policy, it must meet the following criteria:
    
    If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
    
    Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
    
    If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
    
    The key policy size limit is 32 kilobytes (32768 bytes).
  - setPolicy
```
public void setPolicy(String policy)
```
    The key policy to attach to the CMK.
    
    If you provide a key policy, it must meet the following criteria:
    - If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
    - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
    If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
    
    The key policy size limit is 32 kilobytes (32768 bytes).
    
    Constraints:
    Length: 1 - 131072
    Pattern: [ -ÿ]+
    Parameters:
    policy -
    The key policy to attach to the CMK.
    
    If you provide a key policy, it must meet the following criteria:
    
    If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
    
    Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
    
    If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
    
    The key policy size limit is 32 kilobytes (32768 bytes).
  - withPolicy
```
public CreateKeyRequest withPolicy(String policy)
```
    The key policy to attach to the CMK.
    
    If you provide a key policy, it must meet the following criteria:
    - If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
    - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
    If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
    
    The key policy size limit is 32 kilobytes (32768 bytes).
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 131072
    Pattern: [ -ÿ]+
    Parameters:
    policy -
    The key policy to attach to the CMK.
    
    If you provide a key policy, it must meet the following criteria:
    
    If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .
    
    Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
    
    If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
    
    The key policy size limit is 32 kilobytes (32768 bytes).
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDescription
```
public String getDescription()
```
    A description of the CMK.
    
    Use a description that helps you decide whether the CMK is appropriate for a task.
    
    Constraints:
    Length: 0 - 8192
    
    Returns:
    
    A description of the CMK.
    
    Use a description that helps you decide whether the CMK is appropriate for a task.
  - setDescription
```
public void setDescription(String description)
```
    A description of the CMK.
    
    Use a description that helps you decide whether the CMK is appropriate for a task.
    
    Constraints:
    Length: 0 - 8192
    
    Parameters:
    
    description -
    A description of the CMK.
    
    Use a description that helps you decide whether the CMK is appropriate for a task.
  - withDescription
```
public CreateKeyRequest withDescription(String description)
```
    A description of the CMK.
    
    Use a description that helps you decide whether the CMK is appropriate for a task.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 8192
    
    Parameters:
    
    description -
    A description of the CMK.
    
    Use a description that helps you decide whether the CMK is appropriate for a task.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getKeyUsage
```
public String getKeyUsage()
```
    The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data.
    
    Constraints:
    Allowed Values: ENCRYPT_DECRYPT
    
    Returns:
    
    The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data.
    
    See Also:
    
    KeyUsageType
  - setKeyUsage
```
public void setKeyUsage(String keyUsage)
```
    The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data.
    
    Constraints:
    Allowed Values: ENCRYPT_DECRYPT
    
    Parameters:
    
    keyUsage -
    The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data.
    
    See Also:
    
    KeyUsageType
  - withKeyUsage
```
public CreateKeyRequest withKeyUsage(String keyUsage)
```
    The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ENCRYPT_DECRYPT
    
    Parameters:
    
    keyUsage -
    The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    KeyUsageType
  - setKeyUsage
```
public void setKeyUsage(KeyUsageType keyUsage)
```
    The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data.
    
    Constraints:
    Allowed Values: ENCRYPT_DECRYPT
    
    Parameters:
    
    keyUsage -
    The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data.
    
    See Also:
    
    KeyUsageType
  - withKeyUsage
```
public CreateKeyRequest withKeyUsage(KeyUsageType keyUsage)
```
    The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ENCRYPT_DECRYPT
    
    Parameters:
    
    keyUsage -
    The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    KeyUsageType
  - getOrigin
```
public String getOrigin()
```
    The source of the key material for the CMK. You cannot change the origin after you create the CMK.
    
    The default is AWS_KMS, which means AWS KMS creates the key material in its own key store.
    
    When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
    
    When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store.
    
    Constraints:
    Allowed Values: AWS_KMS, EXTERNAL, AWS_CLOUDHSM
    
    Returns:
    
    The source of the key material for the CMK. You cannot change the origin after you create the CMK.
    
    The default is AWS_KMS, which means AWS KMS creates the key material in its own key store.
    
    When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
    
    When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store.
    
    See Also:
    
    OriginType
  - setOrigin
```
public void setOrigin(String origin)
```
    The source of the key material for the CMK. You cannot change the origin after you create the CMK.
    
    The default is AWS_KMS, which means AWS KMS creates the key material in its own key store.
    
    When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
    
    When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store.
    
    Constraints:
    Allowed Values: AWS_KMS, EXTERNAL, AWS_CLOUDHSM
    
    Parameters:
    
    origin -
    The source of the key material for the CMK. You cannot change the origin after you create the CMK.
    
    The default is AWS_KMS, which means AWS KMS creates the key material in its own key store.
    
    When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
    
    When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store.
    
    See Also:
    
    OriginType
  - withOrigin
```
public CreateKeyRequest withOrigin(String origin)
```
    The source of the key material for the CMK. You cannot change the origin after you create the CMK.
    
    The default is AWS_KMS, which means AWS KMS creates the key material in its own key store.
    
    When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
    
    When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: AWS_KMS, EXTERNAL, AWS_CLOUDHSM
    
    Parameters:
    
    origin -
    The source of the key material for the CMK. You cannot change the origin after you create the CMK.
    
    The default is AWS_KMS, which means AWS KMS creates the key material in its own key store.
    
    When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
    
    When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    OriginType
  - setOrigin
```
public void setOrigin(OriginType origin)
```
    The source of the key material for the CMK. You cannot change the origin after you create the CMK.
    
    The default is AWS_KMS, which means AWS KMS creates the key material in its own key store.
    
    When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
    
    When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store.
    
    Constraints:
    Allowed Values: AWS_KMS, EXTERNAL, AWS_CLOUDHSM
    
    Parameters:
    
    origin -
    The source of the key material for the CMK. You cannot change the origin after you create the CMK.
    
    The default is AWS_KMS, which means AWS KMS creates the key material in its own key store.
    
    When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
    
    When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store.
    
    See Also:
    
    OriginType
  - withOrigin
```
public CreateKeyRequest withOrigin(OriginType origin)
```
    The source of the key material for the CMK. You cannot change the origin after you create the CMK.
    
    The default is AWS_KMS, which means AWS KMS creates the key material in its own key store.
    
    When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
    
    When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: AWS_KMS, EXTERNAL, AWS_CLOUDHSM
    
    Parameters:
    
    origin -
    The source of the key material for the CMK. You cannot change the origin after you create the CMK.
    
    The default is AWS_KMS, which means AWS KMS creates the key material in its own key store.
    
    When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
    
    When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    OriginType
  - getCustomKeyStoreId
```
public String getCustomKeyStoreId()
```
    Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
    
    To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
    
    The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
    
    Constraints:
    Length: 1 - 64
    
    Returns:
    
    Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
    
    To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
    
    The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
  - setCustomKeyStoreId
```
public void setCustomKeyStoreId(String customKeyStoreId)
```
    Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
    
    To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
    
    The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
    
    Constraints:
    Length: 1 - 64
    
    Parameters:
    
    customKeyStoreId -
    Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
    
    To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
    
    The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
  - withCustomKeyStoreId
```
public CreateKeyRequest withCustomKeyStoreId(String customKeyStoreId)
```
    Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
    
    To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
    
    The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    
    Parameters:
    
    customKeyStoreId -
    Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.
    
    To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
    
    The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
    
    This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isBypassPolicyLockoutSafetyCheck
```
public Boolean isBypassPolicyLockoutSafetyCheck()
```
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
    
    Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
    
    The default value is false.
    
    Returns:
    
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
    
    Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
    
    The default value is false.
  - getBypassPolicyLockoutSafetyCheck
```
public Boolean getBypassPolicyLockoutSafetyCheck()
```
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
    
    Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
    
    The default value is false.
    
    Returns:
    
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
    
    Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
    
    The default value is false.
  - setBypassPolicyLockoutSafetyCheck
```
public void setBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)
```
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
    
    Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
    
    The default value is false.
    
    Parameters:
    
    bypassPolicyLockoutSafetyCheck -
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
    
    Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
    
    The default value is false.
  - withBypassPolicyLockoutSafetyCheck
```
public CreateKeyRequest withBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)
```
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
    
    Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
    
    The default value is false.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    bypassPolicyLockoutSafetyCheck -
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .
    
    Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.
    
    The default value is false.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
    
    Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource.
    
    Returns:
    
    One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
    
    Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
    
    Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource.
    
    Parameters:
    
    tags -
    One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
    
    Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource.
  - withTags
```
public CreateKeyRequest withTags(Tag... tags)
```
    One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
    
    Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    tags -
    One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
    
    Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withTags
```
public CreateKeyRequest withTags(Collection<Tag> tags)
```
    One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
    
    Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    tags -
    One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
    
    Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class CreateKeyRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateKeyRequest

Method Detail

getPolicy

setPolicy

withPolicy

getDescription

setDescription

withDescription

getKeyUsage

setKeyUsage

withKeyUsage

setKeyUsage

withKeyUsage

getOrigin

setOrigin

withOrigin

setOrigin

withOrigin

getCustomKeyStoreId

setCustomKeyStoreId

withCustomKeyStoreId

isBypassPolicyLockoutSafetyCheck

getBypassPolicyLockoutSafetyCheck

setBypassPolicyLockoutSafetyCheck

withBypassPolicyLockoutSafetyCheck

getTags

setTags

withTags

withTags

toString

hashCode

equals