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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. A file system can have a maximum of 50 DNS aliases associated with it at any one time. If you try to associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system, including additional steps you must take to be able to access your file system using a DNS alias.

The system response shows the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system.

Synopsis

data AssociateFileSystemAliases = AssociateFileSystemAliases' {
- clientRequestToken :: Maybe Text
- fileSystemId :: Text
- aliases :: [Text]
}
newAssociateFileSystemAliases :: Text -> AssociateFileSystemAliases
associateFileSystemAliases_clientRequestToken :: Lens' AssociateFileSystemAliases (Maybe Text)
associateFileSystemAliases_fileSystemId :: Lens' AssociateFileSystemAliases Text
associateFileSystemAliases_aliases :: Lens' AssociateFileSystemAliases [Text]
data AssociateFileSystemAliasesResponse = AssociateFileSystemAliasesResponse' {
- aliases :: Maybe [Alias]
- httpStatus :: Int
}
newAssociateFileSystemAliasesResponse :: Int -> AssociateFileSystemAliasesResponse
associateFileSystemAliasesResponse_aliases :: Lens' AssociateFileSystemAliasesResponse (Maybe [Alias])
associateFileSystemAliasesResponse_httpStatus :: Lens' AssociateFileSystemAliasesResponse Int

Creating a Request

data AssociateFileSystemAliases Source #

The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File Server file system.

See: newAssociateFileSystemAliases smart constructor.

Constructors

AssociateFileSystemAliases'

Fields

clientRequestToken :: Maybe Text
fileSystemId :: Text
Specifies the file system with which you want to associate one or more DNS aliases.
aliases :: [Text]
An array of one or more DNS alias names to associate with the file system. The alias name has to comply with the following formatting requirements:
- Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.corp.example.com.
- Can contain alphanumeric characters and the hyphen (-).
- Cannot start or end with a hyphen.
- Can start with a numeric.
For DNS alias 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

ToJSON AssociateFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.AssociateFileSystemAliases Methods toJSON :: AssociateFileSystemAliases -> Value # toEncoding :: AssociateFileSystemAliases -> Encoding # toJSONList :: [AssociateFileSystemAliases] -> Value # toEncodingList :: [AssociateFileSystemAliases] -> Encoding #
ToHeaders AssociateFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.AssociateFileSystemAliases Methods toHeaders :: AssociateFileSystemAliases -> [Header] #
ToPath AssociateFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.AssociateFileSystemAliases Methods toPath :: AssociateFileSystemAliases -> ByteString #
ToQuery AssociateFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.AssociateFileSystemAliases Methods toQuery :: AssociateFileSystemAliases -> QueryString #
AWSRequest AssociateFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.AssociateFileSystemAliases Associated Types type AWSResponse AssociateFileSystemAliases # Methods request :: (Service -> Service) -> AssociateFileSystemAliases -> Request AssociateFileSystemAliases # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AssociateFileSystemAliases -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssociateFileSystemAliases))) #
Generic AssociateFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.AssociateFileSystemAliases Associated Types type Rep AssociateFileSystemAliases :: Type -> Type # Methods from :: AssociateFileSystemAliases -> Rep AssociateFileSystemAliases x # to :: Rep AssociateFileSystemAliases x -> AssociateFileSystemAliases #
Read AssociateFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.AssociateFileSystemAliases Methods readsPrec :: Int -> ReadS AssociateFileSystemAliases # readList :: ReadS [AssociateFileSystemAliases] # readPrec :: ReadPrec AssociateFileSystemAliases # readListPrec :: ReadPrec [AssociateFileSystemAliases] #
Show AssociateFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.AssociateFileSystemAliases Methods showsPrec :: Int -> AssociateFileSystemAliases -> ShowS # show :: AssociateFileSystemAliases -> String # showList :: [AssociateFileSystemAliases] -> ShowS #
NFData AssociateFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.AssociateFileSystemAliases Methods rnf :: AssociateFileSystemAliases -> () #
Eq AssociateFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.AssociateFileSystemAliases Methods (==) :: AssociateFileSystemAliases -> AssociateFileSystemAliases -> Bool # (/=) :: AssociateFileSystemAliases -> AssociateFileSystemAliases -> Bool #
Hashable AssociateFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.AssociateFileSystemAliases Methods hashWithSalt :: Int -> AssociateFileSystemAliases -> Int # hash :: AssociateFileSystemAliases -> Int #
type AWSResponse AssociateFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.AssociateFileSystemAliases type AWSResponse AssociateFileSystemAliases = AssociateFileSystemAliasesResponse
type Rep AssociateFileSystemAliases Source #
Instance details Defined in Amazonka.FSx.AssociateFileSystemAliases type Rep AssociateFileSystemAliases = D1 ('MetaData "AssociateFileSystemAliases" "Amazonka.FSx.AssociateFileSystemAliases" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "AssociateFileSystemAliases'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "aliases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newAssociateFileSystemAliases Source #

Arguments

:: Text	`AssociateFileSystemAliases`
-> AssociateFileSystemAliases

Create a value of AssociateFileSystemAliases 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:clientRequestToken:AssociateFileSystemAliases', associateFileSystemAliases_clientRequestToken - Undocumented member.

AssociateFileSystemAliases, associateFileSystemAliases_fileSystemId - Specifies the file system with which you want to associate one or more DNS aliases.

AssociateFileSystemAliases, associateFileSystemAliases_aliases - An array of one or more DNS alias names to associate with the file system. The alias name has to comply with the following formatting requirements:

Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.corp.example.com.
Can contain alphanumeric characters and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.

For DNS alias 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.

Request Lenses

associateFileSystemAliases_clientRequestToken :: Lens' AssociateFileSystemAliases (Maybe Text) Source #

Undocumented member.

associateFileSystemAliases_fileSystemId :: Lens' AssociateFileSystemAliases Text Source #

Specifies the file system with which you want to associate one or more DNS aliases.

associateFileSystemAliases_aliases :: Lens' AssociateFileSystemAliases [Text] Source #

An array of one or more DNS alias names to associate with the file system. The alias name has to comply with the following formatting requirements:

Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.corp.example.com.
Can contain alphanumeric characters and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.

For DNS alias 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.

Destructuring the Response

data AssociateFileSystemAliasesResponse Source #

The system generated response showing the DNS aliases that Amazon FSx is attempting to associate with the file system. Use the API operation to monitor the status of the aliases Amazon FSx is associating with the file system. It can take up to 2.5 minutes for the alias status to change from CREATING to AVAILABLE.

See: newAssociateFileSystemAliasesResponse smart constructor.

Constructors

AssociateFileSystemAliasesResponse'
Fields aliases :: Maybe [Alias] An array of the DNS aliases that Amazon FSx is associating with the file system. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newAssociateFileSystemAliasesResponse Source #

Arguments

:: Int	`$sel:httpStatus:AssociateFileSystemAliasesResponse'`
-> AssociateFileSystemAliasesResponse

Create a value of AssociateFileSystemAliasesResponse 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:

AssociateFileSystemAliases, associateFileSystemAliasesResponse_aliases - An array of the DNS aliases that Amazon FSx is associating with the file system.

$sel:httpStatus:AssociateFileSystemAliasesResponse', associateFileSystemAliasesResponse_httpStatus - The response's http status code.

Response Lenses

associateFileSystemAliasesResponse_aliases :: Lens' AssociateFileSystemAliasesResponse (Maybe [Alias]) Source #

An array of the DNS aliases that Amazon FSx is associating with the file system.

associateFileSystemAliasesResponse_httpStatus :: Lens' AssociateFileSystemAliasesResponse Int Source #

The response's http status code.