AWS::S3::Bucket MetadataTableConfiguration - AWS CloudFormation
SyntaxPropertiesExamples

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::S3::Bucket MetadataTableConfiguration

Important

We recommend that you create your S3 Metadata configurations by using the V2 MetadataConfiguration resource type. We no longer recommend using the V1 MetadataTableConfiguration resource type.

If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using the MetadataConfiguration resource type so that you can expire journal table records and create a live inventory table.

Creates a V1 S3 Metadata configuration for a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide.

Syntax

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

Properties

S3TablesDestination

The destination information for the metadata table configuration. The destination table bucket must be in the same Region and AWS account as the general purpose bucket. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket.

Required: Yes

Type: S3TablesDestination

Update requires: No interruption

Examples

Create metadata table configuration

The following example creates an S3 Metadata configuration for the specified general purpose bucket. To use this example, replace amzn-s3-demo-table-bucket with the name of the table bucket where you want to store your metadata table, replace amzn-s3-demo-bucket1 with the name of your general purpose bucket, and replace my_metadata_table_name with the name that you want to use for your metadata table.

JSON


{
  "Resources": {
    "S3TableBucket": {
      "Type": "AWS::S3Tables::TableBucket",
      "Properties": {
        "TableBucketName": "amzn-s3-demo-table-bucket"
      }
    },
    "S3Bucket": {
      "Type": "AWS::S3::Bucket",
      "DeletionPolicy": "Retain",
      "Properties": {
        "BucketName": "amzn-s3-demo-bucket1",
        "MetadataTableConfiguration": {
          "S3TablesDestination": {
            "TableBucketArn": {
              "Fn::GetAtt": [
                "S3TableBucket",
                "TableBucketARN"
              ]
            },
            "TableName": "my_metadata_table_name",
            "TableNamespace": "aws_s3_metadata"
          }
        }
      }
    }
  }
}

YAML


Resources:
  S3TableBucket:
    Type: AWS::S3Tables::TableBucket
    Properties:
      TableBucketName: amzn-s3-demo-table-bucket

  S3Bucket:
    Type: AWS::S3::Bucket
    DeletionPolicy: Retain
    Properties:
      BucketName: amzn-s3-demo-bucket1
      MetadataTableConfiguration: 
        S3TablesDestination: 
          TableBucketArn: !GetAtt S3TableBucket.TableBucketARN
          TableName: my_metadata_table_name
          TableNamespace: aws_s3_metadata