FileSystemDescription ¶

class FileSystemDescription(TypedDict, closed=True):
    owner_id: "capo_efs.types.aws_account_id.AwsAccountId"
    """<p>The Amazon Web Services account that created the file system.</p>"""
    creation_token: "capo_efs.types.creation_token.CreationToken"
    """<p>The opaque string specified in the request.</p>"""
    file_system_id: "capo_efs.types.file_system_id.FileSystemId"
    """<p>The ID of the file system, assigned by Amazon EFS.</p>"""
    file_system_arn: NotRequired["capo_efs.types.file_system_arn.FileSystemArn"]
    """<p>The Amazon Resource Name (ARN) for the EFS file system, in the format <code>arn:aws:elasticfilesystem:<i>region</i>:<i>account-id</i>:file-system/<i>file-system-id</i> </code>. Example with sample data: <code>arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567</code> </p>"""
    creation_time: "capo_efs.types.timestamp.Timestamp"
    """<p>The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).</p>"""
    life_cycle_state: "capo_efs.types.life_cycle_state.LifeCycleState"
    """<p>The lifecycle phase of the file system.</p>"""
    name: NotRequired["capo_efs.types.tag_value.TagValue"]
    """<p>You can add tags to a file system, including a <code>Name</code> tag. For more information, see <a>CreateFileSystem</a>. If the file system has a <code>Name</code> tag, Amazon EFS returns the value in this field. </p>"""
    number_of_mount_targets: "capo_efs.types.mount_target_count.MountTargetCount"
    """<p>The current number of mount targets that the file system has. For more information, see <a>CreateMountTarget</a>.</p>"""
    size_in_bytes: "capo_efs.types.file_system_size.FileSystemSize"
    """<p>The latest known metered size (in bytes) of data stored in the file system, in its <code>Value</code> field, and the time at which that size was determined in its <code>Timestamp</code> field. The <code>Timestamp</code> value is the integer number of seconds since 1970-01-01T00:00:00Z. The <code>SizeInBytes</code> 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, <code>SizeInBytes</code> 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. </p>"""
    performance_mode: "capo_efs.types.performance_mode.PerformanceMode"
    """<p>The performance mode of the file system.</p>"""
    encrypted: NotRequired["capo_efs.types.encrypted.Encrypted"]
    """<p>A Boolean value that, if true, indicates that the file system is encrypted.</p>"""
    kms_key_id: NotRequired["capo_efs.types.kms_key_id.KmsKeyId"]
    """<p>The ID of an KMS key used to protect the encrypted file system.</p>"""
    throughput_mode: NotRequired["capo_efs.types.throughput_mode.ThroughputMode"]
    """<p>Displays the file system's throughput mode. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes">Throughput modes</a> in the <i>Amazon EFS User Guide</i>. </p>"""
    provisioned_throughput_in_mibps: NotRequired[
        "capo_efs.types.provisioned_throughput_in_mibps.ProvisionedThroughputInMibps"
    ]
    """<p>The amount of provisioned throughput, measured in MiBps, for the file system. Valid for file systems using <code>ThroughputMode</code> set to <code>provisioned</code>.</p>"""
    availability_zone_name: NotRequired[
        "capo_efs.types.availability_zone_name.AvailabilityZoneName"
    ]
    """<p>Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for One Zone file systems. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html">Using EFS storage classes</a> in the <i>Amazon EFS User Guide</i>.</p>"""
    availability_zone_id: NotRequired[
        "capo_efs.types.availability_zone_id.AvailabilityZoneId"
    ]
    """<p>The unique and consistent identifier of the Availability Zone in which the file system is located, and is valid only for One Zone file systems. For example, <code>use1-az1</code> 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.</p>"""
    tags: "capo_efs.types.tags.Tags"
    """<p>The tags associated with the file system, presented as an array of <code>Tag</code> objects.</p>"""
    file_system_protection: NotRequired[
        "capo_efs.types.file_system_protection_description.FileSystemProtectionDescription"
    ]
    """<p>Describes the protection on the file system. </p>"""