libZSservicesZSamazonka-datasyncZSamazonka-datasync
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.DataSync.CreateLocationNfs

Description

Defines a file system on a Network File System (NFS) server that can be read from or written to.

Synopsis

Creating a Request

data CreateLocationNfs Source #

CreateLocationNfsRequest

See: newCreateLocationNfs smart constructor.

Constructors

CreateLocationNfs' 

Fields

  • mountOptions :: Maybe NfsMountOptions

    The NFS mount options that DataSync can use to mount your NFS share.

  • tags :: Maybe [TagListEntry]

    The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

  • subdirectory :: Text

    The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network.

    To see all the paths exported by your NFS server, run "showmount -e nfs-server-name" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.

    To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.

    If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

    For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.

  • serverHostname :: Text

    The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this host name to mount the NFS server in a network.

    If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

    This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

  • onPremConfig :: OnPremConfig

    Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.

    If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

Instances

Instances details
Eq CreateLocationNfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

Read CreateLocationNfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

Show CreateLocationNfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

Generic CreateLocationNfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

Associated Types

type Rep CreateLocationNfs :: Type -> Type #

NFData CreateLocationNfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

Methods

rnf :: CreateLocationNfs -> () #

Hashable CreateLocationNfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

ToJSON CreateLocationNfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

AWSRequest CreateLocationNfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

Associated Types

type AWSResponse CreateLocationNfs #

ToHeaders CreateLocationNfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

ToPath CreateLocationNfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

ToQuery CreateLocationNfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

type Rep CreateLocationNfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

type Rep CreateLocationNfs = D1 ('MetaData "CreateLocationNfs" "Amazonka.DataSync.CreateLocationNfs" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "CreateLocationNfs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "mountOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NfsMountOptions)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagListEntry]))) :*: (S1 ('MetaSel ('Just "subdirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "serverHostname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "onPremConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OnPremConfig)))))
type AWSResponse CreateLocationNfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

newCreateLocationNfs Source #

Create a value of CreateLocationNfs 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:mountOptions:CreateLocationNfs', createLocationNfs_mountOptions - The NFS mount options that DataSync can use to mount your NFS share.

$sel:tags:CreateLocationNfs', createLocationNfs_tags - The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

$sel:subdirectory:CreateLocationNfs', createLocationNfs_subdirectory - The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network.

To see all the paths exported by your NFS server, run "showmount -e nfs-server-name" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.

To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.

$sel:serverHostname:CreateLocationNfs', createLocationNfs_serverHostname - The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this host name to mount the NFS server in a network.

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

$sel:onPremConfig:CreateLocationNfs', createLocationNfs_onPremConfig - Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

Request Lenses

createLocationNfs_mountOptions :: Lens' CreateLocationNfs (Maybe NfsMountOptions) Source #

The NFS mount options that DataSync can use to mount your NFS share.

createLocationNfs_tags :: Lens' CreateLocationNfs (Maybe [TagListEntry]) Source #

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

createLocationNfs_subdirectory :: Lens' CreateLocationNfs Text Source #

The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network.

To see all the paths exported by your NFS server, run "showmount -e nfs-server-name" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.

To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.

createLocationNfs_serverHostname :: Lens' CreateLocationNfs Text Source #

The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this host name to mount the NFS server in a network.

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

createLocationNfs_onPremConfig :: Lens' CreateLocationNfs OnPremConfig Source #

Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

Destructuring the Response

data CreateLocationNfsResponse Source #

CreateLocationNfsResponse

See: newCreateLocationNfsResponse smart constructor.

Constructors

CreateLocationNfsResponse' 

Fields

Instances

Instances details
Eq CreateLocationNfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

Read CreateLocationNfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

Show CreateLocationNfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

Generic CreateLocationNfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

Associated Types

type Rep CreateLocationNfsResponse :: Type -> Type #

NFData CreateLocationNfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

type Rep CreateLocationNfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationNfs

type Rep CreateLocationNfsResponse = D1 ('MetaData "CreateLocationNfsResponse" "Amazonka.DataSync.CreateLocationNfs" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "CreateLocationNfsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateLocationNfsResponse Source #

Create a value of CreateLocationNfsResponse 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:locationArn:CreateLocationNfsResponse', createLocationNfsResponse_locationArn - The Amazon Resource Name (ARN) of the source NFS file system location that is created.

$sel:httpStatus:CreateLocationNfsResponse', createLocationNfsResponse_httpStatus - The response's http status code.

Response Lenses

createLocationNfsResponse_locationArn :: Lens' CreateLocationNfsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the source NFS file system location that is created.