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.

  • Method Details

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

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

    • 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()
      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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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