FileSystemState class

Input properties used for looking up and filtering FileSystem resources.

Constructors

FileSystemState({Input<String?>? arn, Input<String?>? availabilityZoneId, Input<String?>? availabilityZoneName, Input<String?>? creationToken, Input<String?>? dnsName, Input<bool?>? encrypted, Input<String?>? kmsKeyId, Input<List<FileSystemLifecyclePolicy>?>? lifecyclePolicies, Input<String?>? name, Input<int?>? numberOfMountTargets, Input<String?>? ownerId, Input<String?>? performanceMode, Input<FileSystemProtection?>? protection, Input<double?>? provisionedThroughputInMibps, Input<String?>? region, Input<List<FileSystemSizeInByte>?>? sizeInBytes, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<String?>? throughputMode})
Creates a new FileSystemState. arn ARN of the file system. availabilityZoneId The identifier of the Availability Zone in which the file system's One Zone storage classes exist. availabilityZoneName the AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. See user guide for more information. creationToken A unique name (a maximum of 64 characters are allowed) dnsName The DNS name for the filesystem per documented convention. encrypted If true, the disk will be encrypted. kmsKeyId The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true. lifecyclePolicies A file system lifecycle policy object. See lifecyclePolicy block below for details. name The value of the file system's Name tag. numberOfMountTargets The current number of mount targets that the file system has. ownerId The AWS account that created the file system. If the file system was createdby an IAM user, the parent account to which the user belongs is the owner. performanceMode The file system performance mode. Can be either "generalPurpose" or "maxIO" (Default: "generalPurpose"). protection A file system protection object. See protection block below for details. provisionedThroughputInMibps The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with throughputMode set to provisioned. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. sizeInBytes The latest known metered size (in bytes) of data stored in the file system, the value is not the exact size that the file system was at any point in time. See Size In Bytes. tags A map of tags to assign to the file system. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. throughputMode Throughput mode for the file system. Defaults to bursting, matching the CreateFileSystem API default. Note that AWS recommends elastic for most use cases, and elastic is the default in the Amazon EFS console. Valid values: bursting, provisioned, or elastic. When using provisioned, also set provisionedThroughputInMibps.
const
FileSystemState.fromMap(Map<String, dynamic> map)
factory

Properties

arn → Input<String?>?
ARN of the file system.
final
availabilityZoneId → Input<String?>?
The identifier of the Availability Zone in which the file system's One Zone storage classes exist.
final
availabilityZoneName → Input<String?>?
the AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. See user guide for more information.
final
creationToken → Input<String?>?
A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file system creation. By default generated by this provider. See Elastic File System user guide for more information.
final
dnsName → Input<String?>?
The DNS name for the filesystem per documented convention.
final
encrypted → Input<bool?>?
If true, the disk will be encrypted.
final
hashCode → int
The hash code for this object.
no setterinherited
kmsKeyId → Input<String?>?
The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
final
lifecyclePolicies → Input<List<FileSystemLifecyclePolicy>?>?
A file system lifecycle policy object. See lifecyclePolicy block below for details.
final
name → Input<String?>?
The value of the file system's Name tag.
final
numberOfMountTargets → Input<int?>?
The current number of mount targets that the file system has.
final
ownerId → Input<String?>?
The AWS account that created the file system. If the file system was createdby an IAM user, the parent account to which the user belongs is the owner.
final
performanceMode → Input<String?>?
The file system performance mode. Can be either "generalPurpose" or "maxIO" (Default: "generalPurpose").
final
protection → Input<FileSystemProtection?>?
A file system protection object. See protection block below for details.
final
provisionedThroughputInMibps → Input<double?>?
The throughput, measured in MiB/s, that you want to provision for the file system. Only applicable with throughputMode set to provisioned.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sizeInBytes → Input<List<FileSystemSizeInByte>?>?
The latest known metered size (in bytes) of data stored in the file system, the value is not the exact size that the file system was at any point in time. See Size In Bytes.
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the file system. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
throughputMode → Input<String?>?
Throughput mode for the file system. Defaults to bursting, matching the CreateFileSystem API default. Note that AWS recommends elastic for most use cases, and elastic is the default in the Amazon EFS console. Valid values: bursting, provisioned, or elastic. When using provisioned, also set provisionedThroughputInMibps.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited