Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.FSx.Types.Alias

Description

Synopsis

data Alias = Alias' {
- lifecycle :: Maybe AliasLifecycle
- name :: Maybe Text
}
newAlias :: Alias
alias_lifecycle :: Lens' Alias (Maybe AliasLifecycle)
alias_name :: Lens' Alias (Maybe Text)

Documentation

data Alias Source #

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: newAlias smart constructor.

Constructors

Alias'

Fields

lifecycle :: Maybe AliasLifecycle
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.
name :: Maybe Text
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.

Instances

Instances details

FromJSON Alias Source #
Instance details Defined in Amazonka.FSx.Types.Alias Methods parseJSON :: Value -> Parser Alias # parseJSONList :: Value -> Parser [Alias] #
Generic Alias Source #
Instance details Defined in Amazonka.FSx.Types.Alias Associated Types type Rep Alias :: Type -> Type # Methods from :: Alias -> Rep Alias x # to :: Rep Alias x -> Alias #
Read Alias Source #
Instance details Defined in Amazonka.FSx.Types.Alias Methods readsPrec :: Int -> ReadS Alias # readList :: ReadS [Alias] # readPrec :: ReadPrec Alias # readListPrec :: ReadPrec [Alias] #
Show Alias Source #
Instance details Defined in Amazonka.FSx.Types.Alias Methods showsPrec :: Int -> Alias -> ShowS # show :: Alias -> String # showList :: [Alias] -> ShowS #
NFData Alias Source #
Instance details Defined in Amazonka.FSx.Types.Alias Methods rnf :: Alias -> () #
Eq Alias Source #
Instance details Defined in Amazonka.FSx.Types.Alias Methods (==) :: Alias -> Alias -> Bool # (/=) :: Alias -> Alias -> Bool #
Hashable Alias Source #
Instance details Defined in Amazonka.FSx.Types.Alias Methods hashWithSalt :: Int -> Alias -> Int # hash :: Alias -> Int #
type Rep Alias Source #
Instance details Defined in Amazonka.FSx.Types.Alias type Rep Alias = D1 ('MetaData "Alias" "Amazonka.FSx.Types.Alias" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "Alias'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lifecycle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AliasLifecycle)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newAlias :: Alias Source #

Create a value of Alias with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:lifecycle:Alias', alias_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.

$sel:name:Alias', alias_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.

alias_lifecycle :: Lens' Alias (Maybe AliasLifecycle) Source #

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.

alias_name :: Lens' Alias (Maybe Text) Source #

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.