AWS::S3Tables::TablePolicy - AWS CloudFormation
SyntaxPropertiesReturn values

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

AWS::S3Tables::TablePolicy

Creates a new maintenance configuration or replaces an existing table policy for a table. For more information, see Adding a table policy in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:PutTablePolicy permission to use this operation.

AWS Cloud Development Kit (AWS CDK)

To use S3 Tables AWS CDK constructs, add the @aws-cdk/aws-s3tables-alpha dependency with one of the following options:

  • NPM: npm i @aws-cdk/aws-s3tables-alpha

  • Yarn:yarn add @aws-cdk/aws-s3tables-alpha

Syntax

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

JSON

{
  "Type" : "AWS::S3Tables::TablePolicy",
  "Properties" : {
      "ResourcePolicy" : Json,
      "TableARN" : String
    }
}

YAML

Type: AWS::S3Tables::TablePolicy
Properties:
  ResourcePolicy: Json
  TableARN: String

Properties

ResourcePolicy

The JSON that defines the policy.

Required: Yes

Type: Json

Minimum: 1

Maximum: 20480

Update requires: No interruption

TableARN

The Amazon Resource Name (ARN) of the table.

Required: Yes

Type: String

Pattern: (arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63}/table/[a-zA-Z0-9-_]{1,255})

Minimum: 1

Maximum: 2048

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns some information about your table policy.

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.

Namespace

The namespace to associated with the table.

TableBucketARN

The Amazon Resource Name (ARN) of the table bucket that contains the table.

TableName

The name of the table.