View a markdown version of this page

AWS::FSx::FileCache - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::FSx::FileCache

A description of a specific Amazon File Cache resource, which is a response object from the DescribeFileCaches operation.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::FSx::FileCache",
  "Properties" : {
      "CopyTagsToDataRepositoryAssociations" : Boolean,
      "DataRepositoryAssociations" : [ DataRepositoryAssociation, ... ],
      "FileCacheType" : String,
      "FileCacheTypeVersion" : String,
      "KmsKeyId" : String,
      "LustreConfiguration" : LustreConfiguration,
      "SecurityGroupIds" : [ String, ... ],
      "StorageCapacity" : Integer,
      "SubnetIds" : [ String, ... ],
      "Tags" : [ Tag, ... ]
    }
}

Properties

CopyTagsToDataRepositoryAssociations

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

Required: No

Type: Boolean

Update requires: Replacement

DataRepositoryAssociations

Property description not available.

Required: No

Type: Array of DataRepositoryAssociation

Maximum: 8

Update requires: Replacement

FileCacheType

The type of cache, which must be LUSTRE.

Required: Yes

Type: String

Allowed values: LUSTRE

Update requires: Replacement

FileCacheTypeVersion

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

Required: Yes

Type: String

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

Minimum: 1

Maximum: 20

Update requires: Replacement

KmsKeyId

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

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: Replacement

LustreConfiguration

The configuration for the Amazon File Cache resource.

Required: No

Type: LustreConfiguration

Update requires: No interruption

SecurityGroupIds

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

Required: No

Type: Array of String

Minimum: 11

Maximum: 20 | 50

Update requires: Replacement

StorageCapacity

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

Required: Yes

Type: Integer

Minimum: 0

Maximum: 2147483647

Update requires: Replacement

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.

Required: Yes

Type: Array of String

Minimum: 15

Maximum: 24 | 50

Update requires: Replacement

Tags

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

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

CreationTime

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

DataRepositoryAssociationIds

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

DNSName

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

FileCacheId

The system-generated, unique ID of the cache.

Lifecycle

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.

LustreConfiguration.MountName

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.

NetworkInterfaceIds

A list of network interface IDs.

OwnerId

Property description not available.

ResourceARN

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

VpcId

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