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

Creates a new table associated with the given namespace in a table bucket. For more information, see Creating an Amazon S3 table in the Amazon Simple Storage Service User Guide.

Permissions

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

  • If you use this operation with the optional metadata request parameter you must have the s3tables:PutTableData permission.

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

Note

Additionally, If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.

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::Table",
  "Properties" : {
      "Compaction" : Compaction,
      "IcebergMetadata" : IcebergMetadata,
      "Namespace" : String,
      "OpenTableFormat" : String,
      "SnapshotManagement" : SnapshotManagement,
      "TableBucketARN" : String,
      "TableName" : String,
      "WithoutMetadata" : String
    }
}

Properties

Compaction

Contains details about the compaction settings for an Iceberg table.

Required: No

Type: Compaction

Update requires: No interruption

IcebergMetadata

Contains details about the metadata for an Iceberg table.

Required: No

Type: IcebergMetadata

Update requires: Replacement

Namespace

The name of the namespace.

Required: Yes

Type: String

Update requires: No interruption

OpenTableFormat

The format of the table.

Required: Yes

Type: String

Allowed values: ICEBERG

Update requires: Replacement

SnapshotManagement

Contains details about the Iceberg snapshot management settings for the table.

Required: No

Type: SnapshotManagement

Update requires: No interruption

TableBucketARN

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

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

TableName

The name for the table.

Required: Yes

Type: String

Pattern: [0-9a-z_]*

Minimum: 1

Maximum: 255

Update requires: No interruption

WithoutMetadata

Indicates that you don't want to specify a schema for the table. This property is mutually exclusive to IcebergMetadata, and its only possible value is Yes.

Required: No

Type: String

Allowed values: Yes

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the table 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.

TableARN

The Amazon Resource Name (ARN) of the table.

VersionToken

The version token of the table.

WarehouseLocation

The warehouse location of the table.