Amazonka.DataSync.CreateLocationFsxWindows

Creates an endpoint for an Amazon FSx for Windows File Server file system.

Creating a Request

data CreateLocationFsxWindows

See: newCreateLocationFsxWindows smart constructor.

Constructors

CreateLocationFsxWindows'

Fields

• domain :: Maybe Text

  Specifies the name of the Windows domain that the FSx for Windows File Server belongs to.

• subdirectory :: Maybe Text

  Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).

• tags :: Maybe [TagListEntry]

  Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

• fsxFilesystemArn :: Text

  Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

• securityGroupArns :: NonEmpty Text

  Specifies the ARNs of the security groups that provide access to your file system's preferred subnet.

  If you choose a security group that doesn't allow connections from within itself, do one of the following:

  • Configure the security group to allow it to communicate within itself.
  • Choose a different security group that can communicate with the mount target's security group.
• user :: Text

  Specifies the user who has the permissions to access files and folders in the file system.

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

• password :: Sensitive Text

  Specifies the password of the user who has the permissions to access files and folders in the file system.

Instances

ToJSON CreateLocationFsxWindows

Defined in Amazonka.DataSync.CreateLocationFsxWindows

Methods

toJSON :: CreateLocationFsxWindows -> Value

toEncoding :: CreateLocationFsxWindows -> Encoding

toJSONList :: [CreateLocationFsxWindows] -> Value

toEncodingList :: [CreateLocationFsxWindows] -> Encoding

ToHeaders CreateLocationFsxWindows

Defined in Amazonka.DataSync.CreateLocationFsxWindows

Methods

toHeaders :: CreateLocationFsxWindows -> [Header]

ToPath CreateLocationFsxWindows

Defined in Amazonka.DataSync.CreateLocationFsxWindows

Methods

toPath :: CreateLocationFsxWindows -> ByteString

ToQuery CreateLocationFsxWindows

Defined in Amazonka.DataSync.CreateLocationFsxWindows

Methods

toQuery :: CreateLocationFsxWindows -> QueryString

AWSRequest CreateLocationFsxWindows

Defined in Amazonka.DataSync.CreateLocationFsxWindows

Associated Types

type AWSResponse CreateLocationFsxWindows

Methods

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

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

Generic CreateLocationFsxWindows

Defined in Amazonka.DataSync.CreateLocationFsxWindows

Associated Types

type Rep CreateLocationFsxWindows :: Type -> Type

Methods

from :: CreateLocationFsxWindows -> Rep CreateLocationFsxWindows x

to :: Rep CreateLocationFsxWindows x -> CreateLocationFsxWindows

Show CreateLocationFsxWindows

Defined in Amazonka.DataSync.CreateLocationFsxWindows

Methods

showsPrec :: Int -> CreateLocationFsxWindows -> ShowS

show :: CreateLocationFsxWindows -> String

showList :: [CreateLocationFsxWindows] -> ShowS

NFData CreateLocationFsxWindows

Defined in Amazonka.DataSync.CreateLocationFsxWindows

Methods

rnf :: CreateLocationFsxWindows -> ()

Eq CreateLocationFsxWindows

Defined in Amazonka.DataSync.CreateLocationFsxWindows

Methods

(==) :: CreateLocationFsxWindows -> CreateLocationFsxWindows -> Bool

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

Hashable CreateLocationFsxWindows

Defined in Amazonka.DataSync.CreateLocationFsxWindows

Methods

hashWithSalt :: Int -> CreateLocationFsxWindows -> Int

hash :: CreateLocationFsxWindows -> Int

type AWSResponse CreateLocationFsxWindows

Defined in Amazonka.DataSync.CreateLocationFsxWindows

type AWSResponse CreateLocationFsxWindows = CreateLocationFsxWindowsResponse

type Rep CreateLocationFsxWindows

Defined in Amazonka.DataSync.CreateLocationFsxWindows

type Rep CreateLocationFsxWindows = D1 ('MetaData "CreateLocationFsxWindows" "Amazonka.DataSync.CreateLocationFsxWindows" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "CreateLocationFsxWindows'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "subdirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagListEntry])))) :*: ((S1 ('MetaSel ('Just "fsxFilesystemArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "securityGroupArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))

newCreateLocationFsxWindows

Arguments

:: Text

$sel:fsxFilesystemArn:CreateLocationFsxWindows'

-> NonEmpty Text

CreateLocationFsxWindows

-> Text

CreateLocationFsxWindows

-> Text

CreateLocationFsxWindows

-> CreateLocationFsxWindows

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

CreateLocationFsxWindows, createLocationFsxWindows_domain - Specifies the name of the Windows domain that the FSx for Windows File Server belongs to.

$sel:subdirectory:CreateLocationFsxWindows', createLocationFsxWindows_subdirectory - Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).

$sel:tags:CreateLocationFsxWindows', createLocationFsxWindows_tags - Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

$sel:fsxFilesystemArn:CreateLocationFsxWindows', createLocationFsxWindows_fsxFilesystemArn - Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

CreateLocationFsxWindows, createLocationFsxWindows_securityGroupArns - Specifies the ARNs of the security groups that provide access to your file system's preferred subnet.

If you choose a security group that doesn't allow connections from within itself, do one of the following:

• Configure the security group to allow it to communicate within itself.
• Choose a different security group that can communicate with the mount target's security group.

CreateLocationFsxWindows, createLocationFsxWindows_user - Specifies the user who has the permissions to access files and folders in the file system.

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

CreateLocationFsxWindows, createLocationFsxWindows_password - Specifies the password of the user who has the permissions to access files and folders in the file system.

Request Lenses

createLocationFsxWindows_domain :: Lens' CreateLocationFsxWindows (Maybe Text)

Specifies the name of the Windows domain that the FSx for Windows File Server belongs to.

createLocationFsxWindows_subdirectory :: Lens' CreateLocationFsxWindows (Maybe Text)

Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).

createLocationFsxWindows_tags :: Lens' CreateLocationFsxWindows (Maybe [TagListEntry])

Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.

createLocationFsxWindows_fsxFilesystemArn :: Lens' CreateLocationFsxWindows Text

Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

createLocationFsxWindows_securityGroupArns :: Lens' CreateLocationFsxWindows (NonEmpty Text)

Specifies the ARNs of the security groups that provide access to your file system's preferred subnet.

If you choose a security group that doesn't allow connections from within itself, do one of the following:

• Configure the security group to allow it to communicate within itself.
• Choose a different security group that can communicate with the mount target's security group.

createLocationFsxWindows_user :: Lens' CreateLocationFsxWindows Text

Specifies the user who has the permissions to access files and folders in the file system.

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

createLocationFsxWindows_password :: Lens' CreateLocationFsxWindows Text

Specifies the password of the user who has the permissions to access files and folders in the file system.

Destructuring the Response

data CreateLocationFsxWindowsResponse

See: newCreateLocationFsxWindowsResponse smart constructor.

Constructors

CreateLocationFsxWindowsResponse'

Fields

• locationArn :: Maybe Text

  The ARN of the FSx for Windows File Server file system location you created.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateLocationFsxWindowsResponse

Defined in Amazonka.DataSync.CreateLocationFsxWindows

Associated Types

type Rep CreateLocationFsxWindowsResponse :: Type -> Type

Methods

from :: CreateLocationFsxWindowsResponse -> Rep CreateLocationFsxWindowsResponse x

to :: Rep CreateLocationFsxWindowsResponse x -> CreateLocationFsxWindowsResponse

Read CreateLocationFsxWindowsResponse

Defined in Amazonka.DataSync.CreateLocationFsxWindows

Methods

readsPrec :: Int -> ReadS CreateLocationFsxWindowsResponse

readList :: ReadS [CreateLocationFsxWindowsResponse]

readPrec :: ReadPrec CreateLocationFsxWindowsResponse

readListPrec :: ReadPrec [CreateLocationFsxWindowsResponse]

Show CreateLocationFsxWindowsResponse

Defined in Amazonka.DataSync.CreateLocationFsxWindows

Methods

showsPrec :: Int -> CreateLocationFsxWindowsResponse -> ShowS

show :: CreateLocationFsxWindowsResponse -> String

showList :: [CreateLocationFsxWindowsResponse] -> ShowS

NFData CreateLocationFsxWindowsResponse

Defined in Amazonka.DataSync.CreateLocationFsxWindows

Methods

rnf :: CreateLocationFsxWindowsResponse -> ()

Eq CreateLocationFsxWindowsResponse

Defined in Amazonka.DataSync.CreateLocationFsxWindows

Methods

(==) :: CreateLocationFsxWindowsResponse -> CreateLocationFsxWindowsResponse -> Bool

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

type Rep CreateLocationFsxWindowsResponse

Defined in Amazonka.DataSync.CreateLocationFsxWindows

type Rep CreateLocationFsxWindowsResponse = D1 ('MetaData "CreateLocationFsxWindowsResponse" "Amazonka.DataSync.CreateLocationFsxWindows" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "CreateLocationFsxWindowsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateLocationFsxWindowsResponse

Arguments

:: Int

$sel:httpStatus:CreateLocationFsxWindowsResponse'

-> CreateLocationFsxWindowsResponse

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

CreateLocationFsxWindowsResponse, createLocationFsxWindowsResponse_locationArn - The ARN of the FSx for Windows File Server file system location you created.

$sel:httpStatus:CreateLocationFsxWindowsResponse', createLocationFsxWindowsResponse_httpStatus - The response's http status code.

Response Lenses

createLocationFsxWindowsResponse_locationArn :: Lens' CreateLocationFsxWindowsResponse (Maybe Text)

The ARN of the FSx for Windows File Server file system location you created.

createLocationFsxWindowsResponse_httpStatus :: Lens' CreateLocationFsxWindowsResponse Int

The response's http status code.