| 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.EFS
Contents
- Service Configuration
- Errors
- AccessPointAlreadyExists
- AccessPointLimitExceeded
- AccessPointNotFound
- AvailabilityZonesMismatch
- BadRequest
- DependencyTimeout
- FileSystemAlreadyExists
- FileSystemInUse
- FileSystemLimitExceeded
- FileSystemNotFound
- IncorrectFileSystemLifeCycleState
- IncorrectMountTargetState
- InsufficientThroughputCapacity
- InternalServerError
- InvalidPolicyException
- IpAddressInUse
- MountTargetConflict
- MountTargetNotFound
- NetworkInterfaceLimitExceeded
- NoFreeAddressesInSubnet
- PolicyNotFound
- ReplicationNotFound
- SecurityGroupLimitExceeded
- SecurityGroupNotFound
- SubnetNotFound
- ThrottlingException
- ThroughputLimitExceeded
- TooManyRequests
- UnsupportedAvailabilityZone
- ValidationException
- Waiters
- Operations
- CreateAccessPoint
- CreateFileSystem
- CreateMountTarget
- CreateReplicationConfiguration
- DeleteAccessPoint
- DeleteFileSystem
- DeleteFileSystemPolicy
- DeleteMountTarget
- DeleteReplicationConfiguration
- DescribeAccessPoints
- DescribeAccountPreferences
- DescribeBackupPolicy
- DescribeFileSystemPolicy
- DescribeFileSystems (Paginated)
- DescribeLifecycleConfiguration
- DescribeMountTargetSecurityGroups
- DescribeMountTargets (Paginated)
- DescribeReplicationConfigurations
- ListTagsForResource
- ModifyMountTargetSecurityGroups
- PutAccountPreferences
- PutBackupPolicy
- PutFileSystemPolicy
- PutLifecycleConfiguration
- TagResource
- UntagResource
- UpdateFileSystem
- Types
- BackupStatus
- LifeCycleState
- PerformanceMode
- ReplicationStatus
- Resource
- ResourceIdType
- ThroughputMode
- TransitionToIARules
- TransitionToPrimaryStorageClassRules
- AccessPointDescription
- BackupPolicy
- BackupPolicyDescription
- CreationInfo
- Destination
- DestinationToCreate
- FileSystemDescription
- FileSystemPolicyDescription
- FileSystemSize
- LifecycleConfigurationDescription
- LifecyclePolicy
- MountTargetDescription
- PosixUser
- ReplicationConfigurationDescription
- ResourceIdPreference
- RootDirectory
- Tag
Description
Derived from API version 2015-02-01 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Elastic File System
Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so that your applications have the storage they need, when they need it. For more information, see the Amazon Elastic File System API Reference and the Amazon Elastic File System User Guide.
Synopsis
- defaultService :: Service
- _AccessPointAlreadyExists :: AsError a => Fold a ServiceError
- _AccessPointLimitExceeded :: AsError a => Fold a ServiceError
- _AccessPointNotFound :: AsError a => Fold a ServiceError
- _AvailabilityZonesMismatch :: AsError a => Fold a ServiceError
- _BadRequest :: AsError a => Fold a ServiceError
- _DependencyTimeout :: AsError a => Fold a ServiceError
- _FileSystemAlreadyExists :: AsError a => Fold a ServiceError
- _FileSystemInUse :: AsError a => Fold a ServiceError
- _FileSystemLimitExceeded :: AsError a => Fold a ServiceError
- _FileSystemNotFound :: AsError a => Fold a ServiceError
- _IncorrectFileSystemLifeCycleState :: AsError a => Fold a ServiceError
- _IncorrectMountTargetState :: AsError a => Fold a ServiceError
- _InsufficientThroughputCapacity :: AsError a => Fold a ServiceError
- _InternalServerError :: AsError a => Fold a ServiceError
- _InvalidPolicyException :: AsError a => Fold a ServiceError
- _IpAddressInUse :: AsError a => Fold a ServiceError
- _MountTargetConflict :: AsError a => Fold a ServiceError
- _MountTargetNotFound :: AsError a => Fold a ServiceError
- _NetworkInterfaceLimitExceeded :: AsError a => Fold a ServiceError
- _NoFreeAddressesInSubnet :: AsError a => Fold a ServiceError
- _PolicyNotFound :: AsError a => Fold a ServiceError
- _ReplicationNotFound :: AsError a => Fold a ServiceError
- _SecurityGroupLimitExceeded :: AsError a => Fold a ServiceError
- _SecurityGroupNotFound :: AsError a => Fold a ServiceError
- _SubnetNotFound :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ThroughputLimitExceeded :: AsError a => Fold a ServiceError
- _TooManyRequests :: AsError a => Fold a ServiceError
- _UnsupportedAvailabilityZone :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CreateAccessPoint = CreateAccessPoint' (Maybe PosixUser) (Maybe RootDirectory) (Maybe [Tag]) Text Text
- newCreateAccessPoint :: Text -> Text -> CreateAccessPoint
- data AccessPointDescription = AccessPointDescription' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe LifeCycleState) (Maybe Text) (Maybe Text) (Maybe PosixUser) (Maybe RootDirectory) (Maybe [Tag])
- newAccessPointDescription :: AccessPointDescription
- data CreateFileSystem = CreateFileSystem' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe PerformanceMode) (Maybe Double) (Maybe [Tag]) (Maybe ThroughputMode) Text
- newCreateFileSystem :: Text -> CreateFileSystem
- data FileSystemDescription = FileSystemDescription' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe ThroughputMode) Text Text Text POSIX LifeCycleState Natural FileSystemSize PerformanceMode [Tag]
- newFileSystemDescription :: Text -> Text -> Text -> UTCTime -> LifeCycleState -> Natural -> FileSystemSize -> PerformanceMode -> FileSystemDescription
- data CreateMountTarget = CreateMountTarget' (Maybe Text) (Maybe [Text]) Text Text
- newCreateMountTarget :: Text -> Text -> CreateMountTarget
- data MountTargetDescription = MountTargetDescription' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text Text LifeCycleState
- newMountTargetDescription :: Text -> Text -> Text -> LifeCycleState -> MountTargetDescription
- data CreateReplicationConfiguration = CreateReplicationConfiguration' Text [DestinationToCreate]
- newCreateReplicationConfiguration :: Text -> CreateReplicationConfiguration
- data ReplicationConfigurationDescription = ReplicationConfigurationDescription' Text Text Text Text POSIX [Destination]
- newReplicationConfigurationDescription :: Text -> Text -> Text -> Text -> UTCTime -> ReplicationConfigurationDescription
- data DeleteAccessPoint = DeleteAccessPoint' Text
- newDeleteAccessPoint :: Text -> DeleteAccessPoint
- data DeleteAccessPointResponse = DeleteAccessPointResponse' {
- newDeleteAccessPointResponse :: DeleteAccessPointResponse
- data DeleteFileSystem = DeleteFileSystem' Text
- newDeleteFileSystem :: Text -> DeleteFileSystem
- data DeleteFileSystemResponse = DeleteFileSystemResponse' {
- newDeleteFileSystemResponse :: DeleteFileSystemResponse
- data DeleteFileSystemPolicy = DeleteFileSystemPolicy' Text
- newDeleteFileSystemPolicy :: Text -> DeleteFileSystemPolicy
- data DeleteFileSystemPolicyResponse = DeleteFileSystemPolicyResponse' {
- newDeleteFileSystemPolicyResponse :: DeleteFileSystemPolicyResponse
- data DeleteMountTarget = DeleteMountTarget' Text
- newDeleteMountTarget :: Text -> DeleteMountTarget
- data DeleteMountTargetResponse = DeleteMountTargetResponse' {
- newDeleteMountTargetResponse :: DeleteMountTargetResponse
- data DeleteReplicationConfiguration = DeleteReplicationConfiguration' Text
- newDeleteReplicationConfiguration :: Text -> DeleteReplicationConfiguration
- data DeleteReplicationConfigurationResponse = DeleteReplicationConfigurationResponse' {
- newDeleteReplicationConfigurationResponse :: DeleteReplicationConfigurationResponse
- data DescribeAccessPoints = DescribeAccessPoints' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text)
- newDescribeAccessPoints :: DescribeAccessPoints
- data DescribeAccessPointsResponse = DescribeAccessPointsResponse' (Maybe [AccessPointDescription]) (Maybe Text) Int
- newDescribeAccessPointsResponse :: Int -> DescribeAccessPointsResponse
- data DescribeAccountPreferences = DescribeAccountPreferences' (Maybe Natural) (Maybe Text)
- newDescribeAccountPreferences :: DescribeAccountPreferences
- data DescribeAccountPreferencesResponse = DescribeAccountPreferencesResponse' (Maybe Text) (Maybe ResourceIdPreference) Int
- newDescribeAccountPreferencesResponse :: Int -> DescribeAccountPreferencesResponse
- data DescribeBackupPolicy = DescribeBackupPolicy' Text
- newDescribeBackupPolicy :: Text -> DescribeBackupPolicy
- data BackupPolicyDescription = BackupPolicyDescription' (Maybe BackupPolicy)
- newBackupPolicyDescription :: BackupPolicyDescription
- data DescribeFileSystemPolicy = DescribeFileSystemPolicy' Text
- newDescribeFileSystemPolicy :: Text -> DescribeFileSystemPolicy
- data FileSystemPolicyDescription = FileSystemPolicyDescription' (Maybe Text) (Maybe Text)
- newFileSystemPolicyDescription :: FileSystemPolicyDescription
- data DescribeFileSystems = DescribeFileSystems' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural)
- newDescribeFileSystems :: DescribeFileSystems
- data DescribeFileSystemsResponse = DescribeFileSystemsResponse' (Maybe [FileSystemDescription]) (Maybe Text) (Maybe Text) Int
- newDescribeFileSystemsResponse :: Int -> DescribeFileSystemsResponse
- data DescribeLifecycleConfiguration = DescribeLifecycleConfiguration' Text
- newDescribeLifecycleConfiguration :: Text -> DescribeLifecycleConfiguration
- data LifecycleConfigurationDescription = LifecycleConfigurationDescription' (Maybe [LifecyclePolicy])
- newLifecycleConfigurationDescription :: LifecycleConfigurationDescription
- data DescribeMountTargetSecurityGroups = DescribeMountTargetSecurityGroups' Text
- newDescribeMountTargetSecurityGroups :: Text -> DescribeMountTargetSecurityGroups
- data DescribeMountTargetSecurityGroupsResponse = DescribeMountTargetSecurityGroupsResponse' Int [Text]
- newDescribeMountTargetSecurityGroupsResponse :: Int -> DescribeMountTargetSecurityGroupsResponse
- data DescribeMountTargets = DescribeMountTargets' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text)
- newDescribeMountTargets :: DescribeMountTargets
- data DescribeMountTargetsResponse = DescribeMountTargetsResponse' (Maybe Text) (Maybe [MountTargetDescription]) (Maybe Text) Int
- newDescribeMountTargetsResponse :: Int -> DescribeMountTargetsResponse
- data DescribeReplicationConfigurations = DescribeReplicationConfigurations' (Maybe Text) (Maybe Natural) (Maybe Text)
- newDescribeReplicationConfigurations :: DescribeReplicationConfigurations
- data DescribeReplicationConfigurationsResponse = DescribeReplicationConfigurationsResponse' (Maybe Text) (Maybe [ReplicationConfigurationDescription]) Int
- newDescribeReplicationConfigurationsResponse :: Int -> DescribeReplicationConfigurationsResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Natural) (Maybe Text) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ModifyMountTargetSecurityGroups = ModifyMountTargetSecurityGroups' (Maybe [Text]) Text
- newModifyMountTargetSecurityGroups :: Text -> ModifyMountTargetSecurityGroups
- data ModifyMountTargetSecurityGroupsResponse = ModifyMountTargetSecurityGroupsResponse' {
- newModifyMountTargetSecurityGroupsResponse :: ModifyMountTargetSecurityGroupsResponse
- data PutAccountPreferences = PutAccountPreferences' ResourceIdType
- newPutAccountPreferences :: ResourceIdType -> PutAccountPreferences
- data PutAccountPreferencesResponse = PutAccountPreferencesResponse' (Maybe ResourceIdPreference) Int
- newPutAccountPreferencesResponse :: Int -> PutAccountPreferencesResponse
- data PutBackupPolicy = PutBackupPolicy' Text BackupPolicy
- newPutBackupPolicy :: Text -> BackupPolicy -> PutBackupPolicy
- data BackupPolicyDescription = BackupPolicyDescription' (Maybe BackupPolicy)
- newBackupPolicyDescription :: BackupPolicyDescription
- data PutFileSystemPolicy = PutFileSystemPolicy' (Maybe Bool) Text Text
- newPutFileSystemPolicy :: Text -> Text -> PutFileSystemPolicy
- data FileSystemPolicyDescription = FileSystemPolicyDescription' (Maybe Text) (Maybe Text)
- newFileSystemPolicyDescription :: FileSystemPolicyDescription
- data PutLifecycleConfiguration = PutLifecycleConfiguration' Text [LifecyclePolicy]
- newPutLifecycleConfiguration :: Text -> PutLifecycleConfiguration
- data LifecycleConfigurationDescription = LifecycleConfigurationDescription' (Maybe [LifecyclePolicy])
- newLifecycleConfigurationDescription :: LifecycleConfigurationDescription
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data UpdateFileSystem = UpdateFileSystem' (Maybe Double) (Maybe ThroughputMode) Text
- newUpdateFileSystem :: Text -> UpdateFileSystem
- data FileSystemDescription = FileSystemDescription' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe ThroughputMode) Text Text Text POSIX LifeCycleState Natural FileSystemSize PerformanceMode [Tag]
- newFileSystemDescription :: Text -> Text -> Text -> UTCTime -> LifeCycleState -> Natural -> FileSystemSize -> PerformanceMode -> FileSystemDescription
- newtype BackupStatus where
- BackupStatus' { }
- pattern BackupStatus_DISABLED :: BackupStatus
- pattern BackupStatus_DISABLING :: BackupStatus
- pattern BackupStatus_ENABLED :: BackupStatus
- pattern BackupStatus_ENABLING :: BackupStatus
- newtype LifeCycleState where
- LifeCycleState' { }
- pattern LifeCycleState_Available :: LifeCycleState
- pattern LifeCycleState_Creating :: LifeCycleState
- pattern LifeCycleState_Deleted :: LifeCycleState
- pattern LifeCycleState_Deleting :: LifeCycleState
- pattern LifeCycleState_Error :: LifeCycleState
- pattern LifeCycleState_Updating :: LifeCycleState
- newtype PerformanceMode where
- PerformanceMode' { }
- pattern PerformanceMode_GeneralPurpose :: PerformanceMode
- pattern PerformanceMode_MaxIO :: PerformanceMode
- newtype ReplicationStatus where
- ReplicationStatus' { }
- pattern ReplicationStatus_DELETING :: ReplicationStatus
- pattern ReplicationStatus_ENABLED :: ReplicationStatus
- pattern ReplicationStatus_ENABLING :: ReplicationStatus
- pattern ReplicationStatus_ERROR :: ReplicationStatus
- newtype Resource where
- Resource' {
- fromResource :: Text
- pattern Resource_FILE_SYSTEM :: Resource
- pattern Resource_MOUNT_TARGET :: Resource
- Resource' {
- newtype ResourceIdType where
- ResourceIdType' { }
- pattern ResourceIdType_LONG_ID :: ResourceIdType
- pattern ResourceIdType_SHORT_ID :: ResourceIdType
- newtype ThroughputMode where
- ThroughputMode' { }
- pattern ThroughputMode_Bursting :: ThroughputMode
- pattern ThroughputMode_Elastic :: ThroughputMode
- pattern ThroughputMode_Provisioned :: ThroughputMode
- newtype TransitionToIARules where
- TransitionToIARules' { }
- pattern TransitionToIARules_AFTER_14_DAYS :: TransitionToIARules
- pattern TransitionToIARules_AFTER_1_DAY :: TransitionToIARules
- pattern TransitionToIARules_AFTER_30_DAYS :: TransitionToIARules
- pattern TransitionToIARules_AFTER_60_DAYS :: TransitionToIARules
- pattern TransitionToIARules_AFTER_7_DAYS :: TransitionToIARules
- pattern TransitionToIARules_AFTER_90_DAYS :: TransitionToIARules
- newtype TransitionToPrimaryStorageClassRules where
- data AccessPointDescription = AccessPointDescription' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe LifeCycleState) (Maybe Text) (Maybe Text) (Maybe PosixUser) (Maybe RootDirectory) (Maybe [Tag])
- newAccessPointDescription :: AccessPointDescription
- data BackupPolicy = BackupPolicy' BackupStatus
- newBackupPolicy :: BackupStatus -> BackupPolicy
- data BackupPolicyDescription = BackupPolicyDescription' (Maybe BackupPolicy)
- newBackupPolicyDescription :: BackupPolicyDescription
- data CreationInfo = CreationInfo' Natural Natural Text
- newCreationInfo :: Natural -> Natural -> Text -> CreationInfo
- data Destination = Destination' (Maybe POSIX) ReplicationStatus Text Text
- newDestination :: ReplicationStatus -> Text -> Text -> Destination
- data DestinationToCreate = DestinationToCreate' (Maybe Text) (Maybe Text) (Maybe Text)
- newDestinationToCreate :: DestinationToCreate
- data FileSystemDescription = FileSystemDescription' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe ThroughputMode) Text Text Text POSIX LifeCycleState Natural FileSystemSize PerformanceMode [Tag]
- newFileSystemDescription :: Text -> Text -> Text -> UTCTime -> LifeCycleState -> Natural -> FileSystemSize -> PerformanceMode -> FileSystemDescription
- data FileSystemPolicyDescription = FileSystemPolicyDescription' (Maybe Text) (Maybe Text)
- newFileSystemPolicyDescription :: FileSystemPolicyDescription
- data FileSystemSize = FileSystemSize' (Maybe POSIX) (Maybe Natural) (Maybe Natural) Natural
- newFileSystemSize :: Natural -> FileSystemSize
- data LifecycleConfigurationDescription = LifecycleConfigurationDescription' (Maybe [LifecyclePolicy])
- newLifecycleConfigurationDescription :: LifecycleConfigurationDescription
- data LifecyclePolicy = LifecyclePolicy' (Maybe TransitionToIARules) (Maybe TransitionToPrimaryStorageClassRules)
- newLifecyclePolicy :: LifecyclePolicy
- data MountTargetDescription = MountTargetDescription' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text Text LifeCycleState
- newMountTargetDescription :: Text -> Text -> Text -> LifeCycleState -> MountTargetDescription
- data PosixUser = PosixUser' (Maybe [Natural]) Natural Natural
- newPosixUser :: Natural -> Natural -> PosixUser
- data ReplicationConfigurationDescription = ReplicationConfigurationDescription' Text Text Text Text POSIX [Destination]
- newReplicationConfigurationDescription :: Text -> Text -> Text -> Text -> UTCTime -> ReplicationConfigurationDescription
- data ResourceIdPreference = ResourceIdPreference' (Maybe ResourceIdType) (Maybe [Resource])
- newResourceIdPreference :: ResourceIdPreference
- data RootDirectory = RootDirectory' (Maybe CreationInfo) (Maybe Text)
- newRootDirectory :: RootDirectory
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
Service Configuration
defaultService :: Service Source #
API version 2015-02-01 of the Amazon Elastic File System SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by EFS.
AccessPointAlreadyExists
_AccessPointAlreadyExists :: AsError a => Fold a ServiceError Source #
Returned if the access point that you are trying to create already exists, with the creation token you provided in the request.
AccessPointLimitExceeded
_AccessPointLimitExceeded :: AsError a => Fold a ServiceError Source #
Returned if the Amazon Web Services account has already created the maximum number of access points allowed per file system. For more informaton, see https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region.
AccessPointNotFound
_AccessPointNotFound :: AsError a => Fold a ServiceError Source #
Returned if the specified AccessPointId value doesn't exist in the
requester's Amazon Web Services account.
AvailabilityZonesMismatch
_AvailabilityZonesMismatch :: AsError a => Fold a ServiceError Source #
Returned if the Availability Zone that was specified for a mount target is different from the Availability Zone that was specified for One Zone storage. For more information, see Regional and One Zone storage redundancy.
BadRequest
_BadRequest :: AsError a => Fold a ServiceError Source #
Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.
DependencyTimeout
_DependencyTimeout :: AsError a => Fold a ServiceError Source #
The service timed out trying to fulfill the request, and the client should try the call again.
FileSystemAlreadyExists
_FileSystemAlreadyExists :: AsError a => Fold a ServiceError Source #
Returned if the file system you are trying to create already exists, with the creation token you provided.
FileSystemInUse
_FileSystemInUse :: AsError a => Fold a ServiceError Source #
Returned if a file system has mount targets.
FileSystemLimitExceeded
_FileSystemLimitExceeded :: AsError a => Fold a ServiceError Source #
Returned if the Amazon Web Services account has already created the maximum number of file systems allowed per account.
FileSystemNotFound
_FileSystemNotFound :: AsError a => Fold a ServiceError Source #
Returned if the specified FileSystemId value doesn't exist in the
requester's Amazon Web Services account.
IncorrectFileSystemLifeCycleState
_IncorrectFileSystemLifeCycleState :: AsError a => Fold a ServiceError Source #
Returned if the file system's lifecycle state is not "available".
IncorrectMountTargetState
_IncorrectMountTargetState :: AsError a => Fold a ServiceError Source #
Returned if the mount target is not in the correct state for the operation.
InsufficientThroughputCapacity
_InsufficientThroughputCapacity :: AsError a => Fold a ServiceError Source #
Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.
InternalServerError
_InternalServerError :: AsError a => Fold a ServiceError Source #
Returned if an error occurred on the server side.
InvalidPolicyException
_InvalidPolicyException :: AsError a => Fold a ServiceError Source #
Returned if the FileSystemPolicy is malformed or contains an error
such as a parameter value that is not valid or a missing required
parameter. Returned in the case of a policy lockout safety check error.
IpAddressInUse
_IpAddressInUse :: AsError a => Fold a ServiceError Source #
Returned if the request specified an IpAddress that is already in use
in the subnet.
MountTargetConflict
_MountTargetConflict :: AsError a => Fold a ServiceError Source #
Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.
MountTargetNotFound
_MountTargetNotFound :: AsError a => Fold a ServiceError Source #
Returned if there is no mount target with the specified ID found in the caller's Amazon Web Services account.
NetworkInterfaceLimitExceeded
_NetworkInterfaceLimitExceeded :: AsError a => Fold a ServiceError Source #
The calling account has reached the limit for elastic network interfaces for the specific Amazon Web Services Region. Either delete some network interfaces or request that the account quota be raised. For more information, see Amazon VPC Quotas in the Amazon VPC User Guide (see the __Network interfaces per Region entry in the Network interfaces__ table).
NoFreeAddressesInSubnet
_NoFreeAddressesInSubnet :: AsError a => Fold a ServiceError Source #
Returned if IpAddress was not specified in the request and there are
no free IP addresses in the subnet.
PolicyNotFound
_PolicyNotFound :: AsError a => Fold a ServiceError Source #
Returned if the default file system policy is in effect for the EFS file system specified.
ReplicationNotFound
_ReplicationNotFound :: AsError a => Fold a ServiceError Source #
Returned if the specified file system does not have a replication configuration.
SecurityGroupLimitExceeded
_SecurityGroupLimitExceeded :: AsError a => Fold a ServiceError Source #
Returned if the size of SecurityGroups specified in the request is
greater than five.
SecurityGroupNotFound
_SecurityGroupNotFound :: AsError a => Fold a ServiceError Source #
Returned if one of the specified security groups doesn't exist in the subnet's virtual private cloud (VPC).
SubnetNotFound
_SubnetNotFound :: AsError a => Fold a ServiceError Source #
Returned if there is no subnet with ID SubnetId provided in the
request.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
Returned when the CreateAccessPoint API action is called too quickly
and the number of Access Points on the file system is nearing the
limit of 120.
ThroughputLimitExceeded
_ThroughputLimitExceeded :: AsError a => Fold a ServiceError Source #
Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.
TooManyRequests
_TooManyRequests :: AsError a => Fold a ServiceError Source #
Returned if you don’t wait at least 24 hours before either changing the throughput mode, or decreasing the Provisioned Throughput value.
UnsupportedAvailabilityZone
_UnsupportedAvailabilityZone :: AsError a => Fold a ServiceError Source #
Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateAccessPoint
data CreateAccessPoint Source #
See: newCreateAccessPoint smart constructor.
Constructors
| CreateAccessPoint' (Maybe PosixUser) (Maybe RootDirectory) (Maybe [Tag]) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> 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:
CreateAccessPoint, createAccessPoint_posixUser - The operating system user and group applied to all file system requests
made using the access point.
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 must 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, 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.
CreateAccessPoint, createAccessPoint_clientToken - A string of up to 64 ASCII characters that Amazon EFS uses to ensure
idempotent creation.
CreateAccessPoint, createAccessPoint_fileSystemId - The ID of the EFS file system that the access point provides access to.
data AccessPointDescription Source #
Provides a description of an EFS file system access point.
See: newAccessPointDescription smart constructor.
Constructors
| AccessPointDescription' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe LifeCycleState) (Maybe Text) (Maybe Text) (Maybe PosixUser) (Maybe RootDirectory) (Maybe [Tag]) |
Instances
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:accessPointArn:AccessPointDescription', accessPointDescription_accessPointArn - The unique Amazon Resource Name (ARN) associated with the access point.
$sel:accessPointId:AccessPointDescription', accessPointDescription_accessPointId - The ID of the access point, assigned by Amazon EFS.
$sel:clientToken:AccessPointDescription', accessPointDescription_clientToken - The opaque string specified in the request to ensure idempotent
creation.
$sel:fileSystemId:AccessPointDescription', accessPointDescription_fileSystemId - The ID of the EFS file system that the access point applies to.
$sel:lifeCycleState:AccessPointDescription', accessPointDescription_lifeCycleState - Identifies the lifecycle phase of the access point.
$sel:name:AccessPointDescription', accessPointDescription_name - The name of the access point. This is the value of the Name tag.
$sel:ownerId:AccessPointDescription', accessPointDescription_ownerId - Identified the Amazon Web Services account that owns the access point
resource.
$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:tags:AccessPointDescription', accessPointDescription_tags - The tags associated with the access point, presented as an array of Tag
objects.
CreateFileSystem
data CreateFileSystem Source #
See: newCreateFileSystem smart constructor.
Constructors
| CreateFileSystem' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe PerformanceMode) (Maybe Double) (Maybe [Tag]) (Maybe ThroughputMode) Text |
Instances
Arguments
| :: Text | |
| -> CreateFileSystem |
Create a value of CreateFileSystem 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:
CreateFileSystem, createFileSystem_availabilityZoneName - Used to create a file system that uses One Zone storage classes. It
specifies the Amazon Web Services Availability Zone in which to create
the file system. Use the format us-east-1a to specify the Availability
Zone. For more information about One Zone storage classes, see
Using EFS storage classes
in the Amazon EFS User Guide.
One Zone storage classes are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available.
$sel:backup:CreateFileSystem', createFileSystem_backup - Specifies whether automatic backups are enabled on the file system that
you are creating. Set the value to true to enable automatic backups.
If you are creating a file system that uses One Zone storage classes,
automatic backups are enabled by default. For more information, see
Automatic backups
in the Amazon EFS User Guide.
Default is false. However, if you specify an AvailabilityZoneName,
the default is true.
Backup is not available in all Amazon Web Services Regions where Amazon EFS is available.
CreateFileSystem, createFileSystem_encrypted - A Boolean value that, if true, creates an encrypted file system. When
creating an encrypted file system, you have the option of specifying an
existing Key Management Service key (KMS key). If you don't specify a
KMS key, then the default KMS key for Amazon EFS,
/aws/elasticfilesystem, is used to protect the encrypted file
system.
CreateFileSystem, createFileSystem_kmsKeyId - The ID of the KMS key that you want to use to protect the encrypted file
system. This parameter is required only if you want to use a non-default
KMS key. If this parameter is not specified, the default KMS key for
Amazon EFS is used. You can specify a KMS key ID using the following
formats:
- Key ID - A unique identifier of the key, for example
1234abcd-12ab-34cd-56ef-1234567890ab. - ARN - An Amazon Resource Name (ARN) for the key, for example
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Key alias - A previously created display name for a key, for example
alias/projectKey1. - Key alias ARN - An ARN for a key alias, for example
arn:aws:kms:us-west-2:444455556666:alias/projectKey1.
If you use KmsKeyId, you must set the
CreateFileSystemRequest$Encrypted parameter to true.
EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with Amazon EFS file systems.
CreateFileSystem, createFileSystem_performanceMode - The performance mode of the file system. We recommend generalPurpose
performance mode for most file systems. File systems using the maxIO
performance mode can scale to higher levels of aggregate throughput and
operations per second with a tradeoff of slightly higher latencies for
most file operations. The performance mode can't be changed after the
file system has been created.
The maxIO mode is not supported on file systems using One Zone storage
classes.
CreateFileSystem, createFileSystem_provisionedThroughputInMibps - The throughput, measured in MiB/s, that you want to provision for a
file system that you're creating. Valid values are 1-1024. Required if
ThroughputMode is set to provisioned. The upper limit for throughput
is 1024 MiB/s. To increase this limit, contact Amazon Web Services
Support. For more information, see
Amazon EFS quotas that you can increase
in the Amazon EFS User Guide.
CreateFileSystem, createFileSystem_tags - Use to create one or more tags associated with the file system. Each tag
is a user-defined key-value pair. Name your file system on creation by
including a "Key":"Name","Value":"{value}" 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.
CreateFileSystem, createFileSystem_throughputMode - Specifies the throughput mode for the file system. The mode can be
bursting, provisioned, or elastic. If you set ThroughputMode to
provisioned, you must also set a value for
ProvisionedThroughputInMibps. After you create the file system, you
can decrease your file system's throughput in Provisioned Throughput
mode or change between the throughput modes, with certain time
restrictions. For more information, see
Specifying throughput with provisioned mode
in the Amazon EFS User Guide.
Default is bursting.
CreateFileSystem, createFileSystem_creationToken - A string of up to 64 ASCII characters. Amazon EFS uses this to ensure
idempotent creation.
data FileSystemDescription Source #
A description of the file system.
See: newFileSystemDescription smart constructor.
Constructors
Instances
newFileSystemDescription Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> LifeCycleState | |
| -> Natural | |
| -> FileSystemSize | |
| -> PerformanceMode | |
| -> FileSystemDescription |
Create a value of FileSystemDescription 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:availabilityZoneId:FileSystemDescription', fileSystemDescription_availabilityZoneId - The unique and consistent identifier of the Availability Zone in which
the file system's One Zone storage classes exist. For example,
use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web
Services Region, and it has the same location in every Amazon Web
Services account.
$sel:availabilityZoneName:FileSystemDescription', fileSystemDescription_availabilityZoneName - Describes the Amazon Web Services Availability Zone in which the file
system is located, and is valid only for file systems using One Zone
storage classes. For more information, see
Using EFS storage classes
in the Amazon EFS User Guide.
$sel:encrypted:FileSystemDescription', fileSystemDescription_encrypted - A Boolean value that, if true, indicates that the file system is
encrypted.
$sel:fileSystemArn:FileSystemDescription', fileSystemDescription_fileSystemArn - The Amazon Resource Name (ARN) for the EFS file system, in the format
arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id .
Example with sample data:
arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
$sel:kmsKeyId:FileSystemDescription', fileSystemDescription_kmsKeyId - The ID of an KMS key used to protect the encrypted file system.
$sel:name:FileSystemDescription', fileSystemDescription_name - You can add tags to a file system, including a Name tag. For more
information, see CreateFileSystem. If the file system has a Name tag,
Amazon EFS returns the value in this field.
$sel:provisionedThroughputInMibps:FileSystemDescription', fileSystemDescription_provisionedThroughputInMibps - The amount of provisioned throughput, measured in MiB/s, for the file
system. Valid for file systems using ThroughputMode set to
provisioned.
$sel:throughputMode:FileSystemDescription', fileSystemDescription_throughputMode - Displays the file system's throughput mode. For more information, see
Throughput modes
in the Amazon EFS User Guide.
$sel:ownerId:FileSystemDescription', fileSystemDescription_ownerId - The Amazon Web Services account that created the file system. If the
file system was created by an IAM user, the parent account to which the
user belongs is the owner.
$sel:creationToken:FileSystemDescription', fileSystemDescription_creationToken - The opaque string specified in the request.
$sel:fileSystemId:FileSystemDescription', fileSystemDescription_fileSystemId - The ID of the file system, assigned by Amazon EFS.
$sel:creationTime:FileSystemDescription', fileSystemDescription_creationTime - The time that the file system was created, in seconds (since
1970-01-01T00:00:00Z).
$sel:lifeCycleState:FileSystemDescription', fileSystemDescription_lifeCycleState - The lifecycle phase of the file system.
$sel:numberOfMountTargets:FileSystemDescription', fileSystemDescription_numberOfMountTargets - The current number of mount targets that the file system has. For more
information, see CreateMountTarget.
$sel:sizeInBytes:FileSystemDescription', fileSystemDescription_sizeInBytes - The latest known metered size (in bytes) of data stored in the file
system, in its Value field, and the time at which that size was
determined in its Timestamp field. The Timestamp value is the
integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes
value doesn't represent the size of a consistent snapshot of the file
system, but it is eventually consistent when there are no writes to the
file system. That is, SizeInBytes represents actual size only if the
file system is not modified for a period longer than a couple of hours.
Otherwise, the value is not the exact size that the file system was at
any point in time.
$sel:performanceMode:FileSystemDescription', fileSystemDescription_performanceMode - The performance mode of the file system.
$sel:tags:FileSystemDescription', fileSystemDescription_tags - The tags associated with the file system, presented as an array of Tag
objects.
CreateMountTarget
data CreateMountTarget Source #
See: newCreateMountTarget smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateMountTarget |
Create a value of CreateMountTarget 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:
CreateMountTarget, createMountTarget_ipAddress - Valid IPv4 address within the address range of the specified subnet.
$sel:securityGroups:CreateMountTarget', createMountTarget_securityGroups - Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must
be for the same VPC as subnet specified.
CreateMountTarget, createMountTarget_fileSystemId - The ID of the file system for which to create the mount target.
CreateMountTarget, createMountTarget_subnetId - The ID of the subnet to add the mount target in. For file systems that
use One Zone storage classes, use the subnet that is associated with the
file system's Availability Zone.
data MountTargetDescription Source #
Provides a description of a mount target.
See: newMountTargetDescription smart constructor.
Constructors
| MountTargetDescription' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text Text LifeCycleState |
Instances
newMountTargetDescription Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> LifeCycleState | |
| -> MountTargetDescription |
Create a value of MountTargetDescription 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:availabilityZoneId:MountTargetDescription', mountTargetDescription_availabilityZoneId - The unique and consistent identifier of the Availability Zone that the
mount target resides in. For example, use1-az1 is an AZ ID for the
us-east-1 Region and it has the same location in every Amazon Web
Services account.
$sel:availabilityZoneName:MountTargetDescription', mountTargetDescription_availabilityZoneName - The name of the Availability Zone in which the mount target is located.
Availability Zones are independently mapped to names for each Amazon Web
Services account. For example, the Availability Zone us-east-1a for
your Amazon Web Services account might not be the same location as
us-east-1a for another Amazon Web Services account.
$sel:ipAddress:MountTargetDescription', mountTargetDescription_ipAddress - Address at which the file system can be mounted by using the mount
target.
$sel:networkInterfaceId:MountTargetDescription', mountTargetDescription_networkInterfaceId - The ID of the network interface that Amazon EFS created when it created
the mount target.
$sel:ownerId:MountTargetDescription', mountTargetDescription_ownerId - Amazon Web Services account ID that owns the resource.
$sel:vpcId:MountTargetDescription', mountTargetDescription_vpcId - The virtual private cloud (VPC) ID that the mount target is configured
in.
$sel:mountTargetId:MountTargetDescription', mountTargetDescription_mountTargetId - System-assigned mount target ID.
$sel:fileSystemId:MountTargetDescription', mountTargetDescription_fileSystemId - The ID of the file system for which the mount target is intended.
$sel:subnetId:MountTargetDescription', mountTargetDescription_subnetId - The ID of the mount target's subnet.
$sel:lifeCycleState:MountTargetDescription', mountTargetDescription_lifeCycleState - Lifecycle state of the mount target.
CreateReplicationConfiguration
data CreateReplicationConfiguration Source #
See: newCreateReplicationConfiguration smart constructor.
Constructors
| CreateReplicationConfiguration' Text [DestinationToCreate] |
Instances
newCreateReplicationConfiguration Source #
Create a value of CreateReplicationConfiguration 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:
CreateReplicationConfiguration, createReplicationConfiguration_sourceFileSystemId - Specifies the Amazon EFS file system that you want to replicate. This
file system cannot already be a source or destination file system in
another replication configuration.
CreateReplicationConfiguration, createReplicationConfiguration_destinations - An array of destination configuration objects. Only one destination
configuration object is supported.
data ReplicationConfigurationDescription Source #
See: newReplicationConfigurationDescription smart constructor.
Constructors
| ReplicationConfigurationDescription' Text Text Text Text POSIX [Destination] |
Instances
newReplicationConfigurationDescription Source #
Arguments
Create a value of ReplicationConfigurationDescription 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:sourceFileSystemId:ReplicationConfigurationDescription', replicationConfigurationDescription_sourceFileSystemId - The ID of the source Amazon EFS file system that is being replicated.
$sel:sourceFileSystemRegion:ReplicationConfigurationDescription', replicationConfigurationDescription_sourceFileSystemRegion - The Amazon Web Services Region in which the source Amazon EFS file
system is located.
$sel:sourceFileSystemArn:ReplicationConfigurationDescription', replicationConfigurationDescription_sourceFileSystemArn - The Amazon Resource Name (ARN) of the current source file system in the
replication configuration.
$sel:originalSourceFileSystemArn:ReplicationConfigurationDescription', replicationConfigurationDescription_originalSourceFileSystemArn - The Amazon Resource Name (ARN) of the original source Amazon EFS file
system in the replication configuration.
$sel:creationTime:ReplicationConfigurationDescription', replicationConfigurationDescription_creationTime - Describes when the replication configuration was created.
$sel:destinations:ReplicationConfigurationDescription', replicationConfigurationDescription_destinations - An array of destination objects. Only one destination object is
supported.
DeleteAccessPoint
data DeleteAccessPoint Source #
See: newDeleteAccessPoint smart constructor.
Constructors
| DeleteAccessPoint' Text |
Instances
Arguments
| :: Text | |
| -> DeleteAccessPoint |
Create a value of DeleteAccessPoint 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:
DeleteAccessPoint, deleteAccessPoint_accessPointId - The ID of the access point that you want to delete.
data DeleteAccessPointResponse Source #
See: newDeleteAccessPointResponse smart constructor.
Constructors
| DeleteAccessPointResponse' | |
Instances
newDeleteAccessPointResponse :: DeleteAccessPointResponse Source #
Create a value of DeleteAccessPointResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteFileSystem
data DeleteFileSystem Source #
See: newDeleteFileSystem smart constructor.
Constructors
| DeleteFileSystem' Text |
Instances
Arguments
| :: Text | |
| -> DeleteFileSystem |
Create a value of DeleteFileSystem 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:
DeleteFileSystem, deleteFileSystem_fileSystemId - The ID of the file system you want to delete.
data DeleteFileSystemResponse Source #
See: newDeleteFileSystemResponse smart constructor.
Constructors
| DeleteFileSystemResponse' | |
Instances
newDeleteFileSystemResponse :: DeleteFileSystemResponse Source #
Create a value of DeleteFileSystemResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteFileSystemPolicy
data DeleteFileSystemPolicy Source #
See: newDeleteFileSystemPolicy smart constructor.
Constructors
| DeleteFileSystemPolicy' Text |
Instances
newDeleteFileSystemPolicy Source #
Arguments
| :: Text | |
| -> DeleteFileSystemPolicy |
Create a value of DeleteFileSystemPolicy 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:
DeleteFileSystemPolicy, deleteFileSystemPolicy_fileSystemId - Specifies the EFS file system for which to delete the
FileSystemPolicy.
data DeleteFileSystemPolicyResponse Source #
See: newDeleteFileSystemPolicyResponse smart constructor.
Constructors
| DeleteFileSystemPolicyResponse' | |
Instances
| Generic DeleteFileSystemPolicyResponse Source # | |
Defined in Amazonka.EFS.DeleteFileSystemPolicy Associated Types type Rep DeleteFileSystemPolicyResponse :: Type -> Type # | |
| Read DeleteFileSystemPolicyResponse Source # | |
| Show DeleteFileSystemPolicyResponse Source # | |
Defined in Amazonka.EFS.DeleteFileSystemPolicy Methods showsPrec :: Int -> DeleteFileSystemPolicyResponse -> ShowS # show :: DeleteFileSystemPolicyResponse -> String # showList :: [DeleteFileSystemPolicyResponse] -> ShowS # | |
| NFData DeleteFileSystemPolicyResponse Source # | |
Defined in Amazonka.EFS.DeleteFileSystemPolicy Methods rnf :: DeleteFileSystemPolicyResponse -> () # | |
| Eq DeleteFileSystemPolicyResponse Source # | |
Defined in Amazonka.EFS.DeleteFileSystemPolicy | |
| type Rep DeleteFileSystemPolicyResponse Source # | |
Defined in Amazonka.EFS.DeleteFileSystemPolicy | |
newDeleteFileSystemPolicyResponse :: DeleteFileSystemPolicyResponse Source #
Create a value of DeleteFileSystemPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteMountTarget
data DeleteMountTarget Source #
See: newDeleteMountTarget smart constructor.
Constructors
| DeleteMountTarget' Text |
Instances
Arguments
| :: Text | |
| -> DeleteMountTarget |
Create a value of DeleteMountTarget 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:
DeleteMountTarget, deleteMountTarget_mountTargetId - The ID of the mount target to delete (String).
data DeleteMountTargetResponse Source #
See: newDeleteMountTargetResponse smart constructor.
Constructors
| DeleteMountTargetResponse' | |
Instances
newDeleteMountTargetResponse :: DeleteMountTargetResponse Source #
Create a value of DeleteMountTargetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteReplicationConfiguration
data DeleteReplicationConfiguration Source #
See: newDeleteReplicationConfiguration smart constructor.
Constructors
| DeleteReplicationConfiguration' Text |
Instances
newDeleteReplicationConfiguration Source #
Create a value of DeleteReplicationConfiguration 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:
DeleteReplicationConfiguration, deleteReplicationConfiguration_sourceFileSystemId - The ID of the source file system in the replication configuration.
data DeleteReplicationConfigurationResponse Source #
See: newDeleteReplicationConfigurationResponse smart constructor.
Constructors
| DeleteReplicationConfigurationResponse' | |
Instances
newDeleteReplicationConfigurationResponse :: DeleteReplicationConfigurationResponse Source #
Create a value of DeleteReplicationConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeAccessPoints
data DescribeAccessPoints Source #
See: newDescribeAccessPoints smart constructor.
Instances
newDescribeAccessPoints :: DescribeAccessPoints Source #
Create a value of DescribeAccessPoints 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:
DescribeAccessPoints, describeAccessPoints_accessPointId - (Optional) Specifies an EFS access point to describe in the response;
mutually exclusive with FileSystemId.
DescribeAccessPoints, describeAccessPoints_fileSystemId - (Optional) If you provide a FileSystemId, EFS returns all access
points for that file system; mutually exclusive with AccessPointId.
$sel:maxResults:DescribeAccessPoints', describeAccessPoints_maxResults - (Optional) When retrieving all access points for a file system, you can
optionally specify the MaxItems parameter to limit the number of
objects returned in a response. The default value is 100.
DescribeAccessPoints, describeAccessPoints_nextToken - NextToken is present if the response is paginated. You can use
NextMarker in the subsequent request to fetch the next page of access
point descriptions.
data DescribeAccessPointsResponse Source #
See: newDescribeAccessPointsResponse smart constructor.
Constructors
| DescribeAccessPointsResponse' (Maybe [AccessPointDescription]) (Maybe Text) Int |
Instances
newDescribeAccessPointsResponse Source #
Create a value of DescribeAccessPointsResponse 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:accessPoints:DescribeAccessPointsResponse', describeAccessPointsResponse_accessPoints - An array of access point descriptions.
DescribeAccessPoints, describeAccessPointsResponse_nextToken - Present if there are more access points than returned in the response.
You can use the NextMarker in the subsequent request to fetch the
additional descriptions.
$sel:httpStatus:DescribeAccessPointsResponse', describeAccessPointsResponse_httpStatus - The response's http status code.
DescribeAccountPreferences
data DescribeAccountPreferences Source #
See: newDescribeAccountPreferences smart constructor.
Constructors
| DescribeAccountPreferences' (Maybe Natural) (Maybe Text) |
Instances
newDescribeAccountPreferences :: DescribeAccountPreferences Source #
Create a value of DescribeAccountPreferences 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:maxResults:DescribeAccountPreferences', describeAccountPreferences_maxResults - (Optional) When retrieving account preferences, you can optionally
specify the MaxItems parameter to limit the number of objects returned
in a response. The default value is 100.
DescribeAccountPreferences, describeAccountPreferences_nextToken - (Optional) You can use NextToken in a subsequent request to fetch the
next page of Amazon Web Services account preferences if the response
payload was paginated.
data DescribeAccountPreferencesResponse Source #
See: newDescribeAccountPreferencesResponse smart constructor.
Constructors
| DescribeAccountPreferencesResponse' (Maybe Text) (Maybe ResourceIdPreference) Int |
Instances
newDescribeAccountPreferencesResponse Source #
Arguments
| :: Int | |
| -> DescribeAccountPreferencesResponse |
Create a value of DescribeAccountPreferencesResponse 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:
DescribeAccountPreferences, describeAccountPreferencesResponse_nextToken - Present if there are more records than returned in the response. You can
use the NextToken in the subsequent request to fetch the additional
descriptions.
$sel:resourceIdPreference:DescribeAccountPreferencesResponse', describeAccountPreferencesResponse_resourceIdPreference - Describes the resource ID preference setting for the Amazon Web Services
account associated with the user making the request, in the current
Amazon Web Services Region.
$sel:httpStatus:DescribeAccountPreferencesResponse', describeAccountPreferencesResponse_httpStatus - The response's http status code.
DescribeBackupPolicy
data DescribeBackupPolicy Source #
See: newDescribeBackupPolicy smart constructor.
Constructors
| DescribeBackupPolicy' Text |
Instances
newDescribeBackupPolicy Source #
Arguments
| :: Text | |
| -> DescribeBackupPolicy |
Create a value of DescribeBackupPolicy 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:
DescribeBackupPolicy, describeBackupPolicy_fileSystemId - Specifies which EFS file system to retrieve the BackupPolicy for.
data BackupPolicyDescription Source #
See: newBackupPolicyDescription smart constructor.
Constructors
| BackupPolicyDescription' (Maybe BackupPolicy) |
Instances
newBackupPolicyDescription :: BackupPolicyDescription Source #
Create a value of BackupPolicyDescription 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:backupPolicy:BackupPolicyDescription', backupPolicyDescription_backupPolicy - Describes the file system's backup policy, indicating whether automatic
backups are turned on or off.
DescribeFileSystemPolicy
data DescribeFileSystemPolicy Source #
See: newDescribeFileSystemPolicy smart constructor.
Constructors
| DescribeFileSystemPolicy' Text |
Instances
newDescribeFileSystemPolicy Source #
Arguments
| :: Text | |
| -> DescribeFileSystemPolicy |
Create a value of DescribeFileSystemPolicy 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:
DescribeFileSystemPolicy, describeFileSystemPolicy_fileSystemId - Specifies which EFS file system to retrieve the FileSystemPolicy for.
data FileSystemPolicyDescription Source #
See: newFileSystemPolicyDescription smart constructor.
Constructors
| FileSystemPolicyDescription' (Maybe Text) (Maybe Text) |
Instances
newFileSystemPolicyDescription :: FileSystemPolicyDescription Source #
Create a value of FileSystemPolicyDescription 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:fileSystemId:FileSystemPolicyDescription', fileSystemPolicyDescription_fileSystemId - Specifies the EFS file system to which the FileSystemPolicy applies.
$sel:policy:FileSystemPolicyDescription', fileSystemPolicyDescription_policy - The JSON formatted FileSystemPolicy for the EFS file system.
DescribeFileSystems (Paginated)
data DescribeFileSystems Source #
See: newDescribeFileSystems smart constructor.
Instances
newDescribeFileSystems :: DescribeFileSystems Source #
Create a value of DescribeFileSystems 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:
DescribeFileSystems, describeFileSystems_creationToken - (Optional) Restricts the list to the file system with this creation
token (String). You specify a creation token when you create an Amazon
EFS file system.
DescribeFileSystems, describeFileSystems_fileSystemId - (Optional) ID of the file system whose description you want to retrieve
(String).
DescribeFileSystems, describeFileSystems_marker - (Optional) Opaque pagination token returned from a previous
DescribeFileSystems operation (String). If present, specifies to
continue the list from where the returning call had left off.
$sel:maxItems:DescribeFileSystems', describeFileSystems_maxItems - (Optional) Specifies the maximum number of file systems to return in the
response (integer). This number is automatically set to 100. The
response is paginated at 100 per page if you have more than 100 file
systems.
data DescribeFileSystemsResponse Source #
See: newDescribeFileSystemsResponse smart constructor.
Constructors
| DescribeFileSystemsResponse' (Maybe [FileSystemDescription]) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeFileSystemsResponse Source #
Create a value of DescribeFileSystemsResponse 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:fileSystems:DescribeFileSystemsResponse', describeFileSystemsResponse_fileSystems - An array of file system descriptions.
DescribeFileSystems, describeFileSystemsResponse_marker - Present if provided by caller in the request (String).
$sel:nextMarker:DescribeFileSystemsResponse', describeFileSystemsResponse_nextMarker - Present if there are more file systems than returned in the response
(String). You can use the NextMarker in the subsequent request to
fetch the descriptions.
$sel:httpStatus:DescribeFileSystemsResponse', describeFileSystemsResponse_httpStatus - The response's http status code.
DescribeLifecycleConfiguration
data DescribeLifecycleConfiguration Source #
See: newDescribeLifecycleConfiguration smart constructor.
Constructors
| DescribeLifecycleConfiguration' Text |
Instances
newDescribeLifecycleConfiguration Source #
Create a value of DescribeLifecycleConfiguration 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:
DescribeLifecycleConfiguration, describeLifecycleConfiguration_fileSystemId - The ID of the file system whose LifecycleConfiguration object you want
to retrieve (String).
data LifecycleConfigurationDescription Source #
See: newLifecycleConfigurationDescription smart constructor.
Constructors
| LifecycleConfigurationDescription' (Maybe [LifecyclePolicy]) |
Instances
newLifecycleConfigurationDescription :: LifecycleConfigurationDescription Source #
Create a value of LifecycleConfigurationDescription 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:lifecyclePolicies:LifecycleConfigurationDescription', lifecycleConfigurationDescription_lifecyclePolicies - An array of lifecycle management policies. EFS supports a maximum of one
policy per file system.
DescribeMountTargetSecurityGroups
data DescribeMountTargetSecurityGroups Source #
See: newDescribeMountTargetSecurityGroups smart constructor.
Constructors
| DescribeMountTargetSecurityGroups' Text |
Instances
newDescribeMountTargetSecurityGroups Source #
Create a value of DescribeMountTargetSecurityGroups 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:
DescribeMountTargetSecurityGroups, describeMountTargetSecurityGroups_mountTargetId - The ID of the mount target whose security groups you want to retrieve.
data DescribeMountTargetSecurityGroupsResponse Source #
See: newDescribeMountTargetSecurityGroupsResponse smart constructor.
Constructors
| DescribeMountTargetSecurityGroupsResponse' Int [Text] |
Instances
newDescribeMountTargetSecurityGroupsResponse Source #
Arguments
| :: Int | |
| -> DescribeMountTargetSecurityGroupsResponse |
Create a value of DescribeMountTargetSecurityGroupsResponse 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:httpStatus:DescribeMountTargetSecurityGroupsResponse', describeMountTargetSecurityGroupsResponse_httpStatus - The response's http status code.
$sel:securityGroups:DescribeMountTargetSecurityGroupsResponse', describeMountTargetSecurityGroupsResponse_securityGroups - An array of security groups.
DescribeMountTargets (Paginated)
data DescribeMountTargets Source #
See: newDescribeMountTargets smart constructor.
Constructors
| DescribeMountTargets' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) |
Instances
newDescribeMountTargets :: DescribeMountTargets Source #
Create a value of DescribeMountTargets 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:
DescribeMountTargets, describeMountTargets_accessPointId - (Optional) The ID of the access point whose mount targets that you want
to list. It must be included in your request if a FileSystemId or
MountTargetId is not included in your request. Accepts either an
access point ID or ARN as input.
DescribeMountTargets, describeMountTargets_fileSystemId - (Optional) ID of the file system whose mount targets you want to list
(String). It must be included in your request if an AccessPointId or
MountTargetId is not included. Accepts either a file system ID or ARN
as input.
DescribeMountTargets, describeMountTargets_marker - (Optional) Opaque pagination token returned from a previous
DescribeMountTargets operation (String). If present, it specifies to
continue the list from where the previous returning call left off.
$sel:maxItems:DescribeMountTargets', describeMountTargets_maxItems - (Optional) Maximum number of mount targets to return in the response.
Currently, this number is automatically set to 10, and other values are
ignored. The response is paginated at 100 per page if you have more than
100 mount targets.
DescribeMountTargets, describeMountTargets_mountTargetId - (Optional) ID of the mount target that you want to have described
(String). It must be included in your request if FileSystemId is not
included. Accepts either a mount target ID or ARN as input.
data DescribeMountTargetsResponse Source #
See: newDescribeMountTargetsResponse smart constructor.
Constructors
| DescribeMountTargetsResponse' (Maybe Text) (Maybe [MountTargetDescription]) (Maybe Text) Int |
Instances
newDescribeMountTargetsResponse Source #
Create a value of DescribeMountTargetsResponse 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:
DescribeMountTargets, describeMountTargetsResponse_marker - If the request included the Marker, the response returns that value in
this field.
$sel:mountTargets:DescribeMountTargetsResponse', describeMountTargetsResponse_mountTargets - Returns the file system's mount targets as an array of
MountTargetDescription objects.
$sel:nextMarker:DescribeMountTargetsResponse', describeMountTargetsResponse_nextMarker - If a value is present, there are more mount targets to return. In a
subsequent request, you can provide Marker in your request with this
value to retrieve the next set of mount targets.
$sel:httpStatus:DescribeMountTargetsResponse', describeMountTargetsResponse_httpStatus - The response's http status code.
DescribeReplicationConfigurations
data DescribeReplicationConfigurations Source #
See: newDescribeReplicationConfigurations smart constructor.
Instances
newDescribeReplicationConfigurations :: DescribeReplicationConfigurations Source #
Create a value of DescribeReplicationConfigurations 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:
DescribeReplicationConfigurations, describeReplicationConfigurations_fileSystemId - You can retrieve the replication configuration for a specific file
system by providing its file system ID.
$sel:maxResults:DescribeReplicationConfigurations', describeReplicationConfigurations_maxResults - (Optional) To limit the number of objects returned in a response, you
can specify the MaxItems parameter. The default value is 100.
DescribeReplicationConfigurations, describeReplicationConfigurations_nextToken - NextToken is present if the response is paginated. You can use
NextToken in a subsequent request to fetch the next page of output.
data DescribeReplicationConfigurationsResponse Source #
See: newDescribeReplicationConfigurationsResponse smart constructor.
Constructors
| DescribeReplicationConfigurationsResponse' (Maybe Text) (Maybe [ReplicationConfigurationDescription]) Int |
Instances
newDescribeReplicationConfigurationsResponse Source #
Arguments
| :: Int | |
| -> DescribeReplicationConfigurationsResponse |
Create a value of DescribeReplicationConfigurationsResponse 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:
DescribeReplicationConfigurations, describeReplicationConfigurationsResponse_nextToken - You can use the NextToken from the previous response in a subsequent
request to fetch the additional descriptions.
$sel:replications:DescribeReplicationConfigurationsResponse', describeReplicationConfigurationsResponse_replications - The collection of replication configurations that is returned.
$sel:httpStatus:DescribeReplicationConfigurationsResponse', describeReplicationConfigurationsResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:maxResults:ListTagsForResource', listTagsForResource_maxResults - (Optional) Specifies the maximum number of tag objects to return in the
response. The default value is 100.
ListTagsForResource, listTagsForResource_nextToken - (Optional) You can use NextToken in a subsequent request to fetch the
next page of access point descriptions if the response payload was
paginated.
$sel:resourceId:ListTagsForResource', listTagsForResource_resourceId - Specifies the EFS resource you want to retrieve tags for. You can
retrieve tags for EFS file systems and access points using this API
endpoint.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:
ListTagsForResource, listTagsForResourceResponse_nextToken - NextToken is present if the response payload is paginated. You can use
NextToken in a subsequent request to fetch the next page of access
point descriptions.
ListTagsForResourceResponse, listTagsForResourceResponse_tags - An array of the tags for the specified EFS resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
ModifyMountTargetSecurityGroups
data ModifyMountTargetSecurityGroups Source #
See: newModifyMountTargetSecurityGroups smart constructor.
Constructors
| ModifyMountTargetSecurityGroups' (Maybe [Text]) Text |
Instances
newModifyMountTargetSecurityGroups Source #
Create a value of ModifyMountTargetSecurityGroups 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:securityGroups:ModifyMountTargetSecurityGroups', modifyMountTargetSecurityGroups_securityGroups - An array of up to five VPC security group IDs.
ModifyMountTargetSecurityGroups, modifyMountTargetSecurityGroups_mountTargetId - The ID of the mount target whose security groups you want to modify.
data ModifyMountTargetSecurityGroupsResponse Source #
See: newModifyMountTargetSecurityGroupsResponse smart constructor.
Constructors
| ModifyMountTargetSecurityGroupsResponse' | |
Instances
newModifyMountTargetSecurityGroupsResponse :: ModifyMountTargetSecurityGroupsResponse Source #
Create a value of ModifyMountTargetSecurityGroupsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutAccountPreferences
data PutAccountPreferences Source #
See: newPutAccountPreferences smart constructor.
Constructors
| PutAccountPreferences' ResourceIdType |
Instances
newPutAccountPreferences Source #
Arguments
| :: ResourceIdType | |
| -> PutAccountPreferences |
Create a value of PutAccountPreferences 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:
PutAccountPreferences, putAccountPreferences_resourceIdType - Specifies the EFS resource ID preference to set for the user's Amazon
Web Services account, in the current Amazon Web Services Region, either
LONG_ID (17 characters), or SHORT_ID (8 characters).
Starting in October, 2021, you will receive an error when setting the
account preference to SHORT_ID. Contact Amazon Web Services support if
you receive an error and must use short IDs for file system and mount
target resources.
data PutAccountPreferencesResponse Source #
See: newPutAccountPreferencesResponse smart constructor.
Constructors
| PutAccountPreferencesResponse' (Maybe ResourceIdPreference) Int |
Instances
newPutAccountPreferencesResponse Source #
Create a value of PutAccountPreferencesResponse 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:resourceIdPreference:PutAccountPreferencesResponse', putAccountPreferencesResponse_resourceIdPreference - Undocumented member.
$sel:httpStatus:PutAccountPreferencesResponse', putAccountPreferencesResponse_httpStatus - The response's http status code.
PutBackupPolicy
data PutBackupPolicy Source #
See: newPutBackupPolicy smart constructor.
Constructors
| PutBackupPolicy' Text BackupPolicy |
Instances
Arguments
| :: Text | |
| -> BackupPolicy | |
| -> PutBackupPolicy |
Create a value of PutBackupPolicy 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:
PutBackupPolicy, putBackupPolicy_fileSystemId - Specifies which EFS file system to update the backup policy for.
PutBackupPolicy, putBackupPolicy_backupPolicy - The backup policy included in the PutBackupPolicy request.
data BackupPolicyDescription Source #
See: newBackupPolicyDescription smart constructor.
Constructors
| BackupPolicyDescription' (Maybe BackupPolicy) |
Instances
newBackupPolicyDescription :: BackupPolicyDescription Source #
Create a value of BackupPolicyDescription 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:backupPolicy:BackupPolicyDescription', backupPolicyDescription_backupPolicy - Describes the file system's backup policy, indicating whether automatic
backups are turned on or off.
PutFileSystemPolicy
data PutFileSystemPolicy Source #
See: newPutFileSystemPolicy smart constructor.
Constructors
| PutFileSystemPolicy' (Maybe Bool) Text Text |
Instances
newPutFileSystemPolicy Source #
Arguments
| :: Text | |
| -> Text | |
| -> PutFileSystemPolicy |
Create a value of PutFileSystemPolicy 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:bypassPolicyLockoutSafetyCheck:PutFileSystemPolicy', putFileSystemPolicy_bypassPolicyLockoutSafetyCheck - (Optional) A boolean that specifies whether or not to bypass the
FileSystemPolicy lockout safety check. The lockout safety check
determines whether the policy in the request will lock out, or prevent,
the IAM principal that is making the request from making future
PutFileSystemPolicy requests on this file system. Set
BypassPolicyLockoutSafetyCheck to True only when you intend to
prevent the IAM principal that is making the request from making
subsequent PutFileSystemPolicy requests on this file system. The
default value is False.
PutFileSystemPolicy, putFileSystemPolicy_fileSystemId - The ID of the EFS file system that you want to create or update the
FileSystemPolicy for.
PutFileSystemPolicy, putFileSystemPolicy_policy - The FileSystemPolicy that you're creating. Accepts a JSON formatted
policy definition. EFS file system policies have a 20,000 character
limit. To find out more about the elements that make up a file system
policy, see
EFS Resource-based Policies.
data FileSystemPolicyDescription Source #
See: newFileSystemPolicyDescription smart constructor.
Constructors
| FileSystemPolicyDescription' (Maybe Text) (Maybe Text) |
Instances
newFileSystemPolicyDescription :: FileSystemPolicyDescription Source #
Create a value of FileSystemPolicyDescription 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:fileSystemId:FileSystemPolicyDescription', fileSystemPolicyDescription_fileSystemId - Specifies the EFS file system to which the FileSystemPolicy applies.
$sel:policy:FileSystemPolicyDescription', fileSystemPolicyDescription_policy - The JSON formatted FileSystemPolicy for the EFS file system.
PutLifecycleConfiguration
data PutLifecycleConfiguration Source #
See: newPutLifecycleConfiguration smart constructor.
Constructors
| PutLifecycleConfiguration' Text [LifecyclePolicy] |
Instances
newPutLifecycleConfiguration Source #
Arguments
| :: Text | |
| -> PutLifecycleConfiguration |
Create a value of PutLifecycleConfiguration 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:
PutLifecycleConfiguration, putLifecycleConfiguration_fileSystemId - The ID of the file system for which you are creating the
LifecycleConfiguration object (String).
PutLifecycleConfiguration, putLifecycleConfiguration_lifecyclePolicies - An array of LifecyclePolicy objects that define the file system's
LifecycleConfiguration object. A LifecycleConfiguration object
informs EFS lifecycle management and EFS Intelligent-Tiering of the
following:
- When to move files in the file system from primary storage to the IA storage class.
- When to move files that are in IA storage to primary storage.
When using the put-lifecycle-configuration CLI command or the
PutLifecycleConfiguration API action, Amazon EFS requires that each
LifecyclePolicy object have only a single transition. This means that
in a request body, LifecyclePolicies must be structured as an array of
LifecyclePolicy objects, one object for each transition,
TransitionToIA, TransitionToPrimaryStorageClass. See the example
requests in the following section for more information.
data LifecycleConfigurationDescription Source #
See: newLifecycleConfigurationDescription smart constructor.
Constructors
| LifecycleConfigurationDescription' (Maybe [LifecyclePolicy]) |
Instances
newLifecycleConfigurationDescription :: LifecycleConfigurationDescription Source #
Create a value of LifecycleConfigurationDescription 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:lifecyclePolicies:LifecycleConfigurationDescription', lifecycleConfigurationDescription_lifecyclePolicies - An array of lifecycle management policies. EFS supports a maximum of one
policy per file system.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceId:TagResource', tagResource_resourceId - The ID specifying the EFS resource that you want to create a tag for.
TagResource, tagResource_tags - An array of Tag objects to add. Each Tag object is a key-value pair.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' | |
Instances
| Generic TagResourceResponse Source # | |
Defined in Amazonka.EFS.TagResource Associated Types type Rep TagResourceResponse :: Type -> Type # Methods from :: TagResourceResponse -> Rep TagResourceResponse x # to :: Rep TagResourceResponse x -> TagResourceResponse # | |
| Read TagResourceResponse Source # | |
Defined in Amazonka.EFS.TagResource Methods readsPrec :: Int -> ReadS TagResourceResponse # readList :: ReadS [TagResourceResponse] # | |
| Show TagResourceResponse Source # | |
Defined in Amazonka.EFS.TagResource Methods showsPrec :: Int -> TagResourceResponse -> ShowS # show :: TagResourceResponse -> String # showList :: [TagResourceResponse] -> ShowS # | |
| NFData TagResourceResponse Source # | |
Defined in Amazonka.EFS.TagResource Methods rnf :: TagResourceResponse -> () # | |
| Eq TagResourceResponse Source # | |
Defined in Amazonka.EFS.TagResource Methods (==) :: TagResourceResponse -> TagResourceResponse -> Bool # (/=) :: TagResourceResponse -> TagResourceResponse -> Bool # | |
| type Rep TagResourceResponse Source # | |
newTagResourceResponse :: TagResourceResponse Source #
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceId:UntagResource', untagResource_resourceId - Specifies the EFS resource that you want to remove tags from.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The keys of the key-value tag pairs that you want to remove from the
specified EFS resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' | |
Instances
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateFileSystem
data UpdateFileSystem Source #
See: newUpdateFileSystem smart constructor.
Constructors
| UpdateFileSystem' (Maybe Double) (Maybe ThroughputMode) Text |
Instances
Arguments
| :: Text | |
| -> UpdateFileSystem |
Create a value of UpdateFileSystem 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:
UpdateFileSystem, updateFileSystem_provisionedThroughputInMibps - (Optional) Sets the amount of provisioned throughput, in MiB/s, for the
file system. Valid values are 1-1024. If you are changing the throughput
mode to provisioned, you must also provide the amount of provisioned
throughput. Required if ThroughputMode is changed to provisioned on
update.
UpdateFileSystem, updateFileSystem_throughputMode - (Optional) Updates the file system's throughput mode. If you're not
updating your throughput mode, you don't need to provide this value in
your request. If you are changing the ThroughputMode to provisioned,
you must also set a value for ProvisionedThroughputInMibps.
UpdateFileSystem, updateFileSystem_fileSystemId - The ID of the file system that you want to update.
data FileSystemDescription Source #
A description of the file system.
See: newFileSystemDescription smart constructor.
Constructors
Instances
newFileSystemDescription Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> LifeCycleState | |
| -> Natural | |
| -> FileSystemSize | |
| -> PerformanceMode | |
| -> FileSystemDescription |
Create a value of FileSystemDescription 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:availabilityZoneId:FileSystemDescription', fileSystemDescription_availabilityZoneId - The unique and consistent identifier of the Availability Zone in which
the file system's One Zone storage classes exist. For example,
use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web
Services Region, and it has the same location in every Amazon Web
Services account.
$sel:availabilityZoneName:FileSystemDescription', fileSystemDescription_availabilityZoneName - Describes the Amazon Web Services Availability Zone in which the file
system is located, and is valid only for file systems using One Zone
storage classes. For more information, see
Using EFS storage classes
in the Amazon EFS User Guide.
$sel:encrypted:FileSystemDescription', fileSystemDescription_encrypted - A Boolean value that, if true, indicates that the file system is
encrypted.
$sel:fileSystemArn:FileSystemDescription', fileSystemDescription_fileSystemArn - The Amazon Resource Name (ARN) for the EFS file system, in the format
arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id .
Example with sample data:
arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
$sel:kmsKeyId:FileSystemDescription', fileSystemDescription_kmsKeyId - The ID of an KMS key used to protect the encrypted file system.
$sel:name:FileSystemDescription', fileSystemDescription_name - You can add tags to a file system, including a Name tag. For more
information, see CreateFileSystem. If the file system has a Name tag,
Amazon EFS returns the value in this field.
$sel:provisionedThroughputInMibps:FileSystemDescription', fileSystemDescription_provisionedThroughputInMibps - The amount of provisioned throughput, measured in MiB/s, for the file
system. Valid for file systems using ThroughputMode set to
provisioned.
$sel:throughputMode:FileSystemDescription', fileSystemDescription_throughputMode - Displays the file system's throughput mode. For more information, see
Throughput modes
in the Amazon EFS User Guide.
$sel:ownerId:FileSystemDescription', fileSystemDescription_ownerId - The Amazon Web Services account that created the file system. If the
file system was created by an IAM user, the parent account to which the
user belongs is the owner.
$sel:creationToken:FileSystemDescription', fileSystemDescription_creationToken - The opaque string specified in the request.
$sel:fileSystemId:FileSystemDescription', fileSystemDescription_fileSystemId - The ID of the file system, assigned by Amazon EFS.
$sel:creationTime:FileSystemDescription', fileSystemDescription_creationTime - The time that the file system was created, in seconds (since
1970-01-01T00:00:00Z).
$sel:lifeCycleState:FileSystemDescription', fileSystemDescription_lifeCycleState - The lifecycle phase of the file system.
$sel:numberOfMountTargets:FileSystemDescription', fileSystemDescription_numberOfMountTargets - The current number of mount targets that the file system has. For more
information, see CreateMountTarget.
$sel:sizeInBytes:FileSystemDescription', fileSystemDescription_sizeInBytes - The latest known metered size (in bytes) of data stored in the file
system, in its Value field, and the time at which that size was
determined in its Timestamp field. The Timestamp value is the
integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes
value doesn't represent the size of a consistent snapshot of the file
system, but it is eventually consistent when there are no writes to the
file system. That is, SizeInBytes represents actual size only if the
file system is not modified for a period longer than a couple of hours.
Otherwise, the value is not the exact size that the file system was at
any point in time.
$sel:performanceMode:FileSystemDescription', fileSystemDescription_performanceMode - The performance mode of the file system.
$sel:tags:FileSystemDescription', fileSystemDescription_tags - The tags associated with the file system, presented as an array of Tag
objects.
Types
BackupStatus
newtype BackupStatus Source #
Constructors
| BackupStatus' | |
Fields | |
Bundled Patterns
| pattern BackupStatus_DISABLED :: BackupStatus | |
| pattern BackupStatus_DISABLING :: BackupStatus | |
| pattern BackupStatus_ENABLED :: BackupStatus | |
| pattern BackupStatus_ENABLING :: BackupStatus |
Instances
LifeCycleState
newtype LifeCycleState Source #
Constructors
| LifeCycleState' | |
Fields | |
Bundled Patterns
| pattern LifeCycleState_Available :: LifeCycleState | |
| pattern LifeCycleState_Creating :: LifeCycleState | |
| pattern LifeCycleState_Deleted :: LifeCycleState | |
| pattern LifeCycleState_Deleting :: LifeCycleState | |
| pattern LifeCycleState_Error :: LifeCycleState | |
| pattern LifeCycleState_Updating :: LifeCycleState |
Instances
PerformanceMode
newtype PerformanceMode Source #
Constructors
| PerformanceMode' | |
Fields | |
Bundled Patterns
| pattern PerformanceMode_GeneralPurpose :: PerformanceMode | |
| pattern PerformanceMode_MaxIO :: PerformanceMode |
Instances
ReplicationStatus
newtype ReplicationStatus Source #
Constructors
| ReplicationStatus' | |
Fields | |
Bundled Patterns
| pattern ReplicationStatus_DELETING :: ReplicationStatus | |
| pattern ReplicationStatus_ENABLED :: ReplicationStatus | |
| pattern ReplicationStatus_ENABLING :: ReplicationStatus | |
| pattern ReplicationStatus_ERROR :: ReplicationStatus |
Instances
Resource
An EFS resource, for example a file system or a mount target.
Constructors
| Resource' | |
Fields
| |
Bundled Patterns
| pattern Resource_FILE_SYSTEM :: Resource | |
| pattern Resource_MOUNT_TARGET :: Resource |
Instances
ResourceIdType
newtype ResourceIdType Source #
A preference indicating a choice to use 63bit/32bit IDs for all applicable resources.
Constructors
| ResourceIdType' | |
Fields | |
Bundled Patterns
| pattern ResourceIdType_LONG_ID :: ResourceIdType | |
| pattern ResourceIdType_SHORT_ID :: ResourceIdType |
Instances
ThroughputMode
newtype ThroughputMode Source #
Constructors
| ThroughputMode' | |
Fields | |
Bundled Patterns
| pattern ThroughputMode_Bursting :: ThroughputMode | |
| pattern ThroughputMode_Elastic :: ThroughputMode | |
| pattern ThroughputMode_Provisioned :: ThroughputMode |
Instances
TransitionToIARules
newtype TransitionToIARules Source #
Constructors
| TransitionToIARules' | |
Fields | |
Bundled Patterns
Instances
TransitionToPrimaryStorageClassRules
newtype TransitionToPrimaryStorageClassRules Source #
Constructors
| TransitionToPrimaryStorageClassRules' | |
Bundled Patterns
| pattern TransitionToPrimaryStorageClassRules_AFTER_1_ACCESS :: TransitionToPrimaryStorageClassRules |
Instances
AccessPointDescription
data AccessPointDescription Source #
Provides a description of an EFS file system access point.
See: newAccessPointDescription smart constructor.
Constructors
| AccessPointDescription' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe LifeCycleState) (Maybe Text) (Maybe Text) (Maybe PosixUser) (Maybe RootDirectory) (Maybe [Tag]) |
Instances
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:accessPointArn:AccessPointDescription', accessPointDescription_accessPointArn - The unique Amazon Resource Name (ARN) associated with the access point.
$sel:accessPointId:AccessPointDescription', accessPointDescription_accessPointId - The ID of the access point, assigned by Amazon EFS.
$sel:clientToken:AccessPointDescription', accessPointDescription_clientToken - The opaque string specified in the request to ensure idempotent
creation.
$sel:fileSystemId:AccessPointDescription', accessPointDescription_fileSystemId - The ID of the EFS file system that the access point applies to.
$sel:lifeCycleState:AccessPointDescription', accessPointDescription_lifeCycleState - Identifies the lifecycle phase of the access point.
$sel:name:AccessPointDescription', accessPointDescription_name - The name of the access point. This is the value of the Name tag.
$sel:ownerId:AccessPointDescription', accessPointDescription_ownerId - Identified the Amazon Web Services account that owns the access point
resource.
$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:tags:AccessPointDescription', accessPointDescription_tags - The tags associated with the access point, presented as an array of Tag
objects.
BackupPolicy
data BackupPolicy Source #
The backup policy for the file system used to create automatic daily
backups. If status has a value of ENABLED, the file system is being
automatically backed up. For more information, see
Automatic backups.
See: newBackupPolicy smart constructor.
Constructors
| BackupPolicy' BackupStatus |
Instances
Arguments
| :: BackupStatus | |
| -> BackupPolicy |
Create a value of BackupPolicy 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:status:BackupPolicy', backupPolicy_status - Describes the status of the file system's backup policy.
ENABLED- EFS is automatically backing up the file system.ENABLING- EFS is turning on automatic backups for the file system.DISABLED- Automatic back ups are turned off for the file system.DISABLING- EFS is turning off automatic backups for the file system.
BackupPolicyDescription
data BackupPolicyDescription Source #
See: newBackupPolicyDescription smart constructor.
Constructors
| BackupPolicyDescription' (Maybe BackupPolicy) |
Instances
newBackupPolicyDescription :: BackupPolicyDescription Source #
Create a value of BackupPolicyDescription 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:backupPolicy:BackupPolicyDescription', backupPolicyDescription_backupPolicy - Describes the file system's backup policy, indicating whether automatic
backups are turned on or off.
CreationInfo
data CreationInfo Source #
Required if the RootDirectory > Path specified does not exist.
Specifies the POSIX IDs and permissions to apply to the access point's
RootDirectory > Path. If the access point root directory does not
exist, EFS creates it with these settings when a client connects to the
access point. When specifying CreationInfo, you must include values
for all properties.
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.
If you do not provide CreationInfo and the specified RootDirectory
does not exist, attempts to mount the file system using the access point
will fail.
See: newCreationInfo smart constructor.
Constructors
| CreationInfo' Natural Natural Text |
Instances
Arguments
| :: Natural | |
| -> Natural | |
| -> Text | |
| -> CreationInfo |
Create a value of CreationInfo 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:ownerUid:CreationInfo', creationInfo_ownerUid - Specifies the POSIX user ID to apply to the RootDirectory. Accepts
values from 0 to 2^32 (4294967295).
$sel:ownerGid:CreationInfo', creationInfo_ownerGid - Specifies the POSIX group ID to apply to the RootDirectory. Accepts
values from 0 to 2^32 (4294967295).
$sel:permissions:CreationInfo', creationInfo_permissions - Specifies the POSIX permissions to apply to the RootDirectory, in the
format of an octal number representing the file's mode bits.
Destination
data Destination Source #
Describes the destination file system in the replication configuration.
See: newDestination smart constructor.
Constructors
| Destination' (Maybe POSIX) ReplicationStatus Text Text |
Instances
Arguments
| :: ReplicationStatus | |
| -> Text | |
| -> Text | |
| -> Destination |
Create a value of Destination 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:lastReplicatedTimestamp:Destination', destination_lastReplicatedTimestamp - The time when the most recent sync was successfully completed on the
destination file system. Any changes to data on the source file system
that occurred before this time have been successfully replicated to the
destination file system. Any changes that occurred after this time might
not be fully replicated.
$sel:status:Destination', destination_status - Describes the status of the destination Amazon EFS file system. If the
status is ERROR, the destination file system in the replication
configuration is in a failed state and is unrecoverable. To access the
file system data, restore a backup of the failed file system to a new
file system.
$sel:fileSystemId:Destination', destination_fileSystemId - The ID of the destination Amazon EFS file system.
$sel:region:Destination', destination_region - The Amazon Web Services Region in which the destination file system is
located.
DestinationToCreate
data DestinationToCreate Source #
Describes the destination file system to create in the replication configuration.
See: newDestinationToCreate smart constructor.
Instances
newDestinationToCreate :: DestinationToCreate Source #
Create a value of DestinationToCreate 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:availabilityZoneName:DestinationToCreate', destinationToCreate_availabilityZoneName - To create a file system that uses EFS One Zone storage, specify the name
of the Availability Zone in which to create the destination file system.
$sel:kmsKeyId:DestinationToCreate', destinationToCreate_kmsKeyId - Specifies the Key Management Service (KMS) key that you want to use to
encrypt the destination file system. If you do not specify a KMS key,
Amazon EFS uses your default KMS key for Amazon EFS,
/aws/elasticfilesystem. This ID can be in one of the following
formats:
- Key ID - The unique identifier of the key, for example
1234abcd-12ab-34cd-56ef-1234567890ab. - ARN - The Amazon Resource Name (ARN) for the key, for example
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Key alias - A previously created display name for a key, for example
alias/projectKey1. - Key alias ARN - The ARN for a key alias, for example
arn:aws:kms:us-west-2:444455556666:alias/projectKey1.
$sel:region:DestinationToCreate', destinationToCreate_region - To create a file system that uses Regional storage, specify the Amazon
Web Services Region in which to create the destination file system.
FileSystemDescription
data FileSystemDescription Source #
A description of the file system.
See: newFileSystemDescription smart constructor.
Constructors
Instances
newFileSystemDescription Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> LifeCycleState | |
| -> Natural | |
| -> FileSystemSize | |
| -> PerformanceMode | |
| -> FileSystemDescription |
Create a value of FileSystemDescription 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:availabilityZoneId:FileSystemDescription', fileSystemDescription_availabilityZoneId - The unique and consistent identifier of the Availability Zone in which
the file system's One Zone storage classes exist. For example,
use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web
Services Region, and it has the same location in every Amazon Web
Services account.
$sel:availabilityZoneName:FileSystemDescription', fileSystemDescription_availabilityZoneName - Describes the Amazon Web Services Availability Zone in which the file
system is located, and is valid only for file systems using One Zone
storage classes. For more information, see
Using EFS storage classes
in the Amazon EFS User Guide.
$sel:encrypted:FileSystemDescription', fileSystemDescription_encrypted - A Boolean value that, if true, indicates that the file system is
encrypted.
$sel:fileSystemArn:FileSystemDescription', fileSystemDescription_fileSystemArn - The Amazon Resource Name (ARN) for the EFS file system, in the format
arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id .
Example with sample data:
arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567
$sel:kmsKeyId:FileSystemDescription', fileSystemDescription_kmsKeyId - The ID of an KMS key used to protect the encrypted file system.
$sel:name:FileSystemDescription', fileSystemDescription_name - You can add tags to a file system, including a Name tag. For more
information, see CreateFileSystem. If the file system has a Name tag,
Amazon EFS returns the value in this field.
$sel:provisionedThroughputInMibps:FileSystemDescription', fileSystemDescription_provisionedThroughputInMibps - The amount of provisioned throughput, measured in MiB/s, for the file
system. Valid for file systems using ThroughputMode set to
provisioned.
$sel:throughputMode:FileSystemDescription', fileSystemDescription_throughputMode - Displays the file system's throughput mode. For more information, see
Throughput modes
in the Amazon EFS User Guide.
$sel:ownerId:FileSystemDescription', fileSystemDescription_ownerId - The Amazon Web Services account that created the file system. If the
file system was created by an IAM user, the parent account to which the
user belongs is the owner.
$sel:creationToken:FileSystemDescription', fileSystemDescription_creationToken - The opaque string specified in the request.
$sel:fileSystemId:FileSystemDescription', fileSystemDescription_fileSystemId - The ID of the file system, assigned by Amazon EFS.
$sel:creationTime:FileSystemDescription', fileSystemDescription_creationTime - The time that the file system was created, in seconds (since
1970-01-01T00:00:00Z).
$sel:lifeCycleState:FileSystemDescription', fileSystemDescription_lifeCycleState - The lifecycle phase of the file system.
$sel:numberOfMountTargets:FileSystemDescription', fileSystemDescription_numberOfMountTargets - The current number of mount targets that the file system has. For more
information, see CreateMountTarget.
$sel:sizeInBytes:FileSystemDescription', fileSystemDescription_sizeInBytes - The latest known metered size (in bytes) of data stored in the file
system, in its Value field, and the time at which that size was
determined in its Timestamp field. The Timestamp value is the
integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes
value doesn't represent the size of a consistent snapshot of the file
system, but it is eventually consistent when there are no writes to the
file system. That is, SizeInBytes represents actual size only if the
file system is not modified for a period longer than a couple of hours.
Otherwise, the value is not the exact size that the file system was at
any point in time.
$sel:performanceMode:FileSystemDescription', fileSystemDescription_performanceMode - The performance mode of the file system.
$sel:tags:FileSystemDescription', fileSystemDescription_tags - The tags associated with the file system, presented as an array of Tag
objects.
FileSystemPolicyDescription
data FileSystemPolicyDescription Source #
See: newFileSystemPolicyDescription smart constructor.
Constructors
| FileSystemPolicyDescription' (Maybe Text) (Maybe Text) |
Instances
newFileSystemPolicyDescription :: FileSystemPolicyDescription Source #
Create a value of FileSystemPolicyDescription 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:fileSystemId:FileSystemPolicyDescription', fileSystemPolicyDescription_fileSystemId - Specifies the EFS file system to which the FileSystemPolicy applies.
$sel:policy:FileSystemPolicyDescription', fileSystemPolicyDescription_policy - The JSON formatted FileSystemPolicy for the EFS file system.
FileSystemSize
data FileSystemSize Source #
The latest known metered size (in bytes) of data stored in the file
system, in its Value field, and the time at which that size was
determined in its Timestamp field. The value doesn't represent the
size of a consistent snapshot of the file system, but it is eventually
consistent when there are no writes to the file system. That is, the
value represents the actual size only if the file system is not modified
for a period longer than a couple of hours. Otherwise, the value is not
necessarily the exact size the file system was at any instant in time.
See: newFileSystemSize smart constructor.
Instances
Arguments
| :: Natural | |
| -> FileSystemSize |
Create a value of FileSystemSize 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:timestamp:FileSystemSize', fileSystemSize_timestamp - The time at which the size of data, returned in the Value field, was
determined. The value is the integer number of seconds since
1970-01-01T00:00:00Z.
$sel:valueInIA:FileSystemSize', fileSystemSize_valueInIA - The latest known metered size (in bytes) of data stored in the
Infrequent Access storage class.
$sel:valueInStandard:FileSystemSize', fileSystemSize_valueInStandard - The latest known metered size (in bytes) of data stored in the Standard
storage class.
$sel:value:FileSystemSize', fileSystemSize_value - The latest known metered size (in bytes) of data stored in the file
system.
LifecycleConfigurationDescription
data LifecycleConfigurationDescription Source #
See: newLifecycleConfigurationDescription smart constructor.
Constructors
| LifecycleConfigurationDescription' (Maybe [LifecyclePolicy]) |
Instances
newLifecycleConfigurationDescription :: LifecycleConfigurationDescription Source #
Create a value of LifecycleConfigurationDescription 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:lifecyclePolicies:LifecycleConfigurationDescription', lifecycleConfigurationDescription_lifecyclePolicies - An array of lifecycle management policies. EFS supports a maximum of one
policy per file system.
LifecyclePolicy
data LifecyclePolicy Source #
Describes a policy used by EFS lifecycle management and EFS Intelligent-Tiering that specifies when to transition files into and out of the file system's Infrequent Access (IA) storage class. For more information, see EFS Intelligent‐Tiering and EFS Lifecycle Management.
When using the put-lifecycle-configuration CLI command or the
PutLifecycleConfiguration API action, Amazon EFS requires that each
LifecyclePolicy object have only a single transition. This means that
in a request body, LifecyclePolicies must be structured as an array of
LifecyclePolicy objects, one object for each transition,
TransitionToIA, TransitionToPrimaryStorageClass. For more
information, see the request examples in PutLifecycleConfiguration.
See: newLifecyclePolicy smart constructor.
Constructors
| LifecyclePolicy' (Maybe TransitionToIARules) (Maybe TransitionToPrimaryStorageClassRules) |
Instances
newLifecyclePolicy :: LifecyclePolicy Source #
Create a value of LifecyclePolicy 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:transitionToIA:LifecyclePolicy', lifecyclePolicy_transitionToIA - Describes the period of time that a file is not accessed, after which it
transitions to IA storage. Metadata operations such as listing the
contents of a directory don't count as file access events.
$sel:transitionToPrimaryStorageClass:LifecyclePolicy', lifecyclePolicy_transitionToPrimaryStorageClass - Describes when to transition a file from IA storage to primary storage.
Metadata operations such as listing the contents of a directory don't
count as file access events.
MountTargetDescription
data MountTargetDescription Source #
Provides a description of a mount target.
See: newMountTargetDescription smart constructor.
Constructors
| MountTargetDescription' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text Text LifeCycleState |
Instances
newMountTargetDescription Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> LifeCycleState | |
| -> MountTargetDescription |
Create a value of MountTargetDescription 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:availabilityZoneId:MountTargetDescription', mountTargetDescription_availabilityZoneId - The unique and consistent identifier of the Availability Zone that the
mount target resides in. For example, use1-az1 is an AZ ID for the
us-east-1 Region and it has the same location in every Amazon Web
Services account.
$sel:availabilityZoneName:MountTargetDescription', mountTargetDescription_availabilityZoneName - The name of the Availability Zone in which the mount target is located.
Availability Zones are independently mapped to names for each Amazon Web
Services account. For example, the Availability Zone us-east-1a for
your Amazon Web Services account might not be the same location as
us-east-1a for another Amazon Web Services account.
$sel:ipAddress:MountTargetDescription', mountTargetDescription_ipAddress - Address at which the file system can be mounted by using the mount
target.
$sel:networkInterfaceId:MountTargetDescription', mountTargetDescription_networkInterfaceId - The ID of the network interface that Amazon EFS created when it created
the mount target.
$sel:ownerId:MountTargetDescription', mountTargetDescription_ownerId - Amazon Web Services account ID that owns the resource.
$sel:vpcId:MountTargetDescription', mountTargetDescription_vpcId - The virtual private cloud (VPC) ID that the mount target is configured
in.
$sel:mountTargetId:MountTargetDescription', mountTargetDescription_mountTargetId - System-assigned mount target ID.
$sel:fileSystemId:MountTargetDescription', mountTargetDescription_fileSystemId - The ID of the file system for which the mount target is intended.
$sel:subnetId:MountTargetDescription', mountTargetDescription_subnetId - The ID of the mount target's subnet.
$sel:lifeCycleState:MountTargetDescription', mountTargetDescription_lifeCycleState - Lifecycle state of the mount target.
PosixUser
The full POSIX identity, including the user ID, group ID, and any secondary group IDs, on the access point that is used for all file system operations performed by NFS clients using the access point.
See: newPosixUser smart constructor.
Constructors
| PosixUser' (Maybe [Natural]) Natural Natural |
Instances
| FromJSON PosixUser Source # | |
| ToJSON PosixUser Source # | |
Defined in Amazonka.EFS.Types.PosixUser | |
| Generic PosixUser Source # | |
| Read PosixUser Source # | |
| Show PosixUser Source # | |
| NFData PosixUser Source # | |
Defined in Amazonka.EFS.Types.PosixUser | |
| Eq PosixUser Source # | |
| Hashable PosixUser Source # | |
Defined in Amazonka.EFS.Types.PosixUser | |
| type Rep PosixUser Source # | |
Defined in Amazonka.EFS.Types.PosixUser type Rep PosixUser = D1 ('MetaData "PosixUser" "Amazonka.EFS.Types.PosixUser" "amazonka-efs-2.0-EHRjUBbcNxzHWDmYi0HAD5" 'False) (C1 ('MetaCons "PosixUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "secondaryGids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Natural])) :*: (S1 ('MetaSel ('Just "uid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "gid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))) | |
Create a value of PosixUser 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:secondaryGids:PosixUser', posixUser_secondaryGids - Secondary POSIX group IDs used for all file system operations using this
access point.
$sel:uid:PosixUser', posixUser_uid - The POSIX user ID used for all file system operations using this access
point.
$sel:gid:PosixUser', posixUser_gid - The POSIX group ID used for all file system operations using this access
point.
ReplicationConfigurationDescription
data ReplicationConfigurationDescription Source #
See: newReplicationConfigurationDescription smart constructor.
Constructors
| ReplicationConfigurationDescription' Text Text Text Text POSIX [Destination] |
Instances
newReplicationConfigurationDescription Source #
Arguments
Create a value of ReplicationConfigurationDescription 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:sourceFileSystemId:ReplicationConfigurationDescription', replicationConfigurationDescription_sourceFileSystemId - The ID of the source Amazon EFS file system that is being replicated.
$sel:sourceFileSystemRegion:ReplicationConfigurationDescription', replicationConfigurationDescription_sourceFileSystemRegion - The Amazon Web Services Region in which the source Amazon EFS file
system is located.
$sel:sourceFileSystemArn:ReplicationConfigurationDescription', replicationConfigurationDescription_sourceFileSystemArn - The Amazon Resource Name (ARN) of the current source file system in the
replication configuration.
$sel:originalSourceFileSystemArn:ReplicationConfigurationDescription', replicationConfigurationDescription_originalSourceFileSystemArn - The Amazon Resource Name (ARN) of the original source Amazon EFS file
system in the replication configuration.
$sel:creationTime:ReplicationConfigurationDescription', replicationConfigurationDescription_creationTime - Describes when the replication configuration was created.
$sel:destinations:ReplicationConfigurationDescription', replicationConfigurationDescription_destinations - An array of destination objects. Only one destination object is
supported.
ResourceIdPreference
data ResourceIdPreference Source #
Describes the resource type and its ID preference for the user's Amazon Web Services account, in the current Amazon Web Services Region.
See: newResourceIdPreference smart constructor.
Constructors
| ResourceIdPreference' (Maybe ResourceIdType) (Maybe [Resource]) |
Instances
newResourceIdPreference :: ResourceIdPreference Source #
Create a value of ResourceIdPreference 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:resourceIdType:ResourceIdPreference', resourceIdPreference_resourceIdType - Identifies the EFS resource ID preference, either LONG_ID (17
characters) or SHORT_ID (8 characters).
$sel:resources:ResourceIdPreference', resourceIdPreference_resources - Identifies the Amazon EFS resources to which the ID preference setting
applies, FILE_SYSTEM and MOUNT_TARGET.
RootDirectory
data RootDirectory Source #
Specifies the directory on the Amazon EFS file system that the access
point provides access to. The access point exposes the specified file
system path as the root directory of your file system to applications
using the access point. NFS clients using the access point can only
access data in the access point's RootDirectory and it's
subdirectories.
See: newRootDirectory smart constructor.
Constructors
| RootDirectory' (Maybe CreationInfo) (Maybe Text) |
Instances
newRootDirectory :: RootDirectory Source #
Create a value of RootDirectory 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:creationInfo:RootDirectory', rootDirectory_creationInfo - (Optional) Specifies the POSIX IDs and permissions to apply to the
access point's RootDirectory. If the RootDirectory > Path
specified does not exist, EFS creates the root directory using the
CreationInfo settings when a client connects to an access point. When
specifying the CreationInfo, you must provide values for all
properties.
If you do not provide CreationInfo and the specified RootDirectory >
Path does not exist, attempts to mount the file system using the
access point will fail.
$sel:path:RootDirectory', rootDirectory_path - Specifies the path on the EFS file system to expose as the root
directory to NFS clients using the access point to access the EFS file
system. A path can have up to four subdirectories. If the specified path
does not exist, you are required to provide the CreationInfo.
Tag
A tag is a key-value pair. Allowed characters are letters, white space,
and numbers that can be represented in UTF-8, and the following
characters: + - = . _ : /.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.EFS.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.EFS.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.EFS.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.EFS.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.EFS.Types.Tag" "amazonka-efs-2.0-EHRjUBbcNxzHWDmYi0HAD5" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag 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:key:Tag', tag_key - The tag key (String). The key can't start with aws:.
$sel:value:Tag', tag_value - The value of the tag key.