java.lang.Object
software.amazon.awssdk.services.fsx.model.Alias
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Alias.Builder,Alias>

@Generated("software.amazon.awssdk:codegen") public final class Alias extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Alias.Builder,Alias>

A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the FSx for Windows File Server User Guide.

See Also:
  • Method Details

    • name

      public final String name()

      The name of the DNS alias. The alias name has to meet the following requirements:

      • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

      • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

      • Cannot start or end with a hyphen.

      • Can start with a numeric.

      For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

      Returns:
      The name of the DNS alias. The alias name has to meet the following requirements:

      • Formatted as a fully-qualified domain name (FQDN), hostname.domain, for example, accounting.example.com.

      • Can contain alphanumeric characters, the underscore (_), and the hyphen (-).

      • Cannot start or end with a hyphen.

      • Can start with a numeric.

      For DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

    • lifecycle

      public final AliasLifecycle lifecycle()

      Describes the state of the DNS alias.

      • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

      • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

      • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

      • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

      • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

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

      Returns:
      Describes the state of the DNS alias.

      • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

      • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

      • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

      • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

      • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

      See Also:
    • lifecycleAsString

      public final String lifecycleAsString()

      Describes the state of the DNS alias.

      • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

      • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

      • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

      • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

      • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

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

      Returns:
      Describes the state of the DNS alias.

      • AVAILABLE - The DNS alias is associated with an Amazon FSx file system.

      • CREATING - Amazon FSx is creating the DNS alias and associating it with the file system.

      • CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.

      • DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.

      • DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system.

      See Also:
    • toBuilder

      public Alias.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<Alias.Builder,Alias>
      Returns:
      a builder for type T
    • builder

      public static Alias.Builder builder()
    • serializableBuilderClass

      public static Class<? extends Alias.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • 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)
    • 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.