GetFileSystemResult

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)

Constructors

Link copied to clipboard
constructor(arn: String? = null, backupPolicy: FileSystemBackupPolicy? = null, fileSystemId: String? = null, fileSystemPolicy: Any? = null, fileSystemProtection: FileSystemProtection? = null, fileSystemTags: List<Tag>? = null, lifecyclePolicies: List<FileSystemLifecyclePolicy>? = null, provisionedThroughputInMibps: Double? = null, replicationConfiguration: FileSystemReplicationConfiguration? = null, throughputMode: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String? = null

The Amazon Resource Name (ARN) of the EFS file system. Example: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-0123456789abcdef8

Link copied to clipboard

Use the `BackupPolicy` to turn automatic backups on or off for the file system.

Link copied to clipboard
val fileSystemId: String? = null

The ID of the EFS file system. For example: fs-abcdef0123456789a

Link copied to clipboard
val fileSystemPolicy: Any? = null

The `FileSystemPolicy` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see Using to control NFS access to Amazon EFS in the Amazon EFS User Guide. Search the CloudFormation User Guide for AWS::EFS::FileSystem for more information about the expected schema for this property.

Link copied to clipboard

Describes the protection on the file system.

Link copied to clipboard
val fileSystemTags: List<Tag>? = null

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 resources in the General Reference Guide.

Link copied to clipboard

An array of `LifecyclePolicy` objects that define the file system's `LifecycleConfiguration` object. A `LifecycleConfiguration` object informs Lifecycle management of the following:

Link copied to clipboard

The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if `ThroughputMode` is set to `provisioned`. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.

Link copied to clipboard

Describes the replication configuration for a specific file system.

Link copied to clipboard
val throughputMode: String? = null

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 Provisioned throughput 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`.