Class CreateHsmRequest

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

See Also:
  • Constructor Details

    • CreateHsmRequest

      public CreateHsmRequest()
  • Method Details

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

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

      Parameters:
      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.

    • getEniIp

      public String getEniIp()

      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.

    • withEniIp

      public CreateHsmRequest withEniIp(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.

      Parameters:
      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:
      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)
      Parameters:
      subscriptionType -
      See Also:
    • getSubscriptionType

      public String getSubscriptionType()
      Returns:
      See Also:
    • withSubscriptionType

      public CreateHsmRequest withSubscriptionType(String subscriptionType)
      Parameters:
      subscriptionType -
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setSubscriptionType

      public void setSubscriptionType(SubscriptionType subscriptionType)
      Parameters:
      subscriptionType -
      See Also:
    • withSubscriptionType

      public CreateHsmRequest withSubscriptionType(SubscriptionType subscriptionType)
      Parameters:
      subscriptionType -
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setClientToken

      public void setClientToken(String clientToken)

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

      Parameters:
      clientToken - A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.
    • getClientToken

      public String getClientToken()

      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.
    • withClientToken

      public CreateHsmRequest withClientToken(String clientToken)

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

      Parameters:
      clientToken - A user-defined token to ensure idempotence. Subsequent calls to this operation 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. The AWS CloudHSM service only supports one syslog monitoring server.

      Parameters:
      syslogIp - The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
    • getSyslogIp

      public String getSyslogIp()

      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.
    • withSyslogIp

      public CreateHsmRequest withSyslogIp(String syslogIp)

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

      Parameters:
      syslogIp - The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one 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:
    • 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: