com.amazonaws.services.kms.model

Class CreateCustomKeyStoreRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.CreateCustomKeyStoreRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreateCustomKeyStoreRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Creates a custom key store that is associated with an AWS CloudHSM cluster that you own and manage.

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.

Before you create the custom key store, you must assemble the required elements, including an AWS CloudHSM cluster that fulfills the requirements for a custom key store. For details about the required elements, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide.

When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its AWS CloudHSM cluster. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it.

For help with failures, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

Required permissions: kms:CreateCustomKeyStore (IAM policy).

Related operations:

• ConnectCustomKeyStore

• DeleteCustomKeyStore

• DescribeCustomKeyStores

• DisconnectCustomKeyStore

• UpdateCustomKeyStore

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateCustomKeyStoreRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getCloudHsmClusterId() Identifies the AWS CloudHSM cluster for the custom key store.
java.lang.String	getCustomKeyStoreName() Specifies a friendly name for the custom key store.
java.lang.String	getKeyStorePassword() Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster.
java.lang.String	getTrustAnchorCertificate() Enter the content of the trust anchor certificate for the cluster.
int	hashCode()
void	setCloudHsmClusterId(java.lang.String cloudHsmClusterId) Identifies the AWS CloudHSM cluster for the custom key store.
void	setCustomKeyStoreName(java.lang.String customKeyStoreName) Specifies a friendly name for the custom key store.
void	setKeyStorePassword(java.lang.String keyStorePassword) Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster.
void	setTrustAnchorCertificate(java.lang.String trustAnchorCertificate) Enter the content of the trust anchor certificate for the cluster.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateCustomKeyStoreRequest	withCloudHsmClusterId(java.lang.String cloudHsmClusterId) Identifies the AWS CloudHSM cluster for the custom key store.
CreateCustomKeyStoreRequest	withCustomKeyStoreName(java.lang.String customKeyStoreName) Specifies a friendly name for the custom key store.
CreateCustomKeyStoreRequest	withKeyStorePassword(java.lang.String keyStorePassword) Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster.
CreateCustomKeyStoreRequest	withTrustAnchorCertificate(java.lang.String trustAnchorCertificate) Enter the content of the trust anchor certificate for the cluster.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateCustomKeyStoreRequest

public CreateCustomKeyStoreRequest()

Method Detail

getCustomKeyStoreName

public java.lang.String getCustomKeyStoreName()

Specifies a friendly name for the custom key store. The name must be unique in your AWS account.

Constraints:
Length: 1 - 256

Returns:

Specifies a friendly name for the custom key store. The name must be unique in your AWS account.

setCustomKeyStoreName

public void setCustomKeyStoreName(java.lang.String customKeyStoreName)

Specifies a friendly name for the custom key store. The name must be unique in your AWS account.

Constraints:
Length: 1 - 256

Parameters:

customKeyStoreName -

Specifies a friendly name for the custom key store. The name must be unique in your AWS account.

withCustomKeyStoreName

public CreateCustomKeyStoreRequest withCustomKeyStoreName(java.lang.String customKeyStoreName)

Specifies a friendly name for the custom key store. The name must be unique in your AWS account.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256

Parameters:

customKeyStoreName -

Specifies a friendly name for the custom key store. The name must be unique in your AWS account.

Returns:

A reference to this updated object so that method calls can be chained together.

getCloudHsmClusterId

public java.lang.String getCloudHsmClusterId()

Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.

Constraints:
Length: 19 - 24

Returns:

Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.

setCloudHsmClusterId

public void setCloudHsmClusterId(java.lang.String cloudHsmClusterId)

Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.

Constraints:
Length: 19 - 24

Parameters:

cloudHsmClusterId -

Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.

withCloudHsmClusterId

public CreateCustomKeyStoreRequest withCloudHsmClusterId(java.lang.String cloudHsmClusterId)

Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 19 - 24

Parameters:

cloudHsmClusterId -

Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.

Returns:

A reference to this updated object so that method calls can be chained together.

getTrustAnchorCertificate

public java.lang.String getTrustAnchorCertificate()

Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.

Constraints:
Length: 1 - 5000

Returns:

Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.

setTrustAnchorCertificate

public void setTrustAnchorCertificate(java.lang.String trustAnchorCertificate)

Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.

Constraints:
Length: 1 - 5000

Parameters:

trustAnchorCertificate -

Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.

withTrustAnchorCertificate

public CreateCustomKeyStoreRequest withTrustAnchorCertificate(java.lang.String trustAnchorCertificate)

Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 5000

Parameters:

trustAnchorCertificate -

Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.

Returns:

A reference to this updated object so that method calls can be chained together.

getKeyStorePassword

public java.lang.String getKeyStorePassword()

Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.

The password must be a string of 7 to 32 characters. Its value is case sensitive.

This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.

Constraints:
Length: 7 - 32

Returns:

Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.

The password must be a string of 7 to 32 characters. Its value is case sensitive.

This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.

setKeyStorePassword

public void setKeyStorePassword(java.lang.String keyStorePassword)

Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.

The password must be a string of 7 to 32 characters. Its value is case sensitive.

This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.

Constraints:
Length: 7 - 32

Parameters:

keyStorePassword -

Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.

The password must be a string of 7 to 32 characters. Its value is case sensitive.

This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.

withKeyStorePassword

public CreateCustomKeyStoreRequest withKeyStorePassword(java.lang.String keyStorePassword)

Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.

The password must be a string of 7 to 32 characters. Its value is case sensitive.

This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 7 - 32

Parameters:

keyStorePassword -

Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.

The password must be a string of 7 to 32 characters. Its value is case sensitive.

This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object