software.amazon.awssdk.services.kms.model

Class CreateCustomKeyStoreRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kms.model.KmsRequest

software.amazon.awssdk.services.kms.model.CreateCustomKeyStoreRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateCustomKeyStoreRequest.Builder,CreateCustomKeyStoreRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateCustomKeyStoreRequest
extends KmsRequest
implements ToCopyableBuilder<CreateCustomKeyStoreRequest.Builder,CreateCustomKeyStoreRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateCustomKeyStoreRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateCustomKeyStoreRequest.Builder	builder()
String	cloudHsmClusterId() Identifies the AWS CloudHSM cluster for the custom key store.
String	customKeyStoreName() Specifies a friendly name for the custom key store.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	keyStorePassword() Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateCustomKeyStoreRequest.Builder>	serializableBuilderClass()
CreateCustomKeyStoreRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	trustAnchorCertificate() Enter the content of the trust anchor certificate for the cluster.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

customKeyStoreName

public String customKeyStoreName()

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

Returns:

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

cloudHsmClusterId

public 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:

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.

trustAnchorCertificate

public 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:

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.

keyStorePassword

public 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.

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

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.

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

toBuilder

public CreateCustomKeyStoreRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCustomKeyStoreRequest.Builder,CreateCustomKeyStoreRequest>

Specified by:

toBuilder in class KmsRequest

Returns:

a builder for type T

builder

public static CreateCustomKeyStoreRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateCustomKeyStoreRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.