Alias (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.fsx.model.Alias

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Alias
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Alias()

Constructors
Constructor and Description
`Alias()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Alias`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getLifecycle()` Describes the state of the DNS alias.
`String`	`getName()` The name of the DNS alias.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setLifecycle(String lifecycle)` Describes the state of the DNS alias.
`void`	`setName(String name)` The name of the DNS alias.
`String`	`toString()` Returns a string representation of this object.
`Alias`	`withLifecycle(AliasLifecycle lifecycle)` Describes the state of the DNS alias.
`Alias`	`withLifecycle(String lifecycle)` Describes the state of the DNS alias.
`Alias`	`withName(String name)` The name of the DNS alias.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Alias
```
public Alias()
```
- Method Detail
  - setName
```
public void setName(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.
    Parameters:
    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.
  - getName
```
public String getName()
```
    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.
  - withName
```
public Alias withName(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLifecycle
```
public void setLifecycle(String 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.
    Parameters:
    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.
    See Also:
    
    AliasLifecycle
  - getLifecycle
```
public String getLifecycle()
```
    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.
    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
  - withLifecycle
```
public Alias withLifecycle(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AliasLifecycle
  - withLifecycle
```
public Alias withLifecycle(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AliasLifecycle
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Alias clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class Alias

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Alias

Method Detail

setName

getName

withName

setLifecycle

getLifecycle

withLifecycle

withLifecycle

toString

equals

hashCode

clone

marshall