CreateHsmRequest (AWS Java SDK for the AWS CloudHSM 1.9.16 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cloudhsm.model.CreateHsmRequest

All Implemented Interfaces:

Serializable
```
public class CreateHsmRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the CreateHsm operation.
Creates an uninitialized HSM instance. Running this command provisions an HSM appliance and will result in charges to your AWS account for the HSM.

See Also:
AWSCloudHSM.createHsm(CreateHsmRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateHsmRequest()

Constructors
Constructor and Description
`CreateHsmRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getClientToken()` A user-defined token to ensure idempotence.
`String`	`getEniIp()` The IP address to assign to the HSM's ENI.
`String`	`getExternalId()` The external ID from IamRoleArn, if present.
`String`	`getIamRoleArn()` The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
`String`	`getSshKey()` The SSH public key to install on the HSM.
`String`	`getSubnetId()` The identifier of the subnet in your VPC in which to place the HSM.
`String`	`getSubscriptionType()` The subscription type.
`String`	`getSyslogIp()` The IP address for the syslog monitoring server.
`int`	`hashCode()`
`void`	`setClientToken(String clientToken)` A user-defined token to ensure idempotence.
`void`	`setEniIp(String eniIp)` The IP address to assign to the HSM's ENI.
`void`	`setExternalId(String externalId)` The external ID from IamRoleArn, if present.
`void`	`setIamRoleArn(String iamRoleArn)` The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
`void`	`setSshKey(String sshKey)` The SSH public key to install on the HSM.
`void`	`setSubnetId(String subnetId)` The identifier of the subnet in your VPC in which to place the HSM.
`void`	`setSubscriptionType(String subscriptionType)` The subscription type.
`void`	`setSubscriptionType(SubscriptionType subscriptionType)` The subscription type.
`void`	`setSyslogIp(String syslogIp)` The IP address for the syslog monitoring server.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateHsmRequest`	`withClientToken(String clientToken)` A user-defined token to ensure idempotence.
`CreateHsmRequest`	`withEniIp(String eniIp)` The IP address to assign to the HSM's ENI.
`CreateHsmRequest`	`withExternalId(String externalId)` The external ID from IamRoleArn, if present.
`CreateHsmRequest`	`withIamRoleArn(String iamRoleArn)` The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
`CreateHsmRequest`	`withSshKey(String sshKey)` The SSH public key to install on the HSM.
`CreateHsmRequest`	`withSubnetId(String subnetId)` The identifier of the subnet in your VPC in which to place the HSM.
`CreateHsmRequest`	`withSubscriptionType(String subscriptionType)` The subscription type.
`CreateHsmRequest`	`withSubscriptionType(SubscriptionType subscriptionType)` The subscription type.
`CreateHsmRequest`	`withSyslogIp(String syslogIp)` The IP address for the syslog monitoring server.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - CreateHsmRequest
```
public CreateHsmRequest()
```
- Method Detail
  - getSubnetId
```
public String getSubnetId()
```
    The identifier of the subnet in your VPC in which to place the HSM.
    Constraints:
    Pattern: subnet-[0-9a-f]{8}
    
    Returns:
    The identifier of the subnet in your VPC in which to place the HSM.
  - setSubnetId
```
public void setSubnetId(String subnetId)
```
    The identifier of the subnet in your VPC in which to place the HSM.
    Constraints:
    Pattern: subnet-[0-9a-f]{8}
    
    Parameters:
    subnetId - The identifier of the subnet in your VPC in which to place the HSM.
  - withSubnetId
```
public CreateHsmRequest withSubnetId(String subnetId)
```
    The identifier of the subnet in your VPC in which to place the HSM.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: subnet-[0-9a-f]{8}
    
    Parameters:
    subnetId - The identifier of the subnet in your VPC in which to place the HSM.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSshKey
```
public String getSshKey()
```
    The SSH public key to install on the HSM.
    Constraints:
    Pattern: [a-zA-Z0-9+/= ._:\\@-]*
    
    Returns:
    The SSH public key to install on the HSM.
  - setSshKey
```
public void setSshKey(String sshKey)
```
    The SSH public key to install on the HSM.
    Constraints:
    Pattern: [a-zA-Z0-9+/= ._:\\@-]*
    
    Parameters:
    sshKey - The SSH public key to install on the HSM.
  - withSshKey
```
public CreateHsmRequest withSshKey(String sshKey)
```
    The SSH public key to install on the HSM.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: [a-zA-Z0-9+/= ._:\\@-]*
    
    Parameters:
    sshKey - The SSH public key to install on the HSM.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getEniIp
```
public String getEniIp()
```
    The IP address to assign to the HSM's ENI.
    Constraints:
    Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}
    
    Returns:
    The IP address to assign to the HSM's ENI.
  - setEniIp
```
public void setEniIp(String eniIp)
```
    The IP address to assign to the HSM's ENI.
    Constraints:
    Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}
    
    Parameters:
    eniIp - The IP address to assign to the HSM's ENI.
  - withEniIp
```
public CreateHsmRequest withEniIp(String eniIp)
```
    The IP address to assign to the HSM's ENI.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}
    
    Parameters:
    eniIp - The IP address to assign to the HSM's ENI.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getIamRoleArn
```
public String getIamRoleArn()
```
    The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
    Constraints:
    Pattern: arn:aws(-iso)?:iam::[0-9]{12}:role/[a-zA-Z0-9_\+=,\.\-@]{1,64}
    
    Returns:
    The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
  - setIamRoleArn
```
public void setIamRoleArn(String iamRoleArn)
```
    The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
    Constraints:
    Pattern: arn:aws(-iso)?:iam::[0-9]{12}:role/[a-zA-Z0-9_\+=,\.\-@]{1,64}
    
    Parameters:
    iamRoleArn - The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
  - withIamRoleArn
```
public CreateHsmRequest withIamRoleArn(String iamRoleArn)
```
    The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: arn:aws(-iso)?:iam::[0-9]{12}:role/[a-zA-Z0-9_\+=,\.\-@]{1,64}
    
    Parameters:
    iamRoleArn - The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getExternalId
```
public String getExternalId()
```
    The external ID from IamRoleArn, if present.
    Constraints:
    Pattern: [\w :+=./-]*
    
    Returns:
    The external ID from IamRoleArn, if present.
  - setExternalId
```
public void setExternalId(String externalId)
```
    The external ID from IamRoleArn, if present.
    Constraints:
    Pattern: [\w :+=./-]*
    
    Parameters:
    externalId - The external ID from IamRoleArn, if present.
  - withExternalId
```
public CreateHsmRequest withExternalId(String externalId)
```
    The external ID from IamRoleArn, if present.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: [\w :+=./-]*
    
    Parameters:
    externalId - The external ID from IamRoleArn, if present.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSubscriptionType
```
public String getSubscriptionType()
```
    The subscription type.
    Constraints:
    Allowed Values: PRODUCTION
    
    Returns:
    The subscription type.
    See Also:
    SubscriptionType
  - setSubscriptionType
```
public void setSubscriptionType(String subscriptionType)
```
    The subscription type.
    Constraints:
    Allowed Values: PRODUCTION
    
    Parameters:
    subscriptionType - The subscription type.
    See Also:
    SubscriptionType
  - withSubscriptionType
```
public CreateHsmRequest withSubscriptionType(String subscriptionType)
```
    The subscription type.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: PRODUCTION
    
    Parameters:
    subscriptionType - The subscription type.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    SubscriptionType
  - setSubscriptionType
```
public void setSubscriptionType(SubscriptionType subscriptionType)
```
    The subscription type.
    Constraints:
    Allowed Values: PRODUCTION
    
    Parameters:
    subscriptionType - The subscription type.
    See Also:
    SubscriptionType
  - withSubscriptionType
```
public CreateHsmRequest withSubscriptionType(SubscriptionType subscriptionType)
```
    The subscription type.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: PRODUCTION
    
    Parameters:
    subscriptionType - The subscription type.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    SubscriptionType
  - getClientToken
```
public String getClientToken()
```
    A user-defined token to ensure idempotence. Subsequent calls to this action with the same token will be ignored.
    Constraints:
    Pattern: [a-zA-Z0-9]{1,64}
    
    Returns:
    A user-defined token to ensure idempotence. Subsequent calls to this action with the same token will be ignored.
  - setClientToken
```
public void setClientToken(String clientToken)
```
    A user-defined token to ensure idempotence. Subsequent calls to this action with the same token will be ignored.
    Constraints:
    Pattern: [a-zA-Z0-9]{1,64}
    
    Parameters:
    clientToken - A user-defined token to ensure idempotence. Subsequent calls to this action with the same token will be ignored.
  - withClientToken
```
public CreateHsmRequest withClientToken(String clientToken)
```
    A user-defined token to ensure idempotence. Subsequent calls to this action with the same token will be ignored.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: [a-zA-Z0-9]{1,64}
    
    Parameters:
    clientToken - A user-defined token to ensure idempotence. Subsequent calls to this action with the same token will be ignored.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSyslogIp
```
public String getSyslogIp()
```
    The IP address for the syslog monitoring server.
    Constraints:
    Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}
    
    Returns:
    The IP address for the syslog monitoring server.
  - setSyslogIp
```
public void setSyslogIp(String syslogIp)
```
    The IP address for the syslog monitoring server.
    Constraints:
    Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}
    
    Parameters:
    syslogIp - The IP address for the syslog monitoring server.
  - withSyslogIp
```
public CreateHsmRequest withSyslogIp(String syslogIp)
```
    The IP address for the syslog monitoring server.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}
    
    Parameters:
    syslogIp - The IP address for the syslog monitoring server.
    
    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 CreateHsmRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateHsmRequest

Method Detail

getSubnetId

setSubnetId

withSubnetId

getSshKey

setSshKey

withSshKey

getEniIp

setEniIp

withEniIp

getIamRoleArn

setIamRoleArn

withIamRoleArn

getExternalId

setExternalId

withExternalId

getSubscriptionType

setSubscriptionType

withSubscriptionType

setSubscriptionType

withSubscriptionType

getClientToken

setClientToken

withClientToken

getSyslogIp

setSyslogIp

withSyslogIp

toString

hashCode

equals