Package-level declarations

Types

Link copied to clipboard
data class AccessPointCreationInfo(val ownerGid: String, val ownerUid: String, val permissions: String)

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.

Link copied to clipboard
data class AccessPointPosixUser(val gid: String, val secondaryGids: List<String>? = null, val uid: String)

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.

Link copied to clipboard
data class AccessPointRootDirectory(val creationInfo: AccessPointCreationInfo? = null, val path: String? = null)

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 its subdirectories.

Link copied to clipboard

The backup policy turns automatic backups for the file system on or off.

Link copied to clipboard
data class FileSystemLifecyclePolicy(val transitionToArchive: String? = null, val transitionToIa: String? = null, val transitionToPrimaryStorageClass: String? = null)

Describes a policy used by Lifecycle management that specifies when to transition files into and out of the EFS storage classes. For more information, see Managing file system storage. + Each `LifecyclePolicy` object can 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`, `TransitionToArchive`, `TransitionToPrimaryStorageClass`.

Link copied to clipboard
data class FileSystemProtection(val replicationOverwriteProtection: FileSystemProtectionReplicationOverwriteProtection? = null)

Describes the protection on the file system.

Link copied to clipboard

Describes the replication configuration for a specific file system.

Link copied to clipboard
data class FileSystemReplicationDestination(val availabilityZoneName: String? = null, val fileSystemId: String? = null, val kmsKeyId: String? = null, val region: String? = null)

Describes the destination file system in the replication configuration.

Link copied to clipboard
data class GetAccessPointResult(val accessPointId: String? = null, val accessPointTags: List<Tag>? = null, val arn: String? = null)
Link copied to clipboard
data class GetFileSystemResult(val arn: String? = null, val backupPolicy: FileSystemBackupPolicy? = null, val fileSystemId: String? = null, val fileSystemPolicy: Any? = null, val fileSystemProtection: FileSystemProtection? = null, val fileSystemTags: List<Tag>? = null, val lifecyclePolicies: List<FileSystemLifecyclePolicy>? = null, val provisionedThroughputInMibps: Double? = null, val replicationConfiguration: FileSystemReplicationConfiguration? = null, val throughputMode: String? = null)
Link copied to clipboard
data class GetMountTargetResult(val id: String? = null, val securityGroups: List<String>? = null)