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.EFS.CreateAccessPoint

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group override any identity information provided by the NFS client. The file system path is exposed as the access point's root directory. Applications using the access point can only access data in its own directory and below. To learn more, see Mounting a file system using EFS access points.

This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.

Synopsis

data CreateAccessPoint = CreateAccessPoint' {
- posixUser :: Maybe PosixUser
- rootDirectory :: Maybe RootDirectory
- tags :: Maybe [Tag]
- clientToken :: Text
- fileSystemId :: Text
}
newCreateAccessPoint :: Text -> Text -> CreateAccessPoint
createAccessPoint_posixUser :: Lens' CreateAccessPoint (Maybe PosixUser)
createAccessPoint_rootDirectory :: Lens' CreateAccessPoint (Maybe RootDirectory)
createAccessPoint_tags :: Lens' CreateAccessPoint (Maybe [Tag])
createAccessPoint_clientToken :: Lens' CreateAccessPoint Text
createAccessPoint_fileSystemId :: Lens' CreateAccessPoint Text
data AccessPointDescription = AccessPointDescription' {
- posixUser :: Maybe PosixUser
- rootDirectory :: Maybe RootDirectory
- clientToken :: Maybe Text
- accessPointId :: Maybe Text
- fileSystemId :: Maybe Text
- ownerId :: Maybe Text
- name :: Maybe Text
- accessPointArn :: Maybe Text
- lifeCycleState :: Maybe LifeCycleState
- tags :: Maybe [Tag]
}
newAccessPointDescription :: AccessPointDescription
accessPointDescription_posixUser :: Lens' AccessPointDescription (Maybe PosixUser)
accessPointDescription_rootDirectory :: Lens' AccessPointDescription (Maybe RootDirectory)
accessPointDescription_clientToken :: Lens' AccessPointDescription (Maybe Text)
accessPointDescription_accessPointId :: Lens' AccessPointDescription (Maybe Text)
accessPointDescription_fileSystemId :: Lens' AccessPointDescription (Maybe Text)
accessPointDescription_ownerId :: Lens' AccessPointDescription (Maybe Text)
accessPointDescription_name :: Lens' AccessPointDescription (Maybe Text)
accessPointDescription_accessPointArn :: Lens' AccessPointDescription (Maybe Text)
accessPointDescription_lifeCycleState :: Lens' AccessPointDescription (Maybe LifeCycleState)
accessPointDescription_tags :: Lens' AccessPointDescription (Maybe [Tag])

Creating a Request

data CreateAccessPoint Source #

See: newCreateAccessPoint smart constructor.

Constructors

CreateAccessPoint'

Fields

posixUser :: Maybe PosixUser
The operating system user and group applied to all file system requests made using the access point.
rootDirectory :: Maybe RootDirectory
Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory > Path specified does not exist, EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you need to provide the Path, and the CreationInfo.
Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.
tags :: Maybe [Tag]
Creates tags associated with the access point. Each tag is a key-value pair, each key must be unique. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
clientToken :: Text
A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
fileSystemId :: Text
The ID of the EFS file system that the access point provides access to.

Instances

Instances details

Eq CreateAccessPoint Source #
Instance details Defined in Amazonka.EFS.CreateAccessPoint Methods (==) :: CreateAccessPoint -> CreateAccessPoint -> Bool # (/=) :: CreateAccessPoint -> CreateAccessPoint -> Bool #
Read CreateAccessPoint Source #
Instance details Defined in Amazonka.EFS.CreateAccessPoint Methods readsPrec :: Int -> ReadS CreateAccessPoint # readList :: ReadS [CreateAccessPoint] # readPrec :: ReadPrec CreateAccessPoint # readListPrec :: ReadPrec [CreateAccessPoint] #
Show CreateAccessPoint Source #
Instance details Defined in Amazonka.EFS.CreateAccessPoint Methods showsPrec :: Int -> CreateAccessPoint -> ShowS # show :: CreateAccessPoint -> String # showList :: [CreateAccessPoint] -> ShowS #
Generic CreateAccessPoint Source #
Instance details Defined in Amazonka.EFS.CreateAccessPoint Associated Types type Rep CreateAccessPoint :: Type -> Type # Methods from :: CreateAccessPoint -> Rep CreateAccessPoint x # to :: Rep CreateAccessPoint x -> CreateAccessPoint #
NFData CreateAccessPoint Source #
Instance details Defined in Amazonka.EFS.CreateAccessPoint Methods rnf :: CreateAccessPoint -> () #
Hashable CreateAccessPoint Source #
Instance details Defined in Amazonka.EFS.CreateAccessPoint Methods hashWithSalt :: Int -> CreateAccessPoint -> Int # hash :: CreateAccessPoint -> Int #
ToJSON CreateAccessPoint Source #
Instance details Defined in Amazonka.EFS.CreateAccessPoint Methods toJSON :: CreateAccessPoint -> Value # toEncoding :: CreateAccessPoint -> Encoding # toJSONList :: [CreateAccessPoint] -> Value # toEncodingList :: [CreateAccessPoint] -> Encoding #
AWSRequest CreateAccessPoint Source #
Instance details Defined in Amazonka.EFS.CreateAccessPoint Associated Types type AWSResponse CreateAccessPoint # Methods request :: CreateAccessPoint -> Request CreateAccessPoint # response :: MonadResource m => Logger -> Service -> Proxy CreateAccessPoint -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAccessPoint))) #
ToHeaders CreateAccessPoint Source #
Instance details Defined in Amazonka.EFS.CreateAccessPoint Methods toHeaders :: CreateAccessPoint -> [Header] #
ToPath CreateAccessPoint Source #
Instance details Defined in Amazonka.EFS.CreateAccessPoint Methods toPath :: CreateAccessPoint -> ByteString #
ToQuery CreateAccessPoint Source #
Instance details Defined in Amazonka.EFS.CreateAccessPoint Methods toQuery :: CreateAccessPoint -> QueryString #
type Rep CreateAccessPoint Source #
Instance details Defined in Amazonka.EFS.CreateAccessPoint type Rep CreateAccessPoint = D1 ('MetaData "CreateAccessPoint" "Amazonka.EFS.CreateAccessPoint" "libZSservicesZSamazonka-efsZSamazonka-efs" 'False) (C1 ('MetaCons "CreateAccessPoint'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "posixUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PosixUser)) :: S1 ('MetaSel ('Just "rootDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RootDirectory))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateAccessPoint Source #
Instance details Defined in Amazonka.EFS.CreateAccessPoint type AWSResponse CreateAccessPoint = AccessPointDescription

newCreateAccessPoint Source #

Arguments

:: Text	`$sel:clientToken:CreateAccessPoint'`
-> Text	`$sel:fileSystemId:CreateAccessPoint'`
-> CreateAccessPoint

Create a value of CreateAccessPoint 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:posixUser:CreateAccessPoint', createAccessPoint_posixUser - The operating system user and group applied to all file system requests made using the access point.

$sel:rootDirectory:CreateAccessPoint', createAccessPoint_rootDirectory - Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory > Path specified does not exist, EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you need to provide the Path, and the CreationInfo.

Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.

$sel:tags:CreateAccessPoint', createAccessPoint_tags - Creates tags associated with the access point. Each tag is a key-value pair, each key must be unique. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

$sel:clientToken:CreateAccessPoint', createAccessPoint_clientToken - A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

$sel:fileSystemId:CreateAccessPoint', createAccessPoint_fileSystemId - The ID of the EFS file system that the access point provides access to.

Request Lenses

createAccessPoint_posixUser :: Lens' CreateAccessPoint (Maybe PosixUser) Source #

The operating system user and group applied to all file system requests made using the access point.

createAccessPoint_rootDirectory :: Lens' CreateAccessPoint (Maybe RootDirectory) Source #

Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory > Path specified does not exist, EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you need to provide the Path, and the CreationInfo.

Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.

createAccessPoint_tags :: Lens' CreateAccessPoint (Maybe [Tag]) Source #

Creates tags associated with the access point. Each tag is a key-value pair, each key must be unique. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

createAccessPoint_clientToken :: Lens' CreateAccessPoint Text Source #

A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

createAccessPoint_fileSystemId :: Lens' CreateAccessPoint Text Source #

The ID of the EFS file system that the access point provides access to.

Destructuring the Response

data AccessPointDescription Source #

Provides a description of an EFS file system access point.

See: newAccessPointDescription smart constructor.

Constructors

AccessPointDescription'

Fields

posixUser :: Maybe PosixUser
The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
rootDirectory :: Maybe RootDirectory
The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
clientToken :: Maybe Text
The opaque string specified in the request to ensure idempotent creation.
accessPointId :: Maybe Text
The ID of the access point, assigned by Amazon EFS.
fileSystemId :: Maybe Text
The ID of the EFS file system that the access point applies to.
ownerId :: Maybe Text
Identified the Amazon Web Services account that owns the access point resource.
name :: Maybe Text
The name of the access point. This is the value of the Name tag.
accessPointArn :: Maybe Text
The unique Amazon Resource Name (ARN) associated with the access point.
lifeCycleState :: Maybe LifeCycleState
Identifies the lifecycle phase of the access point.
tags :: Maybe [Tag]
The tags associated with the access point, presented as an array of Tag objects.

Instances

Instances details

Eq AccessPointDescription Source #
Instance details Defined in Amazonka.EFS.Types.AccessPointDescription Methods (==) :: AccessPointDescription -> AccessPointDescription -> Bool # (/=) :: AccessPointDescription -> AccessPointDescription -> Bool #
Read AccessPointDescription Source #
Instance details Defined in Amazonka.EFS.Types.AccessPointDescription Methods readsPrec :: Int -> ReadS AccessPointDescription # readList :: ReadS [AccessPointDescription] # readPrec :: ReadPrec AccessPointDescription # readListPrec :: ReadPrec [AccessPointDescription] #
Show AccessPointDescription Source #
Instance details Defined in Amazonka.EFS.Types.AccessPointDescription Methods showsPrec :: Int -> AccessPointDescription -> ShowS # show :: AccessPointDescription -> String # showList :: [AccessPointDescription] -> ShowS #
Generic AccessPointDescription Source #
Instance details Defined in Amazonka.EFS.Types.AccessPointDescription Associated Types type Rep AccessPointDescription :: Type -> Type # Methods from :: AccessPointDescription -> Rep AccessPointDescription x # to :: Rep AccessPointDescription x -> AccessPointDescription #
NFData AccessPointDescription Source #
Instance details Defined in Amazonka.EFS.Types.AccessPointDescription Methods rnf :: AccessPointDescription -> () #
Hashable AccessPointDescription Source #
Instance details Defined in Amazonka.EFS.Types.AccessPointDescription Methods hashWithSalt :: Int -> AccessPointDescription -> Int # hash :: AccessPointDescription -> Int #
FromJSON AccessPointDescription Source #
Instance details Defined in Amazonka.EFS.Types.AccessPointDescription Methods parseJSON :: Value -> Parser AccessPointDescription # parseJSONList :: Value -> Parser [AccessPointDescription] #
type Rep AccessPointDescription Source #
Instance details Defined in Amazonka.EFS.Types.AccessPointDescription type Rep AccessPointDescription = D1 ('MetaData "AccessPointDescription" "Amazonka.EFS.Types.AccessPointDescription" "libZSservicesZSamazonka-efsZSamazonka-efs" 'False) (C1 ('MetaCons "AccessPointDescription'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "posixUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PosixUser)) :: S1 ('MetaSel ('Just "rootDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RootDirectory))) :: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "accessPointId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "ownerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "accessPointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lifeCycleState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LifeCycleState)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))))))

newAccessPointDescription :: AccessPointDescription Source #

Create a value of AccessPointDescription 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:posixUser:AccessPointDescription', accessPointDescription_posixUser - The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.

$sel:rootDirectory:AccessPointDescription', accessPointDescription_rootDirectory - The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.

$sel:clientToken:AccessPointDescription', accessPointDescription_clientToken - The opaque string specified in the request to ensure idempotent creation.

$sel:accessPointId:AccessPointDescription', accessPointDescription_accessPointId - The ID of the access point, assigned by Amazon EFS.

$sel:fileSystemId:AccessPointDescription', accessPointDescription_fileSystemId - The ID of the EFS file system that the access point applies to.

$sel:ownerId:AccessPointDescription', accessPointDescription_ownerId - Identified the Amazon Web Services account that owns the access point resource.

$sel:name:AccessPointDescription', accessPointDescription_name - The name of the access point. This is the value of the Name tag.

$sel:accessPointArn:AccessPointDescription', accessPointDescription_accessPointArn - The unique Amazon Resource Name (ARN) associated with the access point.

$sel:lifeCycleState:AccessPointDescription', accessPointDescription_lifeCycleState - Identifies the lifecycle phase of the access point.

$sel:tags:AccessPointDescription', accessPointDescription_tags - The tags associated with the access point, presented as an array of Tag objects.

Response Lenses

accessPointDescription_posixUser :: Lens' AccessPointDescription (Maybe PosixUser) Source #

The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.

accessPointDescription_rootDirectory :: Lens' AccessPointDescription (Maybe RootDirectory) Source #

The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.

accessPointDescription_clientToken :: Lens' AccessPointDescription (Maybe Text) Source #

The opaque string specified in the request to ensure idempotent creation.

accessPointDescription_accessPointId :: Lens' AccessPointDescription (Maybe Text) Source #

The ID of the access point, assigned by Amazon EFS.

accessPointDescription_fileSystemId :: Lens' AccessPointDescription (Maybe Text) Source #

The ID of the EFS file system that the access point applies to.

accessPointDescription_ownerId :: Lens' AccessPointDescription (Maybe Text) Source #

Identified the Amazon Web Services account that owns the access point resource.

accessPointDescription_name :: Lens' AccessPointDescription (Maybe Text) Source #

The name of the access point. This is the value of the Name tag.