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

Creates a table bucket. For more information, see Creating a table bucket in the Amazon Simple Storage Service User Guide.

Permissions

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

  • If you use this operation with the optional encryptionConfiguration parameter you must have the s3tables:PutTableBucketEncryption permission.

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::TableBucket",
  "Properties" : {
      "EncryptionConfiguration" : EncryptionConfiguration,
      "TableBucketName" : String,
      "UnreferencedFileRemoval" : UnreferencedFileRemoval
    }
}

Properties

EncryptionConfiguration

Configuration specifying how data should be encrypted. This structure defines the encryption algorithm and optional KMS key to be used for server-side encryption.

Required: No

Type: EncryptionConfiguration

Update requires: No interruption

TableBucketName

The name for the table bucket.

Required: Yes

Type: String

Minimum: 3

Maximum: 63

Update requires: Replacement

UnreferencedFileRemoval

The unreferenced file removal settings for your table bucket. Unreferenced file removal identifies and deletes all objects that are not referenced by any table snapshots. For more information, see the Amazon S3 User Guide.

Required: No

Type: UnreferencedFileRemoval

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the table bucket name.

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.

TableBucketARN

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