Package software.amazon.awssdk.services.fsx.model

Class Alias

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Alias.Builder

Method Summary

Modifier and Type	Method	Description
static Alias.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
AliasLifecycle	lifecycle()	Describes the state of the DNS alias.
String	lifecycleAsString()	Describes the state of the DNS alias.
String	name()	The name of the DNS alias.
List<SdkField<?>>	sdkFields()
static Class<? extends Alias.Builder>	serializableBuilderClass()
Alias.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

AliasLifecycle

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:

AliasLifecycle

toBuilder

public Alias.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Alias.Builder,Alias>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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