View a markdown version of this page

AWS::S3Files::AccessPoint - 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::S3Files::AccessPoint

The AWS::S3Files::AccessPoint resource specifies an access point for an Amazon S3 Files file system. Access points provide application-specific access with POSIX user identity and root directory enforcement.

Syntax

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

JSON

{
  "Type" : "AWS::S3Files::AccessPoint",
  "Properties" : {
      "ClientToken" : String,
      "FileSystemId" : String,
      "PosixUser" : PosixUser,
      "RootDirectory" : RootDirectory,
      "Tags" : [ AccessPointTag, ... ]
    }
}

YAML

Type: AWS::S3Files::AccessPoint
Properties:
  ClientToken: String
  FileSystemId: String
  PosixUser: 
    PosixUser
  RootDirectory: 
    RootDirectory
  Tags: 
    - AccessPointTag

Properties

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

FileSystemId

The ID of the S3 Files file system that the access point provides access to.

Required: Yes

Type: String

Pattern: ^(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}|fs-[0-9a-f]{17,40})$

Maximum: 128

Update requires: Replacement

PosixUser

The POSIX identity configured for this access point.

Required: No

Type: PosixUser

Update requires: Replacement

RootDirectory

The root directory configuration for this access point.

Required: No

Type: RootDirectory

Update requires: Replacement

Tags

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

For more information, see Tag.

Required: No

Type: Array of AccessPointTag

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 access point ID.

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.

AccessPointArn

The Amazon Resource Name (ARN) of the access point.

AccessPointId

The ID of the access point.

OwnerId

The Amazon Web Services account ID of the access point owner.

Status

The current status of the access point.