AWS CDK Reference

Appearance

v2.276.0

Experimental

@aws-cdk/aws-s3tables-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

Namespace L2 construct ​

An S3 Tables Namespace with helpers.

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

Stability
Experimental
Source
lib/namespace.ts

Example ​

ts
// Build a namespace
const sampleNamespace = new Namespace(scope, 'ExampleNamespace', {
    namespaceName: 'example-namespace-1',
    tableBucket: tableBucket,
});
python
# Build a namespace
sample_namespace = Namespace(scope, "ExampleNamespace",
    namespace_name="example-namespace-1",
    table_bucket=table_bucket
)
java
// Build a namespace
Namespace sampleNamespace = Namespace.Builder.create(scope, "ExampleNamespace")
        .namespaceName("example-namespace-1")
        .tableBucket(tableBucket)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.S3Tables.Alpha
// Build a namespace
var sampleNamespace = new Namespace(scope, "ExampleNamespace", new NamespaceProps {
    NamespaceName = "example-namespace-1",
    TableBucket = tableBucket
});
go
// Build a namespace
sampleNamespace := awscdkawss3tablesalpha.NewNamespace(*scope, jsii.String("ExampleNamespace"), &NamespaceProps{
	NamespaceName: jsii.String("example-namespace-1"),
	TableBucket: tableBucket,
})

Initializer ​

ts
new Namespace(scope: Construct, id: string, props: NamespaceProps)
python
Namespace(scope: Construct, id: str, props: NamespaceProps)
java
new Namespace(Construct scope, String id, NamespaceProps props)
csharp
new Namespace(Construct scope, string id, NamespaceProps props)
go
NewNamespace(Scope Construct, Id *string, Props NamespaceProps)

Construct Props ​

namespaceNamestringnamespace_namestrnamespaceNameStringNamespaceNamestringNamespaceName*stringrequired#
A name for the namespace.
removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.DESTROY#
Policy to apply when the policy is removed from this stack.
tableBucketITableBuckettable_bucketITableBuckettableBucketITableBucketTableBucketITableBucketTableBucketITableBucketrequired#
The table bucket this namespace belongs to.

Properties ​

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#
The environment this resource belongs to.
notes

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.

namespaceNamestringnamespace_namestrnamespaceNameStringNamespaceNamestringNamespaceName*string#
The name of this namespace.
nodeNodenodeNodenodeNodeNodeNodeNodeNode#
The tree node.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#
Uniquely identifies this class.
stackStackstackStackstackStackStackStackStackStack#
The stack in which this resource is defined.
tableBucketITableBuckettable_bucketITableBuckettableBucketITableBucketTableBucketITableBucketTableBucketITableBucket#
The table bucket which this namespace belongs to.

Methods ​

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#
Override the cross-stack reference strength for this resource.
notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

  • strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

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).

fromNamespaceAttributes(scope: Construct, id: string, attrs: NamespaceAttributes): INamespace@staticmethod def from_namespace_attributes(scope: Construct, id: str, attrs: NamespaceAttributes) -> INamespacepublic static INamespace fromNamespaceAttributes(Construct scope, String id, NamespaceAttributes attrs)public static INamespace FromNamespaceAttributes(Construct scope, string id, NamespaceAttributes attrs)func FromNamespaceAttributes(Scope Construct, Id *string, Attrs NamespaceAttributes) INamespacestatic#
Import an existing namespace from its attributes.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#
Checks if `x` is a construct.
notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#
Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#
Check whether the given construct is a Resource.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#
Returns a string representation of this construct.
validateNamespaceName(namespaceName: string): void@staticmethod def validate_namespace_name(namespace_name: str) -> Nonepublic static void validateNamespaceName(String namespaceName)public static void ValidateNamespaceName(string namespaceName)func ValidateNamespaceName(NamespaceName *string)static#
See https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-naming.html.
1 parameter

Parameters

  • namespaceNamenamespace_namenamespaceNamenamespaceNameNamespaceName — Name of the namespace.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.