Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1441397379.2 KB

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.

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.

post/#X-Amz-Target=AWSSimbaAPIService_v20180301.CreateFileCache

Headers

X-Amz-Target'AWSSimbaAPIService_v20180301.CreateFileCache' required

Request body

ClientRequestTokenstring
<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>
FileCacheType'LUSTRE' required

The type of cache that you're creating, which must be <code>LUSTRE</code>.

FileCacheTypeVersionstring required

Sets the Lustre version for the cache that you're creating, which must be <code>2.12</code>.

StorageCapacityinteger required

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

SubnetIdsSubnetId[] 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 <code>CreateFileCache</code> operation.

SecurityGroupIdsSecurityGroupId[]

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.

CopyTagsToDataRepositoryAssociationsboolean

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

KmsKeyIdstring

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>.

Response

Success