FSx / Client / create_file_cache

create_file_cache

FSx.Client.create_file_cache(**kwargs)

Creates a new Amazon File Cache resource.

You can use this operation with a client request token in the request that Amazon File Cache uses to ensure idempotent creation. If a cache with the specified client request token exists and the parameters match, CreateFileCache returns the description of the existing cache. If a cache with the specified client request token exists and the parameters don’t match, this call returns IncompatibleParameterError. If a file cache with the specified client request token doesn’t exist, CreateFileCache does the following:

• Creates a new, empty Amazon File Cache resourcewith an assigned ID, and an initial lifecycle state of CREATING.

• Returns the description of the cache in JSON format.

Note

The CreateFileCache call returns while the cache’s lifecycle state is still CREATING. You can check the cache creation status by calling the DescribeFileCaches operation, which returns the cache state along with other information.

See also: AWS API Documentation

Request Syntax

response = client.create_file_cache(
    ClientRequestToken='string',
    FileCacheType='LUSTRE',
    FileCacheTypeVersion='string',
    StorageCapacity=123,
    SubnetIds=[
        'string',
    ],
    SecurityGroupIds=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    CopyTagsToDataRepositoryAssociations=True|False,
    KmsKeyId='string',
    LustreConfiguration={
        'PerUnitStorageThroughput': 123,
        'DeploymentType': 'CACHE_1',
        'WeeklyMaintenanceStartTime': 'string',
        'MetadataConfiguration': {
            'StorageCapacity': 123
        }
    },
    DataRepositoryAssociations=[
        {
            'FileCachePath': 'string',
            'DataRepositoryPath': 'string',
            'DataRepositorySubdirectories': [
                'string',
            ],
            'NFS': {
                'Version': 'NFS3',
                'DnsIps': [
                    'string',
                ]
            }
        },
    ]
)

Parameters:

• ClientRequestToken (string) –

  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.

  This field is autopopulated if not provided.

• FileCacheType (string) –

  [REQUIRED]

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

• FileCacheTypeVersion (string) –

  [REQUIRED]

  Sets the Lustre version for the cache that you’re creating, which must be 2.12.

• StorageCapacity (integer) –

  [REQUIRED]

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

• SubnetIds (list) –

  [REQUIRED]

  A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID in a call to the CreateFileCache operation.

  • (string) –

    The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.

• SecurityGroupIds (list) –

  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.

  • (string) –

    The ID of your Amazon EC2 security group. This ID is used to control network access to the endpoint that Amazon FSx creates on your behalf in each subnet. For more information, see Amazon EC2 Security groups for Linux instances in the Amazon EC2 User Guide.

• Tags (list) –

  A list of Tag values, with a maximum of 50 elements.

  • (dict) –

    Specifies a key-value pair for a resource tag.

    • Key (string) – [REQUIRED]

      A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

    • Value (string) – [REQUIRED]

      A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

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

• KmsKeyId (string) – 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.

• LustreConfiguration (dict) –

  The configuration for the Amazon File Cache resource being created.

  • PerUnitStorageThroughput (integer) – [REQUIRED]

    Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.

  • DeploymentType (string) – [REQUIRED]

    Specifies the cache deployment type, which must be CACHE_1.

  • WeeklyMaintenanceStartTime (string) –

    A recurring weekly time, in the format D:HH:MM.

    D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

    HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

    For example, 1:05:00 specifies maintenance at 5 AM Monday.

  • MetadataConfiguration (dict) – [REQUIRED]

    The configuration for a Lustre MDT (Metadata Target) storage volume.

    • StorageCapacity (integer) – [REQUIRED]

      The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.

• DataRepositoryAssociations (list) –

  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.

  • (dict) –

    The configuration for a data repository association (DRA) to be created during the Amazon File Cache resource creation. The DRA links the cache to either an Amazon S3 bucket or prefix, or a Network File System (NFS) data repository that supports the NFSv3 protocol.

    The DRA does not support automatic import or automatic export.

    • FileCachePath (string) – [REQUIRED]

      A path on the cache that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2.

      This path specifies where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other can be linked to the directory.

      Note

      The cache path can only be set to root (/) on an NFS DRA when DataRepositorySubdirectories is specified. If you specify root (/) as the cache path, you can create only one DRA on the cache.

      The cache path cannot be set to root (/) for an S3 DRA.

    • DataRepositoryPath (string) – [REQUIRED]

      The path to the S3 or NFS data repository that links to the cache. You must provide one of the following paths:

      • The path can be an NFS data repository that links to the cache. The path can be in one of two formats:

        • If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nfs://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association.

        • If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in the format nfs://filer-domain-name, which indicates the root of the subdirectories specified with the DataRepositorySubdirectories parameter.

      • The path can be an S3 bucket or prefix in the format s3://bucket-name/prefix/ (where prefix is optional).

    • DataRepositorySubdirectories (list) –

      A list of NFS Exports that will be linked with this data repository association. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories.

      • (string) –

    • NFS (dict) –

      The configuration for a data repository association that links an Amazon File Cache resource to an NFS data repository.

      • Version (string) – [REQUIRED]

        The version of the NFS (Network File System) protocol of the NFS data repository. The only supported value is NFS3, which indicates that the data repository must support the NFSv3 protocol.

      • DnsIps (list) –

        A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.

        • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'FileCache': {
        'OwnerId': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'FileCacheId': 'string',
        'FileCacheType': 'LUSTRE',
        'FileCacheTypeVersion': 'string',
        'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'UPDATING'|'FAILED',
        'FailureDetails': {
            'Message': 'string'
        },
        'StorageCapacity': 123,
        'VpcId': 'string',
        'SubnetIds': [
            'string',
        ],
        'NetworkInterfaceIds': [
            'string',
        ],
        'DNSName': 'string',
        'KmsKeyId': 'string',
        'ResourceARN': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'CopyTagsToDataRepositoryAssociations': True|False,
        'LustreConfiguration': {
            'PerUnitStorageThroughput': 123,
            'DeploymentType': 'CACHE_1',
            'MountName': 'string',
            'WeeklyMaintenanceStartTime': 'string',
            'MetadataConfiguration': {
                'StorageCapacity': 123
            },
            'LogConfiguration': {
                'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR',
                'Destination': 'string'
            }
        },
        'DataRepositoryAssociationIds': [
            'string',
        ]
    }
}

Response Structure

• (dict) –

  • FileCache (dict) –

    A description of the cache that was created.

    • OwnerId (string) –

      An Amazon Web Services account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.

    • CreationTime (datetime) –

      The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

    • FileCacheId (string) –

      The system-generated, unique ID of the cache.

    • FileCacheType (string) –

      The type of cache, which must be LUSTRE.

    • FileCacheTypeVersion (string) –

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

    • Lifecycle (string) –

      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.

    • FailureDetails (dict) –

      A structure providing details of any failures that occurred in creating a cache.

      • Message (string) –

        A message describing any failures that occurred.

    • StorageCapacity (integer) –

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

    • VpcId (string) –

      The ID of your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.

    • SubnetIds (list) –

      A list of subnet IDs that the cache will be accessible from. You can specify only one subnet ID in a call to the CreateFileCache operation.

      • (string) –

        The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.

    • NetworkInterfaceIds (list) –

      A list of network interface IDs.

      • (string) –

        An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances.

    • DNSName (string) –

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

    • KmsKeyId (string) –

      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.

    • ResourceARN (string) –

      The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

    • Tags (list) –

      A list of Tag values, with a maximum of 50 elements.

      • (dict) –

        Specifies a key-value pair for a resource tag.

        • Key (string) –

          A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

        • Value (string) –

          A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

    • CopyTagsToDataRepositoryAssociations (boolean) –

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

    • LustreConfiguration (dict) –

      The configuration for the Amazon File Cache resource.

      • PerUnitStorageThroughput (integer) –

        Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. Cache throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). The only supported value is 1000.

      • DeploymentType (string) –

        The deployment type of the Amazon File Cache resource, which must be CACHE_1.

      • MountName (string) –

        You use the MountName value when mounting the cache. If you pass a cache ID to the DescribeFileCaches operation, it returns the the MountName value as part of the cache’s description.

      • WeeklyMaintenanceStartTime (string) –

        A recurring weekly time, in the format D:HH:MM.

        D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

        HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

        For example, 1:05:00 specifies maintenance at 5 AM Monday.

      • MetadataConfiguration (dict) –

        The configuration for a Lustre MDT (Metadata Target) storage volume.

        • StorageCapacity (integer) –

          The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.

      • LogConfiguration (dict) –

        The configuration for Lustre logging used to write the enabled logging events for your Amazon File Cache resource to Amazon CloudWatch Logs.

        • Level (string) –

          The data repository events that are logged by Amazon FSx.

          • WARN_ONLY - only warning events are logged.

          • ERROR_ONLY - only error events are logged.

          • WARN_ERROR - both warning events and error events are logged.

          • DISABLED - logging of data repository events is turned off.

          Note that Amazon File Cache uses a default setting of WARN_ERROR, which can’t be changed.

        • Destination (string) –

          The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.

    • DataRepositoryAssociationIds (list) –

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

      • (string) –

Exceptions

• FSx.Client.exceptions.BadRequest

• FSx.Client.exceptions.IncompatibleParameterError

• FSx.Client.exceptions.InvalidNetworkSettings

• FSx.Client.exceptions.InvalidPerUnitStorageThroughput

• FSx.Client.exceptions.ServiceLimitExceeded

• FSx.Client.exceptions.InternalServerError

• FSx.Client.exceptions.MissingFileCacheConfiguration