Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DataSync.CreateLocationSmb

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Defines a file system on a Server Message Block (SMB) server that can be read from or written to.

Synopsis

data CreateLocationSmb = CreateLocationSmb' {
- domain :: Maybe Text
- mountOptions :: Maybe SmbMountOptions
- tags :: Maybe [TagListEntry]
- subdirectory :: Text
- serverHostname :: Text
- user :: Text
- password :: Sensitive Text
- agentArns :: NonEmpty Text
}
newCreateLocationSmb :: Text -> Text -> Text -> Text -> NonEmpty Text -> CreateLocationSmb
createLocationSmb_domain :: Lens' CreateLocationSmb (Maybe Text)
createLocationSmb_mountOptions :: Lens' CreateLocationSmb (Maybe SmbMountOptions)
createLocationSmb_tags :: Lens' CreateLocationSmb (Maybe [TagListEntry])
createLocationSmb_subdirectory :: Lens' CreateLocationSmb Text
createLocationSmb_serverHostname :: Lens' CreateLocationSmb Text
createLocationSmb_user :: Lens' CreateLocationSmb Text
createLocationSmb_password :: Lens' CreateLocationSmb Text
createLocationSmb_agentArns :: Lens' CreateLocationSmb (NonEmpty Text)
data CreateLocationSmbResponse = CreateLocationSmbResponse' {
- locationArn :: Maybe Text
- httpStatus :: Int
}
newCreateLocationSmbResponse :: Int -> CreateLocationSmbResponse
createLocationSmbResponse_locationArn :: Lens' CreateLocationSmbResponse (Maybe Text)
createLocationSmbResponse_httpStatus :: Lens' CreateLocationSmbResponse Int

Creating a Request

data CreateLocationSmb Source #

CreateLocationSmbRequest

See: newCreateLocationSmb smart constructor.

Constructors

CreateLocationSmb'

Fields

domain :: Maybe Text
The name of the Windows domain that the SMB server belongs to.
mountOptions :: Maybe SmbMountOptions
The mount options used by DataSync to access the SMB server.
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 SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.
Subdirectory must be specified with forward slashes. For example, /path/to/folder.
To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.
serverHostname :: Text
The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.
This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
user :: Text
The user who can mount the share, has the permissions to access files and folders in the SMB share.
For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.
password :: Sensitive Text
The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.
agentArns :: NonEmpty Text
The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Instances

Instances details

Eq CreateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb Methods (==) :: CreateLocationSmb -> CreateLocationSmb -> Bool # (/=) :: CreateLocationSmb -> CreateLocationSmb -> Bool #
Show CreateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb Methods showsPrec :: Int -> CreateLocationSmb -> ShowS # show :: CreateLocationSmb -> String # showList :: [CreateLocationSmb] -> ShowS #
Generic CreateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb Associated Types type Rep CreateLocationSmb :: Type -> Type # Methods from :: CreateLocationSmb -> Rep CreateLocationSmb x # to :: Rep CreateLocationSmb x -> CreateLocationSmb #
NFData CreateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb Methods rnf :: CreateLocationSmb -> () #
Hashable CreateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb Methods hashWithSalt :: Int -> CreateLocationSmb -> Int # hash :: CreateLocationSmb -> Int #
ToJSON CreateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb Methods toJSON :: CreateLocationSmb -> Value # toEncoding :: CreateLocationSmb -> Encoding # toJSONList :: [CreateLocationSmb] -> Value # toEncodingList :: [CreateLocationSmb] -> Encoding #
AWSRequest CreateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb Associated Types type AWSResponse CreateLocationSmb # Methods request :: CreateLocationSmb -> Request CreateLocationSmb # response :: MonadResource m => Logger -> Service -> Proxy CreateLocationSmb -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateLocationSmb))) #
ToHeaders CreateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb Methods toHeaders :: CreateLocationSmb -> [Header] #
ToPath CreateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb Methods toPath :: CreateLocationSmb -> ByteString #
ToQuery CreateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb Methods toQuery :: CreateLocationSmb -> QueryString #
type Rep CreateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb type Rep CreateLocationSmb = D1 ('MetaData "CreateLocationSmb" "Amazonka.DataSync.CreateLocationSmb" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "CreateLocationSmb'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "mountOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SmbMountOptions))) :: (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 "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "agentArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))))
type AWSResponse CreateLocationSmb Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb type AWSResponse CreateLocationSmb = CreateLocationSmbResponse

newCreateLocationSmb Source #

Arguments

:: Text	`$sel:subdirectory:CreateLocationSmb'`
-> Text	`$sel:serverHostname:CreateLocationSmb'`
-> Text	`$sel:user:CreateLocationSmb'`
-> Text	`$sel:password:CreateLocationSmb'`
-> NonEmpty Text	`$sel:agentArns:CreateLocationSmb'`
-> CreateLocationSmb

Create a value of CreateLocationSmb 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:domain:CreateLocationSmb', createLocationSmb_domain - The name of the Windows domain that the SMB server belongs to.

$sel:mountOptions:CreateLocationSmb', createLocationSmb_mountOptions - The mount options used by DataSync to access the SMB server.

$sel:tags:CreateLocationSmb', createLocationSmb_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:CreateLocationSmb', createLocationSmb_subdirectory - The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

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

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

$sel:user:CreateLocationSmb', createLocationSmb_user - The user who can mount the share, has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

$sel:password:CreateLocationSmb', createLocationSmb_password - The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

$sel:agentArns:CreateLocationSmb', createLocationSmb_agentArns - The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Request Lenses

createLocationSmb_domain :: Lens' CreateLocationSmb (Maybe Text) Source #

The name of the Windows domain that the SMB server belongs to.

createLocationSmb_mountOptions :: Lens' CreateLocationSmb (Maybe SmbMountOptions) Source #

The mount options used by DataSync to access the SMB server.

createLocationSmb_tags :: Lens' CreateLocationSmb (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.

createLocationSmb_subdirectory :: Lens' CreateLocationSmb Text Source #

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

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

createLocationSmb_serverHostname :: Lens' CreateLocationSmb Text Source #

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

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

createLocationSmb_user :: Lens' CreateLocationSmb Text Source #

The user who can mount the share, has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

createLocationSmb_password :: Lens' CreateLocationSmb Text Source #

The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

createLocationSmb_agentArns :: Lens' CreateLocationSmb (NonEmpty Text) Source #

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Destructuring the Response

data CreateLocationSmbResponse Source #

CreateLocationSmbResponse

See: newCreateLocationSmbResponse smart constructor.

Constructors

CreateLocationSmbResponse'
Fields locationArn :: Maybe Text The Amazon Resource Name (ARN) of the source SMB file system location that is created. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb Methods (==) :: CreateLocationSmbResponse -> CreateLocationSmbResponse -> Bool # (/=) :: CreateLocationSmbResponse -> CreateLocationSmbResponse -> Bool #
Read CreateLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb Methods readsPrec :: Int -> ReadS CreateLocationSmbResponse # readList :: ReadS [CreateLocationSmbResponse] # readPrec :: ReadPrec CreateLocationSmbResponse # readListPrec :: ReadPrec [CreateLocationSmbResponse] #
Show CreateLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb Methods showsPrec :: Int -> CreateLocationSmbResponse -> ShowS # show :: CreateLocationSmbResponse -> String # showList :: [CreateLocationSmbResponse] -> ShowS #
Generic CreateLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb Associated Types type Rep CreateLocationSmbResponse :: Type -> Type # Methods from :: CreateLocationSmbResponse -> Rep CreateLocationSmbResponse x # to :: Rep CreateLocationSmbResponse x -> CreateLocationSmbResponse #
NFData CreateLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb Methods rnf :: CreateLocationSmbResponse -> () #
type Rep CreateLocationSmbResponse Source #
Instance details Defined in Amazonka.DataSync.CreateLocationSmb type Rep CreateLocationSmbResponse = D1 ('MetaData "CreateLocationSmbResponse" "Amazonka.DataSync.CreateLocationSmb" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "CreateLocationSmbResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateLocationSmbResponse Source #

Arguments

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

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

$sel:httpStatus:CreateLocationSmbResponse', createLocationSmbResponse_httpStatus - The response's http status code.

Response Lenses

createLocationSmbResponse_locationArn :: Lens' CreateLocationSmbResponse (Maybe Text) Source #

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

createLocationSmbResponse_httpStatus :: Lens' CreateLocationSmbResponse Int Source #

The response's http status code.