Class: Aws::FSx::Types::Alias

Inherits:

Struct

Object
Struct
Aws::FSx::Types::Alias

show all

Includes:: Structure

Defined in:: lib/aws-sdk-fsx/types.rb

Overview

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*.

[1]: docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#lifecycle ⇒ String

Describes the state of the DNS alias.
#name ⇒ String

The name of the DNS alias.

Instance Attribute Details

#lifecycle ⇒ `String`

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:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 299

class Alias < Struct.new(
  :name,
  :lifecycle)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

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.