AWS::S3Files::FileSystem - AWS CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

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

AWS::S3Files::FileSystem

The AWS::S3Files::FileSystem resource specifies an Amazon S3 Files file system scoped to a bucket or prefix within a bucket, enabling file system access to S3 data.

Syntax

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

JSON

{
  "Type" : "AWS::S3Files::FileSystem",
  "Properties" : {
      "AcceptBucketWarning" : Boolean,
      "Bucket" : String,
      "ClientToken" : String,
      "KmsKeyId" : String,
      "Prefix" : String,
      "RoleArn" : String,
      "SynchronizationConfiguration" : SynchronizationConfiguration,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::S3Files::FileSystem
Properties:
  AcceptBucketWarning: Boolean
  Bucket: String
  ClientToken: String
  KmsKeyId: String
  Prefix: String
  RoleArn: String
  SynchronizationConfiguration: 
    SynchronizationConfiguration
  Tags: 
    - Tag

Properties

AcceptBucketWarning

A boolean that indicates you have read and accept the warning about the S3 bucket being used for the file system. Set this to true to acknowledge the warning.

Required: No

Type: Boolean

Update requires: Replacement

Bucket

The Amazon Resource Name (ARN) of the S3 bucket.

Required: Yes

Type: String

Pattern: ^(arn:aws[a-zA-Z0-9-]*:s3:::.+)$

Update requires: Replacement

ClientToken

A string of up to 64 ASCII characters that Amazon S3 Files uses to ensure idempotent creation.

Required: No

Type: String

Pattern: ^(.+)$

Minimum: 1

Maximum: 64

Update requires: Replacement

KmsKeyId

The ID of the AWS KMS key used to encrypt the file system.

Required: No

Type: String

Pattern: ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|mrk-[0-9a-f]{32}|alias/[a-zA-Z0-9/_-]+|(arn:aws[-a-z]*:kms:[a-z0-9-]+:\d{12}:((key/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(key/mrk-[0-9a-f]{32})|(alias/[a-zA-Z0-9/_-]+))))$

Maximum: 2048

Update requires: Replacement

Prefix

The S3 key prefix that scopes the file system. When specified, the file system provides access only to objects under this prefix in the bucket.

Required: No

Type: String

Pattern: ^(|.*/)$

Maximum: 1024

Update requires: Replacement

RoleArn

The Amazon Resource Name (ARN) of the IAM role used for S3 access.

Required: Yes

Type: String

Pattern: ^arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$

Maximum: 2048

Update requires: Replacement

SynchronizationConfiguration

The synchronization configuration for the file system, including import data rules and expiration data rules that control how data is synchronized between S3 and the file system.

Required: No

Type: SynchronizationConfiguration

Update requires: No interruption

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Name (ARN) of the file system.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreationTime

The time when the file system was created.

FileSystemArn

The Amazon Resource Name (ARN) of the file system.

FileSystemId

The ID of the file system.

OwnerId

The AWS account ID of the file system owner.

Status

The current status of the file system.

StatusMessage

Additional information about the file system status.

SynchronizationConfiguration.LatestVersionNumber

The latest version number of the synchronization configuration.