Amazonka.StorageGateway.AssociateFileSystem

Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type.

Creating a Request

data AssociateFileSystem

See: newAssociateFileSystem smart constructor.

Constructors

AssociateFileSystem'

Fields

• auditDestinationARN :: Maybe Text

  The Amazon Resource Name (ARN) of the storage used for the audit logs.

• cacheAttributes :: Maybe CacheAttributes
• endpointNetworkConfiguration :: Maybe EndpointNetworkConfiguration

  Specifies the network configuration information for the gateway associated with the Amazon FSx file system.

  If multiple file systems are associated with this gateway, this parameter's IpAddresses field is required.

• tags :: Maybe [Tag]

  A list of up to 50 tags that can be assigned to the file system association. Each tag is a key-value pair.

• userName :: Text

  The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.

• password :: Sensitive Text

  The password of the user credential.

• clientToken :: Text

  A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.

• gatewayARN :: Text
• locationARN :: Text

  The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.

Instances

ToJSON AssociateFileSystem

Defined in Amazonka.StorageGateway.AssociateFileSystem

Methods

toJSON :: AssociateFileSystem -> Value

toEncoding :: AssociateFileSystem -> Encoding

toJSONList :: [AssociateFileSystem] -> Value

toEncodingList :: [AssociateFileSystem] -> Encoding

ToHeaders AssociateFileSystem

Defined in Amazonka.StorageGateway.AssociateFileSystem

Methods

toHeaders :: AssociateFileSystem -> [Header]

ToPath AssociateFileSystem

Defined in Amazonka.StorageGateway.AssociateFileSystem

Methods

toPath :: AssociateFileSystem -> ByteString

ToQuery AssociateFileSystem

Defined in Amazonka.StorageGateway.AssociateFileSystem

Methods

toQuery :: AssociateFileSystem -> QueryString

AWSRequest AssociateFileSystem

Defined in Amazonka.StorageGateway.AssociateFileSystem

Associated Types

type AWSResponse AssociateFileSystem

Methods

request :: (Service -> Service) -> AssociateFileSystem -> Request AssociateFileSystem

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AssociateFileSystem -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssociateFileSystem)))

Generic AssociateFileSystem

Defined in Amazonka.StorageGateway.AssociateFileSystem

Associated Types

type Rep AssociateFileSystem :: Type -> Type

Methods

from :: AssociateFileSystem -> Rep AssociateFileSystem x

to :: Rep AssociateFileSystem x -> AssociateFileSystem

Show AssociateFileSystem

Defined in Amazonka.StorageGateway.AssociateFileSystem

Methods

showsPrec :: Int -> AssociateFileSystem -> ShowS

show :: AssociateFileSystem -> String

showList :: [AssociateFileSystem] -> ShowS

NFData AssociateFileSystem

Defined in Amazonka.StorageGateway.AssociateFileSystem

Methods

rnf :: AssociateFileSystem -> ()

Eq AssociateFileSystem

Defined in Amazonka.StorageGateway.AssociateFileSystem

Methods

(==) :: AssociateFileSystem -> AssociateFileSystem -> Bool

(/=) :: AssociateFileSystem -> AssociateFileSystem -> Bool

Hashable AssociateFileSystem

Defined in Amazonka.StorageGateway.AssociateFileSystem

Methods

hashWithSalt :: Int -> AssociateFileSystem -> Int

hash :: AssociateFileSystem -> Int

type AWSResponse AssociateFileSystem

Defined in Amazonka.StorageGateway.AssociateFileSystem

type AWSResponse AssociateFileSystem = AssociateFileSystemResponse

type Rep AssociateFileSystem

Defined in Amazonka.StorageGateway.AssociateFileSystem

type Rep AssociateFileSystem = D1 ('MetaData "AssociateFileSystem" "Amazonka.StorageGateway.AssociateFileSystem" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "AssociateFileSystem'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "auditDestinationARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cacheAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheAttributes))) :*: (S1 ('MetaSel ('Just "endpointNetworkConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointNetworkConfiguration)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: ((S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))) :*: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "gatewayARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "locationARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newAssociateFileSystem

Arguments

:: Text

$sel:userName:AssociateFileSystem'

-> Text

$sel:password:AssociateFileSystem'

-> Text

$sel:clientToken:AssociateFileSystem'

-> Text

AssociateFileSystem

-> Text

AssociateFileSystem

-> AssociateFileSystem

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

AssociateFileSystem, associateFileSystem_auditDestinationARN - The Amazon Resource Name (ARN) of the storage used for the audit logs.

AssociateFileSystem, associateFileSystem_cacheAttributes - Undocumented member.

AssociateFileSystem, associateFileSystem_endpointNetworkConfiguration - Specifies the network configuration information for the gateway associated with the Amazon FSx file system.

If multiple file systems are associated with this gateway, this parameter's IpAddresses field is required.

AssociateFileSystem, associateFileSystem_tags - A list of up to 50 tags that can be assigned to the file system association. Each tag is a key-value pair.

$sel:userName:AssociateFileSystem', associateFileSystem_userName - The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.

$sel:password:AssociateFileSystem', associateFileSystem_password - The password of the user credential.

$sel:clientToken:AssociateFileSystem', associateFileSystem_clientToken - A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.

AssociateFileSystem, associateFileSystem_gatewayARN - Undocumented member.

AssociateFileSystem, associateFileSystem_locationARN - The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.

Request Lenses

associateFileSystem_auditDestinationARN :: Lens' AssociateFileSystem (Maybe Text)

The Amazon Resource Name (ARN) of the storage used for the audit logs.

associateFileSystem_cacheAttributes :: Lens' AssociateFileSystem (Maybe CacheAttributes)

Undocumented member.

associateFileSystem_endpointNetworkConfiguration :: Lens' AssociateFileSystem (Maybe EndpointNetworkConfiguration)

Specifies the network configuration information for the gateway associated with the Amazon FSx file system.

If multiple file systems are associated with this gateway, this parameter's IpAddresses field is required.

associateFileSystem_tags :: Lens' AssociateFileSystem (Maybe [Tag])

A list of up to 50 tags that can be assigned to the file system association. Each tag is a key-value pair.

associateFileSystem_userName :: Lens' AssociateFileSystem Text

The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.

associateFileSystem_password :: Lens' AssociateFileSystem Text

The password of the user credential.

associateFileSystem_clientToken :: Lens' AssociateFileSystem Text

A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.

associateFileSystem_gatewayARN :: Lens' AssociateFileSystem Text

Undocumented member.

associateFileSystem_locationARN :: Lens' AssociateFileSystem Text

The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.

Destructuring the Response

data AssociateFileSystemResponse

See: newAssociateFileSystemResponse smart constructor.

Constructors

AssociateFileSystemResponse'

Fields

• fileSystemAssociationARN :: Maybe Text

  The ARN of the newly created file system association.

• httpStatus :: Int

  The response's http status code.

Instances

Generic AssociateFileSystemResponse

Defined in Amazonka.StorageGateway.AssociateFileSystem

Associated Types

type Rep AssociateFileSystemResponse :: Type -> Type

Methods

from :: AssociateFileSystemResponse -> Rep AssociateFileSystemResponse x

to :: Rep AssociateFileSystemResponse x -> AssociateFileSystemResponse

Read AssociateFileSystemResponse

Defined in Amazonka.StorageGateway.AssociateFileSystem

Methods

readsPrec :: Int -> ReadS AssociateFileSystemResponse

readList :: ReadS [AssociateFileSystemResponse]

readPrec :: ReadPrec AssociateFileSystemResponse

readListPrec :: ReadPrec [AssociateFileSystemResponse]

Show AssociateFileSystemResponse

Defined in Amazonka.StorageGateway.AssociateFileSystem

Methods

showsPrec :: Int -> AssociateFileSystemResponse -> ShowS

show :: AssociateFileSystemResponse -> String

showList :: [AssociateFileSystemResponse] -> ShowS

NFData AssociateFileSystemResponse

Defined in Amazonka.StorageGateway.AssociateFileSystem

Methods

rnf :: AssociateFileSystemResponse -> ()

Eq AssociateFileSystemResponse

Defined in Amazonka.StorageGateway.AssociateFileSystem

Methods

(==) :: AssociateFileSystemResponse -> AssociateFileSystemResponse -> Bool

(/=) :: AssociateFileSystemResponse -> AssociateFileSystemResponse -> Bool

type Rep AssociateFileSystemResponse

Defined in Amazonka.StorageGateway.AssociateFileSystem

type Rep AssociateFileSystemResponse = D1 ('MetaData "AssociateFileSystemResponse" "Amazonka.StorageGateway.AssociateFileSystem" "amazonka-storagegateway-2.0-A8x7b0LCNm33wkCZlwgcSL" 'False) (C1 ('MetaCons "AssociateFileSystemResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fileSystemAssociationARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAssociateFileSystemResponse

Arguments

:: Int

$sel:httpStatus:AssociateFileSystemResponse'

-> AssociateFileSystemResponse

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

AssociateFileSystemResponse, associateFileSystemResponse_fileSystemAssociationARN - The ARN of the newly created file system association.

$sel:httpStatus:AssociateFileSystemResponse', associateFileSystemResponse_httpStatus - The response's http status code.

Response Lenses

associateFileSystemResponse_fileSystemAssociationARN :: Lens' AssociateFileSystemResponse (Maybe Text)

The ARN of the newly created file system association.

associateFileSystemResponse_httpStatus :: Lens' AssociateFileSystemResponse Int

The response's http status code.