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.CreateLocationFsxWindows

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data CreateLocationFsxWindows = CreateLocationFsxWindows' {
- domain :: Maybe Text
- subdirectory :: Maybe Text
- tags :: Maybe [TagListEntry]
- fsxFilesystemArn :: Text
- securityGroupArns :: NonEmpty Text
- user :: Text
- password :: Sensitive Text
}
newCreateLocationFsxWindows :: Text -> NonEmpty Text -> Text -> Text -> CreateLocationFsxWindows
createLocationFsxWindows_domain :: Lens' CreateLocationFsxWindows (Maybe Text)
createLocationFsxWindows_subdirectory :: Lens' CreateLocationFsxWindows (Maybe Text)
createLocationFsxWindows_tags :: Lens' CreateLocationFsxWindows (Maybe [TagListEntry])
createLocationFsxWindows_fsxFilesystemArn :: Lens' CreateLocationFsxWindows Text
createLocationFsxWindows_securityGroupArns :: Lens' CreateLocationFsxWindows (NonEmpty Text)
createLocationFsxWindows_user :: Lens' CreateLocationFsxWindows Text
createLocationFsxWindows_password :: Lens' CreateLocationFsxWindows Text
data CreateLocationFsxWindowsResponse = CreateLocationFsxWindowsResponse' {
- locationArn :: Maybe Text
- httpStatus :: Int
}
newCreateLocationFsxWindowsResponse :: Int -> CreateLocationFsxWindowsResponse
createLocationFsxWindowsResponse_locationArn :: Lens' CreateLocationFsxWindowsResponse (Maybe Text)
createLocationFsxWindowsResponse_httpStatus :: Lens' CreateLocationFsxWindowsResponse Int

Creating a Request

data CreateLocationFsxWindows Source #

See: newCreateLocationFsxWindows smart constructor.

Constructors

CreateLocationFsxWindows'

Fields

domain :: Maybe Text
The name of the Windows domain that the FSx for Windows File Server belongs to.
subdirectory :: Maybe Text
A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows File Server file system is used to read data from the Amazon FSx for Windows File Server source location or write data to the FSx for Windows File Server destination.
tags :: Maybe [TagListEntry]
The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.
fsxFilesystemArn :: Text
The Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
securityGroupArns :: NonEmpty Text
The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows File Server file system.
user :: Text
The user who has the permissions to access files and folders in the FSx for Windows File Server file system.
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 has the permissions to access files and folders in the FSx for Windows File Server file system.

Instances

Instances details

Eq CreateLocationFsxWindows Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows Methods (==) :: CreateLocationFsxWindows -> CreateLocationFsxWindows -> Bool # (/=) :: CreateLocationFsxWindows -> CreateLocationFsxWindows -> Bool #
Show CreateLocationFsxWindows Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows Methods showsPrec :: Int -> CreateLocationFsxWindows -> ShowS # show :: CreateLocationFsxWindows -> String # showList :: [CreateLocationFsxWindows] -> ShowS #
Generic CreateLocationFsxWindows Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows Associated Types type Rep CreateLocationFsxWindows :: Type -> Type # Methods from :: CreateLocationFsxWindows -> Rep CreateLocationFsxWindows x # to :: Rep CreateLocationFsxWindows x -> CreateLocationFsxWindows #
NFData CreateLocationFsxWindows Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows Methods rnf :: CreateLocationFsxWindows -> () #
Hashable CreateLocationFsxWindows Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows Methods hashWithSalt :: Int -> CreateLocationFsxWindows -> Int # hash :: CreateLocationFsxWindows -> Int #
ToJSON CreateLocationFsxWindows Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows Methods toJSON :: CreateLocationFsxWindows -> Value # toEncoding :: CreateLocationFsxWindows -> Encoding # toJSONList :: [CreateLocationFsxWindows] -> Value # toEncodingList :: [CreateLocationFsxWindows] -> Encoding #
AWSRequest CreateLocationFsxWindows Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows Associated Types type AWSResponse CreateLocationFsxWindows # Methods request :: CreateLocationFsxWindows -> Request CreateLocationFsxWindows # response :: MonadResource m => Logger -> Service -> Proxy CreateLocationFsxWindows -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateLocationFsxWindows))) #
ToHeaders CreateLocationFsxWindows Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows Methods toHeaders :: CreateLocationFsxWindows -> [Header] #
ToPath CreateLocationFsxWindows Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows Methods toPath :: CreateLocationFsxWindows -> ByteString #
ToQuery CreateLocationFsxWindows Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows Methods toQuery :: CreateLocationFsxWindows -> QueryString #
type Rep CreateLocationFsxWindows Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows type Rep CreateLocationFsxWindows = D1 ('MetaData "CreateLocationFsxWindows" "Amazonka.DataSync.CreateLocationFsxWindows" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" '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))))))
type AWSResponse CreateLocationFsxWindows Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows type AWSResponse CreateLocationFsxWindows = CreateLocationFsxWindowsResponse

newCreateLocationFsxWindows Source #

Arguments

:: Text	`$sel:fsxFilesystemArn:CreateLocationFsxWindows'`
-> NonEmpty Text	`$sel:securityGroupArns:CreateLocationFsxWindows'`
-> Text	`$sel:user:CreateLocationFsxWindows'`
-> Text	`$sel:password: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:

$sel:domain:CreateLocationFsxWindows', createLocationFsxWindows_domain - The name of the Windows domain that the FSx for Windows File Server belongs to.

$sel:subdirectory:CreateLocationFsxWindows', createLocationFsxWindows_subdirectory - A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows File Server file system is used to read data from the Amazon FSx for Windows File Server source location or write data to the FSx for Windows File Server destination.

$sel:tags:CreateLocationFsxWindows', createLocationFsxWindows_tags - The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.

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

$sel:securityGroupArns:CreateLocationFsxWindows', createLocationFsxWindows_securityGroupArns - The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows File Server file system.

$sel:user:CreateLocationFsxWindows', createLocationFsxWindows_user - The user who has the permissions to access files and folders in the FSx for Windows File Server file system.

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

$sel:password:CreateLocationFsxWindows', createLocationFsxWindows_password - The password of the user who has the permissions to access files and folders in the FSx for Windows File Server file system.

Request Lenses

createLocationFsxWindows_domain :: Lens' CreateLocationFsxWindows (Maybe Text) Source #

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

createLocationFsxWindows_subdirectory :: Lens' CreateLocationFsxWindows (Maybe Text) Source #

A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows File Server file system is used to read data from the Amazon FSx for Windows File Server source location or write data to the FSx for Windows File Server destination.

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

The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.

createLocationFsxWindows_fsxFilesystemArn :: Lens' CreateLocationFsxWindows Text Source #

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

createLocationFsxWindows_securityGroupArns :: Lens' CreateLocationFsxWindows (NonEmpty Text) Source #

The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows File Server file system.

createLocationFsxWindows_user :: Lens' CreateLocationFsxWindows Text Source #

The user who has the permissions to access files and folders in the FSx for Windows File Server 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 Source #

The password of the user who has the permissions to access files and folders in the FSx for Windows File Server file system.

Destructuring the Response

data CreateLocationFsxWindowsResponse Source #

See: newCreateLocationFsxWindowsResponse smart constructor.

Constructors

CreateLocationFsxWindowsResponse'
Fields locationArn :: Maybe Text The Amazon Resource Name (ARN) of the FSx for Windows File Server file system location that is created. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateLocationFsxWindowsResponse Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows Methods (==) :: CreateLocationFsxWindowsResponse -> CreateLocationFsxWindowsResponse -> Bool # (/=) :: CreateLocationFsxWindowsResponse -> CreateLocationFsxWindowsResponse -> Bool #
Read CreateLocationFsxWindowsResponse Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows Methods readsPrec :: Int -> ReadS CreateLocationFsxWindowsResponse # readList :: ReadS [CreateLocationFsxWindowsResponse] # readPrec :: ReadPrec CreateLocationFsxWindowsResponse # readListPrec :: ReadPrec [CreateLocationFsxWindowsResponse] #
Show CreateLocationFsxWindowsResponse Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows Methods showsPrec :: Int -> CreateLocationFsxWindowsResponse -> ShowS # show :: CreateLocationFsxWindowsResponse -> String # showList :: [CreateLocationFsxWindowsResponse] -> ShowS #
Generic CreateLocationFsxWindowsResponse Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows Associated Types type Rep CreateLocationFsxWindowsResponse :: Type -> Type # Methods from :: CreateLocationFsxWindowsResponse -> Rep CreateLocationFsxWindowsResponse x # to :: Rep CreateLocationFsxWindowsResponse x -> CreateLocationFsxWindowsResponse #
NFData CreateLocationFsxWindowsResponse Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows Methods rnf :: CreateLocationFsxWindowsResponse -> () #
type Rep CreateLocationFsxWindowsResponse Source #
Instance details Defined in Amazonka.DataSync.CreateLocationFsxWindows type Rep CreateLocationFsxWindowsResponse = D1 ('MetaData "CreateLocationFsxWindowsResponse" "Amazonka.DataSync.CreateLocationFsxWindows" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" '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 Source #

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:

$sel:locationArn:CreateLocationFsxWindowsResponse', createLocationFsxWindowsResponse_locationArn - The Amazon Resource Name (ARN) of the FSx for Windows File Server file system location that is created.

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

Response Lenses

createLocationFsxWindowsResponse_locationArn :: Lens' CreateLocationFsxWindowsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the FSx for Windows File Server file system location that is created.

createLocationFsxWindowsResponse_httpStatus :: Lens' CreateLocationFsxWindowsResponse Int Source #

The response's http status code.