2.227.0

class Namespace (construct) 🔹

LanguageType name
.NETAmazon.CDK.AWS.S3Tables.Alpha.Namespace
Javasoftware.amazon.awscdk.services.s3tables.alpha.Namespace
Pythonaws_cdk.aws_s3tables_alpha.Namespace
TypeScript (source)@aws-cdk/aws-s3tables-alpha » Namespace

Implements IConstruct, IDependable, IResource, IEnvironmentAware, INamespace

An S3 Tables Namespace with helpers.

A namespace is a logical container for tables within a table bucket.

Example

// Build a namespace
const sampleNamespace = new Namespace(scope, 'ExampleNamespace', {
    namespaceName: 'example-namespace-1',
    tableBucket: tableBucket,
});

Initializer

new Namespace(scope: Construct, id: string, props: NamespaceProps)

Parameters

Construct Props

NameTypeDescription
namespaceName🔹stringA name for the namespace.
tableBucket🔹ITableBucketThe table bucket this namespace belongs to.
removalPolicy?🔹RemovalPolicyPolicy to apply when the policy is removed from this stack.

namespaceName🔹

Type: string

A name for the namespace.

tableBucket🔹

Type: ITableBucket

The table bucket this namespace belongs to.

removalPolicy?🔹

Type: RemovalPolicy (optional, default: RemovalPolicy.DESTROY)

Policy to apply when the policy is removed from this stack.

Properties

NameTypeDescription
env🔹ResourceEnvironmentThe environment this resource belongs to.
namespaceName🔹stringThe name of this namespace.
node🔹NodeThe tree node.
stack🔹StackThe stack in which this resource is defined.
tableBucket🔹ITableBucketThe table bucket which this namespace belongs to.
static PROPERTY_INJECTION_ID🔹stringUniquely identifies this class.

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

namespaceName🔹

Type: string

The name of this namespace.

node🔹

Type: Node

The tree node.

stack🔹

Type: Stack

The stack in which this resource is defined.

tableBucket🔹

Type: ITableBucket

The table bucket which this namespace belongs to.

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

NameDescription
applyRemovalPolicy(policy)🔹Apply the given removal policy to this resource.
toString()🔹Returns a string representation of this construct.
static fromNamespaceAttributes(scope, id, attrs)🔹Import an existing namespace from its attributes.
static validateNamespaceName(namespaceName)🔹See https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-naming.html.

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

toString()🔹

public toString(): string

Returns

  • string

Returns a string representation of this construct.

static fromNamespaceAttributes(scope, id, attrs)🔹

public static fromNamespaceAttributes(scope: Construct, id: string, attrs: NamespaceAttributes): INamespace

Parameters

Returns

Import an existing namespace from its attributes.

static validateNamespaceName(namespaceName)🔹

public static validateNamespaceName(namespaceName: string): void

Parameters

  • namespaceName string — Name of the namespace.

See https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-naming.html.

← PreviousNext →