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

Creates a namespace. A namespace is a logical grouping of tables within your table bucket, which you can use to organize tables. For more information, see Create a namespace in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:CreateNamespace 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::Namespace",
  "Properties" : {
      "Namespace" : String,
      "TableBucketARN" : String
    }
}

YAML

Type: AWS::S3Tables::Namespace
Properties:
  Namespace: String
  TableBucketARN: String

Properties

Namespace

The name of the namespace.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: Replacement

TableBucketARN

The Amazon Resource Name (ARN) of the table bucket to create the namespace 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

Return values

Ref

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

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