Package software.amazon.awscdk.services.s3tables

Class CfnNamespace

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.s3tables.CfnNamespace
All Implemented Interfaces:
IInspectable, IEnvironmentAware, INamespaceRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T10:47:29.078Z") @Stability(Stable) public class CfnNamespace extends CfnResource implements IInspectable, INamespaceRef
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.
  • Cloud Development Kit - To use S3 Tables AWS CDK constructs, add the @aws-cdk/aws-s3tables-alpha dependency with one of the following options:
  • NPM: `npm i

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3tables.*;
 CfnNamespace cfnNamespace = CfnNamespace.Builder.create(this, "MyCfnNamespace")
         .namespace("namespace")
         .tableBucketArn("tableBucketArn")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnNamespace

      protected CfnNamespace(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnNamespace

      protected CfnNamespace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnNamespace

      @Stability(Stable) public CfnNamespace(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnNamespaceProps props)
      Create a new AWS::S3Tables::Namespace.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnNamespace

      @Stability(Stable) @NotNull public static Boolean isCfnNamespace(@NotNull Object x)
      Checks whether the given object is a CfnNamespace.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getNamespaceRef

      @Stability(Stable) @NotNull public NamespaceReference getNamespaceRef()
      A reference to a Namespace resource.
      Specified by:
      getNamespaceRef in interface INamespaceRef

    • getNamespace

      @Stability(Stable) @NotNull public String getNamespace()
      The name of the namespace.

    • setNamespace

      @Stability(Stable) public void setNamespace(@NotNull String value)
      The name of the namespace.

    • getTableBucketArn

      @Stability(Stable) @NotNull public String getTableBucketArn()
      The Amazon Resource Name (ARN) of the table bucket to create the namespace in.

    • setTableBucketArn

      @Stability(Stable) public void setTableBucketArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the table bucket to create the namespace in.