libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.StorageGateway.AssociateFileSystem

Description

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.

Synopsis

Creating a Request

data AssociateFileSystem Source #

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

Instances details
Eq AssociateFileSystem Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

Show AssociateFileSystem Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

Generic AssociateFileSystem Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

Associated Types

type Rep AssociateFileSystem :: Type -> Type #

NFData AssociateFileSystem Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

Methods

rnf :: AssociateFileSystem -> () #

Hashable AssociateFileSystem Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

ToJSON AssociateFileSystem Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

AWSRequest AssociateFileSystem Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

Associated Types

type AWSResponse AssociateFileSystem #

ToHeaders AssociateFileSystem Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

ToPath AssociateFileSystem Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

ToQuery AssociateFileSystem Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

type Rep AssociateFileSystem Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

type Rep AssociateFileSystem = D1 ('MetaData "AssociateFileSystem" "Amazonka.StorageGateway.AssociateFileSystem" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" '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))))))
type AWSResponse AssociateFileSystem Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

newAssociateFileSystem Source #

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:

$sel:auditDestinationARN:AssociateFileSystem', associateFileSystem_auditDestinationARN - The Amazon Resource Name (ARN) of the storage used for the audit logs.

$sel:cacheAttributes:AssociateFileSystem', associateFileSystem_cacheAttributes - Undocumented member.

$sel:endpointNetworkConfiguration: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.

$sel:tags: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.

$sel:gatewayARN:AssociateFileSystem', associateFileSystem_gatewayARN - Undocumented member.

$sel:locationARN: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) Source #

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

associateFileSystem_endpointNetworkConfiguration :: Lens' AssociateFileSystem (Maybe EndpointNetworkConfiguration) Source #

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]) Source #

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 Source #

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 Source #

The password of the user credential.

associateFileSystem_clientToken :: Lens' AssociateFileSystem Text Source #

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

associateFileSystem_locationARN :: Lens' AssociateFileSystem Text Source #

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

Destructuring the Response

data AssociateFileSystemResponse Source #

See: newAssociateFileSystemResponse smart constructor.

Constructors

AssociateFileSystemResponse' 

Fields

Instances

Instances details
Eq AssociateFileSystemResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

Read AssociateFileSystemResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

Show AssociateFileSystemResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

Generic AssociateFileSystemResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

Associated Types

type Rep AssociateFileSystemResponse :: Type -> Type #

NFData AssociateFileSystemResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

type Rep AssociateFileSystemResponse Source # 
Instance details

Defined in Amazonka.StorageGateway.AssociateFileSystem

type Rep AssociateFileSystemResponse = D1 ('MetaData "AssociateFileSystemResponse" "Amazonka.StorageGateway.AssociateFileSystem" "libZSservicesZSamazonka-storagegatewayZSamazonka-storagegateway" '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 Source #

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:

$sel:fileSystemAssociationARN: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