Package software.amazon.awssdk.services.cloudhsm.model

Class ModifyHsmRequest

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.ModifyHsmRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ModifyHsmRequest.Builder,ModifyHsmRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyHsmRequest extends CloudHsmRequest implements ToCopyableBuilder<ModifyHsmRequest.Builder,ModifyHsmRequest>

Contains the inputs for the ModifyHsm operation.

  • Method Details

    • hsmArn

      public final String hsmArn()

      The ARN of the HSM to modify.

      Returns:
      The ARN of the HSM to modify.

    • subnetId

      public final String subnetId()

      The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.

      Returns:
      The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.

    • eniIp

      public final String eniIp()

      The new IP address for the elastic network interface (ENI) attached to the HSM.

      If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.

      Returns:
      The new IP address for the elastic network interface (ENI) attached to the HSM.

      If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.

    • iamRoleArn

      public final String iamRoleArn()

      The new IAM role ARN.

      Returns:
      The new IAM role ARN.

    • externalId

      public final String externalId()

      The new external ID.

      Returns:
      The new external ID.

    • syslogIp

      public final String syslogIp()

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

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

    • toBuilder

      public ModifyHsmRequest.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<ModifyHsmRequest.Builder,ModifyHsmRequest>
      Specified by:
      toBuilder in class CloudHsmRequest
      Returns:
      a builder for type T

    • builder

      public static ModifyHsmRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModifyHsmRequest.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.