CreateHsmRequest (AWS SDK for Java

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(value="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 and Description

static interface CreateHsmRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateHsmRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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)`
`String`	`externalId()` The external ID from `IamRoleArn`, if present.
`<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`	`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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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
  - subnetId
```
public 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 String sshKey()
```
    The SSH public key to install on the HSM.
    
    Returns:
    
    The SSH public key to install on the HSM.
  - eniIp
```
public 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 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 String externalId()
```
    The external ID from IamRoleArn, if present.
    
    Returns:
    
    The external ID from IamRoleArn, if present.
  - subscriptionType
```
public 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 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 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 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()
```
    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<CreateHsmRequest.Builder,CreateHsmRequest>
    
    Specified by:
    
    toBuilder in class CloudHsmRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateHsmRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateHsmRequest.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.

Class CreateHsmRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

subnetId

sshKey

eniIp

iamRoleArn

externalId

subscriptionType

subscriptionTypeAsString

clientToken

syslogIp

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields