Package software.amazon.awssdk.services.cloudhsm.model

Class CreateHsmRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudhsm.model.CloudHsmRequest

software.amazon.awssdk.services.cloudhsm.model.CreateHsmRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateHsmRequest.Builder,CreateHsmRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateHsmRequest
extends CloudHsmRequest
implements ToCopyableBuilder<CreateHsmRequest.Builder,CreateHsmRequest>

Contains the inputs for the CreateHsm operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateHsmRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateHsmRequest.Builder	builder()
String	clientToken()	A user-defined token to ensure idempotence.
String	eniIp()	The IP address to assign to the HSM's ENI.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	externalId()	The external ID from IamRoleArn, if present.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	iamRoleArn()	The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateHsmRequest.Builder>	serializableBuilderClass()
String	sshKey()	The SSH public key to install on the HSM.
String	subnetId()	The identifier of the subnet in your VPC in which to place the HSM.
SubscriptionType	subscriptionType()	Returns the value of the SubscriptionType property for this object.
String	subscriptionTypeAsString()	Returns the value of the SubscriptionType property for this object.
String	syslogIp()	The IP address for the syslog monitoring server.
CreateHsmRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

subnetId

public final String subnetId()

The identifier of the subnet in your VPC in which to place the HSM.

Returns:

The identifier of the subnet in your VPC in which to place the HSM.

sshKey

public final String sshKey()

The SSH public key to install on the HSM.

Returns:

The SSH public key to install on the HSM.

eniIp

public final String eniIp()

The IP address to assign to the HSM's ENI.

If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.

Returns:

The IP address to assign to the HSM's ENI.

If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.

iamRoleArn

public final String iamRoleArn()

The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.

Returns:

The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.

externalId

public final String externalId()

The external ID from IamRoleArn, if present.

Returns:

The external ID from IamRoleArn, if present.

subscriptionType

public final SubscriptionType subscriptionType()

Returns the value of the SubscriptionType property for this object.

If the service returns an enum value that is not available in the current SDK version, subscriptionType will return SubscriptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subscriptionTypeAsString().

Returns:

The value of the SubscriptionType property for this object.

See Also:

SubscriptionType

subscriptionTypeAsString

public final String subscriptionTypeAsString()

Returns the value of the SubscriptionType property for this object.

If the service returns an enum value that is not available in the current SDK version, subscriptionType will return SubscriptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from subscriptionTypeAsString().

Returns:

The value of the SubscriptionType property for this object.

See Also:

SubscriptionType

clientToken

public final String clientToken()

A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.

Returns:

A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.

syslogIp

public final String syslogIp()

The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

Returns:

The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

toBuilder

public CreateHsmRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateHsmRequest.Builder,CreateHsmRequest>

Specified by:

toBuilder in class CloudHsmRequest

builder

public static CreateHsmRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo