Skip to content

CreateFileCacheRequest

Source code in docs_src/capo_fsx/types/create_file_cache_request.py
class CreateFileCacheRequest(TypedDict, closed=True):
    client_request_token: NotRequired[
        "capo_fsx.types.client_request_token.ClientRequestToken"
    ]
    """<p>An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.</p> <p>By using the idempotent operation, you can retry a <code>CreateFileCache</code> operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a cache, the client receives success as long as the parameters are the same.</p>"""
    file_cache_type: NotRequired["capo_fsx.types.file_cache_type.FileCacheType"]
    """<p>The type of cache that you're creating, which must be <code>LUSTRE</code>.</p>"""
    file_cache_type_version: NotRequired[
        "capo_fsx.types.file_system_type_version.FileSystemTypeVersion"
    ]
    """<p>Sets the Lustre version for the cache that you're creating, which must be <code>2.12</code>.</p>"""
    storage_capacity: NotRequired["capo_fsx.types.storage_capacity.StorageCapacity"]
    """<p>The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.</p>"""
    subnet_ids: NotRequired["capo_fsx.types.subnet_ids.SubnetIds"]
    security_group_ids: NotRequired[
        "capo_fsx.types.security_group_ids.SecurityGroupIds"
    ]
    """<p>A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.</p>"""
    tags: NotRequired["capo_fsx.types.tags.Tags"]
    copy_tags_to_data_repository_associations: NotRequired[
        "capo_fsx.types.copy_tags_to_data_repository_associations.CopyTagsToDataRepositoryAssociations"
    ]
    """<p>A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.</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>"""
    lustre_configuration: NotRequired[
        "capo_fsx.types.create_file_cache_lustre_configuration.CreateFileCacheLustreConfiguration"
    ]
    """<p>The configuration for the Amazon File Cache resource being created.</p>"""
    data_repository_associations: NotRequired[
        "capo_fsx.types.create_file_cache_data_repository_associations.CreateFileCacheDataRepositoryAssociations"
    ]
    """<p>A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.</p> <p>The DRA configurations must meet the following requirements:</p> <ul> <li> <p>All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.</p> </li> <li> <p>An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.</p> </li> </ul> <p>DRA automatic import and automatic export is not supported.</p>"""

client_request_token instance-attribute

client_request_token: NotRequired[ClientRequestToken]

An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

By using the idempotent operation, you can retry a CreateFileCache operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a cache, the client receives success as long as the parameters are the same.

copy_tags_to_data_repository_associations instance-attribute

copy_tags_to_data_repository_associations: NotRequired[
    CopyTagsToDataRepositoryAssociations
]

A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.

data_repository_associations instance-attribute

data_repository_associations: NotRequired[CreateFileCacheDataRepositoryAssociations]

A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol.

The DRA configurations must meet the following requirements:

  • All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time.

  • An NFS DRA must link to an NFS file system that supports the NFSv3 protocol.

DRA automatic import and automatic export is not supported.

file_cache_type instance-attribute

file_cache_type: NotRequired[FileCacheType]

The type of cache that you're creating, which must be LUSTRE.

file_cache_type_version instance-attribute

file_cache_type_version: NotRequired[FileSystemTypeVersion]

Sets the Lustre version for the cache that you're creating, 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.

lustre_configuration instance-attribute

lustre_configuration: NotRequired[CreateFileCacheLustreConfiguration]

The configuration for the Amazon File Cache resource being created.

security_group_ids instance-attribute

security_group_ids: NotRequired[SecurityGroupIds]

A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.

storage_capacity instance-attribute

storage_capacity: NotRequired[StorageCapacity]

The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.

subnet_ids instance-attribute

subnet_ids: NotRequired[SubnetIds]

tags instance-attribute

tags: NotRequired[Tags]