Class CreateClusterRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudhsmv2.model.CloudHsmV2Request
software.amazon.awssdk.services.cloudhsmv2.model.CreateClusterRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateClusterRequest extends CloudHsmV2Request implements ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

  • Method Details

    • backupRetentionPolicy

      public final BackupRetentionPolicy backupRetentionPolicy()

      A policy that defines how the service retains backups.

      Returns:
      A policy that defines how the service retains backups.

    • hsmType

      public final String hsmType()

      The type of HSM to use in the cluster. The allowed values are hsm1.medium and hsm2m.medium.

      Returns:
      The type of HSM to use in the cluster. The allowed values are hsm1.medium and hsm2m.medium.

    • sourceBackupId

      public final String sourceBackupId()

      The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID or ARN, use DescribeBackups. If using a backup in another account, the full ARN must be supplied.

      Returns:
      The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID or ARN, use DescribeBackups. If using a backup in another account, the full ARN must be supplied.

    • hasSubnetIds

      public final boolean hasSubnetIds()
      For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • subnetIds

      public final List<String> subnetIds()

      The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria:

      • All subnets must be in the same virtual private cloud (VPC).

      • You can specify only one subnet per Availability Zone.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnetIds() method.

      Returns:
      The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria:

      • All subnets must be in the same virtual private cloud (VPC).

      • You can specify only one subnet per Availability Zone.

    • networkType

      public final NetworkType networkType()

      The NetworkType to create a cluster with. The allowed values are IPV4 and DUALSTACK.

      If the service returns an enum value that is not available in the current SDK version, networkType will return NetworkType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from networkTypeAsString().

      Returns:
      The NetworkType to create a cluster with. The allowed values are IPV4 and DUALSTACK.
      See Also:

    • networkTypeAsString

      public final String networkTypeAsString()

      The NetworkType to create a cluster with. The allowed values are IPV4 and DUALSTACK.

      If the service returns an enum value that is not available in the current SDK version, networkType will return NetworkType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from networkTypeAsString().

      Returns:
      The NetworkType to create a cluster with. The allowed values are IPV4 and DUALSTACK.
      See Also:

    • hasTagList

      public final boolean hasTagList()
      For responses, this returns true if the service returned a value for the TagList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tagList

      public final List<Tag> tagList()

      Tags to apply to the CloudHSM cluster during creation.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagList() method.

      Returns:
      Tags to apply to the CloudHSM cluster during creation.

    • mode

      public final ClusterMode mode()

      The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.

      If the service returns an enum value that is not available in the current SDK version, mode will return ClusterMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

      Returns:
      The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.
      See Also:

    • modeAsString

      public final String modeAsString()

      The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.

      If the service returns an enum value that is not available in the current SDK version, mode will return ClusterMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

      Returns:
      The mode to use in the cluster. The allowed values are FIPS and NON_FIPS.
      See Also:

    • toBuilder

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

    • builder

      public static CreateClusterRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.