AWS::S3Tables::TableBucketPolicy - 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::S3Tables::TableBucketPolicy

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

Permissions

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

Amazon Cloud Development Kit (Amazon CDK)

To use S3 Tables Amazon 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 Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::S3Tables::TableBucketPolicy",
  "Properties" : {
      "ResourcePolicy" : Json,
      "TableBucketARN" : String
    }
}

YAML

Type: AWS::S3Tables::TableBucketPolicy
Properties:
  ResourcePolicy: Json
  TableBucketARN: String

Properties

ResourcePolicy

The bucket policy JSON for the table bucket.

Required: Yes

Type: Json

Update requires: No interruption

TableBucketARN

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

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})

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 bucket policy.

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