AWS::FSx::FileCache

FSx FileCache

Resource Type definition for AWS::FSx::FileCache

Properties

10 configurable properties. 4 required. Click a row to see details.

Filter:

Property	Type	Flags
`FileCacheType`	`string`	RequiredCreate-only
`FileCacheTypeVersion`	`string`	RequiredCreate-only
`StorageCapacity`	`integer`	RequiredCreate-only
`SubnetIds`	`Array<string>`	RequiredCreate-only
`CopyTagsToDataRepositoryAssociations`	`boolean`	Create-onlyWrite-only
`DataRepositoryAssociations`	`Array<DataRepositoryAssociation>`	Create-onlyWrite-only
`KmsKeyId`	`string`	Create-only
`LustreConfiguration`	`LustreConfiguration`
`SecurityGroupIds`	`Array<string>`	Create-onlyWrite-only
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`CreationTime`	`string`	The time the cache was created
`DataRepositoryAssociationIds`	`Array<string>`	A list of IDs of data repository associations that are associated with this cache
`DNSName`	`string`	The DNS name for the cache
`FileCacheId`	`string`	The ID of the file cache
`Lifecycle`	`string`	The lifecycle status of the cache
`NetworkInterfaceIds`	`Array<string>`	Network interface IDs for the cache
`OwnerId`	`string`	The AWS account ID of the cache owner
`ResourceARN`	`string`	The Amazon Resource Name (ARN) of the file cache
`VpcId`	`string`	The VPC ID of the cache

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::FSx::FileCache

Resources:
  MyResource:
    Type: AWS::FSx::FileCache
    Properties:
      FileCacheType: "LUSTRE"
      FileCacheTypeVersion: "value"
      StorageCapacity: 1
      SubnetIds: "my-subnetids"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

fsx:CreateFileCachefsx:DescribeFileCachesfsx:CreateDataRepositoryAssociationfsx:TagResourcefsx:ListTagsForResources3:ListBuckets3:GetBucketLocations3:GetBucketPolicys3:PutBucketPolicys3:GetObjects3:PutObjects3:GetBucketAcls3:HeadBuckets3:GetEncryptionConfigurationec2:DescribeSecurityGroupsec2:DescribeSubnetsec2:DescribeVpcsec2:DescribeNetworkInterfacesec2:GetSecurityGroupsForVpcec2:CreateNetworkInterfaceec2:CreateNetworkInterfacePermissionec2:DescribeRouteTablesec2:CreateTagslogs:CreateLogGrouplogs:CreateLogStreamlogs:PutLogEventsiam:CreateServiceLinkedRoleiam:PassRolekms:DescribeKeykms:CreateGrant

read

fsx:DescribeFileCachesfsx:ListTagsForResource

update

fsx:UpdateFileCachefsx:DescribeFileCachesfsx:TagResourcefsx:UntagResourcefsx:ListTagsForResource

delete

fsx:DeleteFileCachefsx:DescribeFileCachesfsx:DeleteDataRepositoryAssociation

list

fsx:DescribeFileCaches

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceFSx

Properties19

Required4

TaggingSupported

Primary IDResourceARN

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

FileCacheTypeFileCacheTypeVersionStorageCapacitySubnetIdsSecurityGroupIdsKmsKeyIdCopyTagsToDataRepositoryAssociationsDataRepositoryAssociationsLustreConfiguration/PerUnitStorageThroughputLustreConfiguration/DeploymentTypeLustreConfiguration/MetadataConfiguration

Related Resources

External Links

AWS Documentation