Skip to content

FileCache

Source code in docs_src/capo_fsx/types/file_cache.py
class FileCache(TypedDict, closed=True):
    owner_id: NotRequired["capo_fsx.types.aws_account_id.AWSAccountId"]
    creation_time: NotRequired["capo_fsx.types.creation_time.CreationTime"]
    file_cache_id: NotRequired["capo_fsx.types.file_cache_id.FileCacheId"]
    """<p>The system-generated, unique ID of the cache.</p>"""
    file_cache_type: NotRequired["capo_fsx.types.file_cache_type.FileCacheType"]
    """<p>The type of cache, which must be <code>LUSTRE</code>.</p>"""
    file_cache_type_version: NotRequired[
        "capo_fsx.types.file_system_type_version.FileSystemTypeVersion"
    ]
    """<p>The Lustre version of the cache, which must be <code>2.12</code>.</p>"""
    lifecycle: NotRequired["capo_fsx.types.file_cache_lifecycle.FileCacheLifecycle"]
    """<p>The lifecycle status of the cache. The following are the possible values and what they mean:</p> <ul> <li> <p> <code>AVAILABLE</code> - The cache is in a healthy state, and is reachable and available for use.</p> </li> <li> <p> <code>CREATING</code> - The new cache is being created.</p> </li> <li> <p> <code>DELETING</code> - An existing cache is being deleted.</p> </li> <li> <p> <code>UPDATING</code> - The cache is undergoing a customer-initiated update.</p> </li> <li> <p> <code>FAILED</code> - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.</p> </li> </ul>"""
    failure_details: NotRequired[
        "capo_fsx.types.file_cache_failure_details.FileCacheFailureDetails"
    ]
    """<p>A structure providing details of any failures that occurred.</p>"""
    storage_capacity: NotRequired["capo_fsx.types.storage_capacity.StorageCapacity"]
    """<p>The storage capacity of the cache in gibibytes (GiB).</p>"""
    vpc_id: NotRequired["capo_fsx.types.vpc_id.VpcId"]
    subnet_ids: NotRequired["capo_fsx.types.subnet_ids.SubnetIds"]
    network_interface_ids: NotRequired[
        "capo_fsx.types.network_interface_ids.NetworkInterfaceIds"
    ]
    dns_name: NotRequired["capo_fsx.types.dns_name.DNSName"]
    """<p>The Domain Name System (DNS) name for the cache.</p>"""
    kms_key_id: NotRequired["capo_fsx.types.kms_key_id.KmsKeyId"]
    """<p>Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a <code>KmsKeyId</code> isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html">Encrypt</a> in the <i>Key Management Service API Reference</i>.</p>"""
    resource_arn: NotRequired["capo_fsx.types.resource_arn.ResourceARN"]
    lustre_configuration: NotRequired[
        "capo_fsx.types.file_cache_lustre_configuration.FileCacheLustreConfiguration"
    ]
    """<p>The configuration for the Amazon File Cache resource.</p>"""
    data_repository_association_ids: NotRequired[
        "capo_fsx.types.data_repository_association_ids.DataRepositoryAssociationIds"
    ]
    """<p>A list of IDs of data repository associations that are associated with this cache.</p>"""

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

data_repository_association_ids instance-attribute

data_repository_association_ids: NotRequired[DataRepositoryAssociationIds]

A list of IDs of data repository associations that are associated with this cache.

dns_name instance-attribute

dns_name: NotRequired[DNSName]

The Domain Name System (DNS) name for the cache.

failure_details instance-attribute

failure_details: NotRequired[FileCacheFailureDetails]

A structure providing details of any failures that occurred.

file_cache_id instance-attribute

file_cache_id: NotRequired[FileCacheId]

The system-generated, unique ID of the cache.

file_cache_type instance-attribute

file_cache_type: NotRequired[FileCacheType]

The type of cache, which must be LUSTRE.

file_cache_type_version instance-attribute

file_cache_type_version: NotRequired[FileSystemTypeVersion]

The Lustre version of the cache, which must be 2.12.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.

lifecycle instance-attribute

lifecycle: NotRequired[FileCacheLifecycle]

The lifecycle status of the cache. The following are the possible values and what they mean:

  • AVAILABLE - The cache is in a healthy state, and is reachable and available for use.

  • CREATING - The new cache is being created.

  • DELETING - An existing cache is being deleted.

  • UPDATING - The cache is undergoing a customer-initiated update.

  • FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.

lustre_configuration instance-attribute

lustre_configuration: NotRequired[FileCacheLustreConfiguration]

The configuration for the Amazon File Cache resource.

network_interface_ids instance-attribute

network_interface_ids: NotRequired[NetworkInterfaceIds]

owner_id instance-attribute

owner_id: NotRequired[AWSAccountId]

resource_arn instance-attribute

resource_arn: NotRequired[ResourceARN]

storage_capacity instance-attribute

storage_capacity: NotRequired[StorageCapacity]

The storage capacity of the cache in gibibytes (GiB).

subnet_ids instance-attribute

subnet_ids: NotRequired[SubnetIds]

vpc_id instance-attribute

vpc_id: NotRequired[VpcId]