Class Alias
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Alias.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final AliasLifecycle
Describes the state of the DNS alias.final String
Describes the state of the DNS alias.final String
name()
The name of the DNS alias.static Class
<? extends Alias.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 returnAliasLifecycle.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlifecycleAsString()
.- 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
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 returnAliasLifecycle.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlifecycleAsString()
.- 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
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 interfaceToCopyableBuilder<Alias.Builder,
Alias> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-