Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DataSync.CreateLocationEfs

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer. For more information, see Creating a location for Amazon EFS.

Synopsis

data CreateLocationEfs = CreateLocationEfs' {
- accessPointArn :: Maybe Text
- fileSystemAccessRoleArn :: Maybe Text
- inTransitEncryption :: Maybe EfsInTransitEncryption
- subdirectory :: Maybe Text
- tags :: Maybe [TagListEntry]
- efsFilesystemArn :: Text
- ec2Config :: Ec2Config
}
newCreateLocationEfs :: Text -> Ec2Config -> CreateLocationEfs
createLocationEfs_accessPointArn :: Lens' CreateLocationEfs (Maybe Text)
createLocationEfs_fileSystemAccessRoleArn :: Lens' CreateLocationEfs (Maybe Text)
createLocationEfs_inTransitEncryption :: Lens' CreateLocationEfs (Maybe EfsInTransitEncryption)
createLocationEfs_subdirectory :: Lens' CreateLocationEfs (Maybe Text)
createLocationEfs_tags :: Lens' CreateLocationEfs (Maybe [TagListEntry])
createLocationEfs_efsFilesystemArn :: Lens' CreateLocationEfs Text
createLocationEfs_ec2Config :: Lens' CreateLocationEfs Ec2Config
data CreateLocationEfsResponse = CreateLocationEfsResponse' {
- locationArn :: Maybe Text
- httpStatus :: Int
}
newCreateLocationEfsResponse :: Int -> CreateLocationEfsResponse
createLocationEfsResponse_locationArn :: Lens' CreateLocationEfsResponse (Maybe Text)
createLocationEfsResponse_httpStatus :: Lens' CreateLocationEfsResponse Int

Creating a Request

data CreateLocationEfs Source #

CreateLocationEfsRequest

See: newCreateLocationEfs smart constructor.

Constructors

CreateLocationEfs'

Fields

accessPointArn :: Maybe Text
Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.
fileSystemAccessRoleArn :: Maybe Text
Specifies an Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.
inTransitEncryption :: Maybe EfsInTransitEncryption
Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the Amazon EFS file system.
If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn, you must set this parameter to TLS1_2.
subdirectory :: Maybe Text
Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location). By default, DataSync uses the root directory, but you can also include subdirectories.
You must specify a value with forward slashes (for example, /path/to/folder).
tags :: Maybe [TagListEntry]
Specifies 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.
efsFilesystemArn :: Text
Specifies the ARN for the Amazon EFS file system.
ec2Config :: Ec2Config
Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.

Instances

Instances details

ToJSON CreateLocationEfs Source #
Instance details Defined in Amazonka.DataSync.CreateLocationEfs Methods toJSON :: CreateLocationEfs -> Value # toEncoding :: CreateLocationEfs -> Encoding # toJSONList :: [CreateLocationEfs] -> Value # toEncodingList :: [CreateLocationEfs] -> Encoding #
ToHeaders CreateLocationEfs Source #
Instance details Defined in Amazonka.DataSync.CreateLocationEfs Methods toHeaders :: CreateLocationEfs -> [Header] #
ToPath CreateLocationEfs Source #
Instance details Defined in Amazonka.DataSync.CreateLocationEfs Methods toPath :: CreateLocationEfs -> ByteString #
ToQuery CreateLocationEfs Source #
Instance details Defined in Amazonka.DataSync.CreateLocationEfs Methods toQuery :: CreateLocationEfs -> QueryString #
AWSRequest CreateLocationEfs Source #
Instance details Defined in Amazonka.DataSync.CreateLocationEfs Associated Types type AWSResponse CreateLocationEfs # Methods request :: (Service -> Service) -> CreateLocationEfs -> Request CreateLocationEfs # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateLocationEfs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateLocationEfs))) #
Generic CreateLocationEfs Source #
Instance details Defined in Amazonka.DataSync.CreateLocationEfs Associated Types type Rep CreateLocationEfs :: Type -> Type # Methods from :: CreateLocationEfs -> Rep CreateLocationEfs x # to :: Rep CreateLocationEfs x -> CreateLocationEfs #
Read CreateLocationEfs Source #
Instance details Defined in Amazonka.DataSync.CreateLocationEfs Methods readsPrec :: Int -> ReadS CreateLocationEfs # readList :: ReadS [CreateLocationEfs] # readPrec :: ReadPrec CreateLocationEfs # readListPrec :: ReadPrec [CreateLocationEfs] #
Show CreateLocationEfs Source #
Instance details Defined in Amazonka.DataSync.CreateLocationEfs Methods showsPrec :: Int -> CreateLocationEfs -> ShowS # show :: CreateLocationEfs -> String # showList :: [CreateLocationEfs] -> ShowS #
NFData CreateLocationEfs Source #
Instance details Defined in Amazonka.DataSync.CreateLocationEfs Methods rnf :: CreateLocationEfs -> () #
Eq CreateLocationEfs Source #
Instance details Defined in Amazonka.DataSync.CreateLocationEfs Methods (==) :: CreateLocationEfs -> CreateLocationEfs -> Bool # (/=) :: CreateLocationEfs -> CreateLocationEfs -> Bool #
Hashable CreateLocationEfs Source #
Instance details Defined in Amazonka.DataSync.CreateLocationEfs Methods hashWithSalt :: Int -> CreateLocationEfs -> Int # hash :: CreateLocationEfs -> Int #
type AWSResponse CreateLocationEfs Source #
Instance details Defined in Amazonka.DataSync.CreateLocationEfs type AWSResponse CreateLocationEfs = CreateLocationEfsResponse
type Rep CreateLocationEfs Source #
Instance details Defined in Amazonka.DataSync.CreateLocationEfs type Rep CreateLocationEfs = D1 ('MetaData "CreateLocationEfs" "Amazonka.DataSync.CreateLocationEfs" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "CreateLocationEfs'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessPointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "fileSystemAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "inTransitEncryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EfsInTransitEncryption)))) :: ((S1 ('MetaSel ('Just "subdirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagListEntry]))) :: (S1 ('MetaSel ('Just "efsFilesystemArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "ec2Config") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Ec2Config)))))

newCreateLocationEfs Source #

Arguments

:: Text	`$sel:efsFilesystemArn:CreateLocationEfs'`
-> Ec2Config	`$sel:ec2Config:CreateLocationEfs'`
-> CreateLocationEfs

Create a value of CreateLocationEfs 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:accessPointArn:CreateLocationEfs', createLocationEfs_accessPointArn - Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.

$sel:fileSystemAccessRoleArn:CreateLocationEfs', createLocationEfs_fileSystemAccessRoleArn - Specifies an Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.

$sel:inTransitEncryption:CreateLocationEfs', createLocationEfs_inTransitEncryption - Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the Amazon EFS file system.

If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn, you must set this parameter to TLS1_2.

$sel:subdirectory:CreateLocationEfs', createLocationEfs_subdirectory - Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location). By default, DataSync uses the root directory, but you can also include subdirectories.

You must specify a value with forward slashes (for example, /path/to/folder).

$sel:tags:CreateLocationEfs', createLocationEfs_tags - Specifies 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:efsFilesystemArn:CreateLocationEfs', createLocationEfs_efsFilesystemArn - Specifies the ARN for the Amazon EFS file system.

$sel:ec2Config:CreateLocationEfs', createLocationEfs_ec2Config - Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.

Request Lenses

createLocationEfs_accessPointArn :: Lens' CreateLocationEfs (Maybe Text) Source #

Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.

createLocationEfs_fileSystemAccessRoleArn :: Lens' CreateLocationEfs (Maybe Text) Source #

Specifies an Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.

createLocationEfs_inTransitEncryption :: Lens' CreateLocationEfs (Maybe EfsInTransitEncryption) Source #

Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the Amazon EFS file system.

If you specify an access point using AccessPointArn or an IAM role using FileSystemAccessRoleArn, you must set this parameter to TLS1_2.

createLocationEfs_subdirectory :: Lens' CreateLocationEfs (Maybe Text) Source #

Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location). By default, DataSync uses the root directory, but you can also include subdirectories.

You must specify a value with forward slashes (for example, /path/to/folder).

createLocationEfs_tags :: Lens' CreateLocationEfs (Maybe [TagListEntry]) Source #

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

createLocationEfs_efsFilesystemArn :: Lens' CreateLocationEfs Text Source #

Specifies the ARN for the Amazon EFS file system.

createLocationEfs_ec2Config :: Lens' CreateLocationEfs Ec2Config Source #

Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.

Destructuring the Response

data CreateLocationEfsResponse Source #

CreateLocationEfs

See: newCreateLocationEfsResponse smart constructor.

Constructors

CreateLocationEfsResponse'
Fields locationArn :: Maybe Text The Amazon Resource Name (ARN) of the Amazon EFS file system location that you create. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateLocationEfsResponse Source #

Arguments

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

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

CreateLocationEfsResponse, createLocationEfsResponse_locationArn - The Amazon Resource Name (ARN) of the Amazon EFS file system location that you create.

$sel:httpStatus:CreateLocationEfsResponse', createLocationEfsResponse_httpStatus - The response's http status code.

Response Lenses

createLocationEfsResponse_locationArn :: Lens' CreateLocationEfsResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon EFS file system location that you create.

createLocationEfsResponse_httpStatus :: Lens' CreateLocationEfsResponse Int Source #

The response's http status code.