CreateHsmRequest (AWS SDK For Java for OSGi 1.10.43 API)

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

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable
```
public class CreateHsmRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Contains the inputs for the CreateHsm action.

See Also:
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
`CreateHsmRequest`	`clone()` Creates a shallow clone of this request.
`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 java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateHsmRequest
```
public CreateHsmRequest()
```
- Method Detail
  - setSubnetId
```
public void setSubnetId(String subnetId)
```
    The identifier of the subnet in your VPC in which to place the HSM.
    
    Parameters:
    subnetId - The identifier of the subnet in your VPC in which to place the HSM.
  - getSubnetId
```
public String getSubnetId()
```
    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.
  - withSubnetId
```
public CreateHsmRequest withSubnetId(String subnetId)
```
    The identifier of the subnet in your VPC in which to place the HSM.
    
    Parameters:
    subnetId - The identifier of the subnet in your VPC in which to place the HSM.
    
    Returns:
    Returns a reference to this object so that method calls can be chained together.
  - setSshKey
```
public void setSshKey(String sshKey)
```
    The SSH public key to install on the HSM.
    
    Parameters:
    sshKey - The SSH public key to install on the HSM.
  - getSshKey
```
public String getSshKey()
```
    The SSH public key to install on the HSM.
    
    Returns:
    The SSH public key to install on the HSM.
  - withSshKey
```
public CreateHsmRequest withSshKey(String sshKey)
```
    The SSH public key to install on the HSM.
    
    Parameters:
    sshKey - The SSH public key to install on the HSM.
    
    Returns:
    Returns a reference to this object so that method calls can be chained together.
  - setEniIp
```
public void setEniIp(String eniIp)
```
    The IP address to assign to the HSM's ENI.
    
    Parameters:
    eniIp - The IP address to assign to the HSM's ENI.
  - getEniIp
```
public String getEniIp()
```
    The IP address to assign to the HSM's ENI.
    
    Returns:
    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.
    
    Parameters:
    eniIp - The IP address to assign to the HSM's ENI.
    
    Returns:
    Returns a reference to this object so that method calls can be chained together.
  - 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.
    
    Parameters:
    iamRoleArn - The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
  - getIamRoleArn
```
public String getIamRoleArn()
```
    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.
  - 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.
    
    Parameters:
    iamRoleArn - The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
    
    Returns:
    Returns a reference to this object so that method calls can be chained together.
  - setExternalId
```
public void setExternalId(String externalId)
```
    The external ID from IamRoleArn, if present.
    
    Parameters:
    externalId - The external ID from IamRoleArn, if present.
  - getExternalId
```
public String getExternalId()
```
    The external ID from IamRoleArn, if present.
    
    Returns:
    The external ID from IamRoleArn, if present.
  - withExternalId
```
public CreateHsmRequest withExternalId(String externalId)
```
    The external ID from IamRoleArn, if present.
    
    Parameters:
    externalId - The external ID from IamRoleArn, if present.
    
    Returns:
    Returns a reference to this object so that method calls can be chained together.
  - setSubscriptionType
```
public void setSubscriptionType(String subscriptionType)
```
    The subscription type.
    
    Parameters:
    subscriptionType - The subscription type.
    See Also:
    SubscriptionType
  - getSubscriptionType
```
public String getSubscriptionType()
```
    The subscription type.
    
    Returns:
    The subscription type.
    See Also:
    SubscriptionType
  - withSubscriptionType
```
public CreateHsmRequest withSubscriptionType(String subscriptionType)
```
    The subscription type.
    
    Parameters:
    subscriptionType - The subscription type.
    
    Returns:
    Returns a reference to this object so that method calls can be chained together.
    See Also:
    SubscriptionType
  - setSubscriptionType
```
public void setSubscriptionType(SubscriptionType subscriptionType)
```
    The subscription type.
    
    Parameters:
    subscriptionType - The subscription type.
    See Also:
    SubscriptionType
  - withSubscriptionType
```
public CreateHsmRequest withSubscriptionType(SubscriptionType subscriptionType)
```
    The subscription type.
    
    Parameters:
    subscriptionType - The subscription type.
    
    Returns:
    Returns a reference to this object so that method calls can be chained together.
    See Also:
    SubscriptionType
  - 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.
    
    Parameters:
    clientToken - A user-defined token to ensure idempotence. Subsequent calls to this action with the same token will be ignored.
  - getClientToken
```
public String getClientToken()
```
    A user-defined token to ensure idempotence. Subsequent calls to this action with the same token will be ignored.
    
    Returns:
    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.
    
    Parameters:
    clientToken - A user-defined token to ensure idempotence. Subsequent calls to this action with the same token will be ignored.
    
    Returns:
    Returns a reference to this object so that method calls can be chained together.
  - setSyslogIp
```
public void setSyslogIp(String syslogIp)
```
    The IP address for the syslog monitoring server.
    
    Parameters:
    syslogIp - The IP address for the syslog monitoring server.
  - getSyslogIp
```
public String getSyslogIp()
```
    The IP address for the syslog monitoring server.
    
    Returns:
    The IP address for the syslog monitoring server.
  - withSyslogIp
```
public CreateHsmRequest withSyslogIp(String syslogIp)
```
    The IP address for the syslog monitoring server.
    
    Parameters:
    syslogIp - The IP address for the syslog monitoring server.
    
    Returns:
    Returns a reference to this 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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateHsmRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    Object.clone()

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

setSubnetId

getSubnetId

withSubnetId

setSshKey

getSshKey

withSshKey

setEniIp

getEniIp

withEniIp

setIamRoleArn

getIamRoleArn

withIamRoleArn

setExternalId

getExternalId

withExternalId

setSubscriptionType

getSubscriptionType

withSubscriptionType

setSubscriptionType

withSubscriptionType

setClientToken

getClientToken

withClientToken

setSyslogIp

getSyslogIp

withSyslogIp

toString

equals

hashCode

clone