CreateFileCache - Amazon FSx

CreateFileCache

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.

Request Syntax

{ "ClientRequestToken": "string", "CopyTagsToDataRepositoryAssociations": boolean, "DataRepositoryAssociations": [ { "DataRepositoryPath": "string", "DataRepositorySubdirectories": [ "string" ], "FileCachePath": "string", "NFS": { "DnsIps": [ "string" ], "Version": "string" } } ], "FileCacheType": "string", "FileCacheTypeVersion": "string", "KmsKeyId": "string", "LustreConfiguration": { "DeploymentType": "string", "MetadataConfiguration": { "StorageCapacity": number }, "PerUnitStorageThroughput": number, "WeeklyMaintenanceStartTime": "string" }, "SecurityGroupIds": [ "string" ], "StorageCapacity": number, "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClientRequestToken

An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS 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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [A-za-z0-9_.-]{0,63}$

Required: No

CopyTagsToDataRepositoryAssociations

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

Type: Boolean

Required: No

DataRepositoryAssociations

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.

Type: Array of FileCacheDataRepositoryAssociation objects

Array Members: Maximum number of 8 items.

Required: No

FileCacheType

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

Type: String

Valid Values: LUSTRE

Required: Yes

FileCacheTypeVersion

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: ^[0-9](.[0-9]*)*$

Required: Yes

KmsKeyId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^.{1,2048}$

Required: No

LustreConfiguration

The configuration for the Amazon File Cache resource being created.

Type: CreateFileCacheLustreConfiguration object

Required: No

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.

Type: Array of strings

Array Members: Maximum number of 50 items.

Length Constraints: Minimum length of 11. Maximum length of 20.

Pattern: ^(sg-[0-9a-f]{8,})$

Required: No

StorageCapacity

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

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2147483647.

Required: Yes

SubnetIds

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.

Type: Array of strings

Array Members: Maximum number of 50 items.

Length Constraints: Minimum length of 15. Maximum length of 24.

Pattern: ^(subnet-[0-9a-f]{8,})$

Required: Yes

Tags

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

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax

{ "FileCache": { "CopyTagsToDataRepositoryAssociations": boolean, "CreationTime": number, "DataRepositoryAssociationIds": [ "string" ], "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileCacheId": "string", "FileCacheType": "string", "FileCacheTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "DeploymentType": "string", "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "StorageCapacity": number }, "MountName": "string", "PerUnitStorageThroughput": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcId": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FileCache

A description of the cache that was created.

Type: FileCacheCreating object

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequest

A generic error indicating a failure with a client request.

HTTP Status Code: 400

IncompatibleParameterError

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

HTTP Status Code: 400

InternalServerError

A generic error indicating a server-side failure.

HTTP Status Code: 500

InvalidNetworkSettings

One or more network settings specified in the request are invalid.

HTTP Status Code: 400

InvalidPerUnitStorageThroughput

An invalid value for PerUnitStorageThroughput was provided. Please create your file system again, using a valid value.

HTTP Status Code: 400

MissingFileCacheConfiguration

A cache configuration is required for this operation.

HTTP Status Code: 400

ServiceLimitExceeded

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: