Class CfnTable
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.CfnTable
- All Implemented Interfaces:
IInspectable
,ITableRef
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
date="2025-10-14T12:28:19.784Z")
@Stability(Stable)
public class CfnTable
extends CfnResource
implements IInspectable, ITableRef
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 thes3tables:PutTableData
permission. - If you use this operation with the optional
encryptionConfiguration
request parameter you must have thes3tables:PutTableEncryption
permission.
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 .
- 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.*; CfnTable cfnTable = CfnTable.Builder.create(this, "MyCfnTable") .namespace("namespace") .openTableFormat("openTableFormat") .tableBucketArn("tableBucketArn") .tableName("tableName") // the properties below are optional .compaction(CompactionProperty.builder() .status("status") .targetFileSizeMb(123) .build()) .icebergMetadata(IcebergMetadataProperty.builder() .icebergSchema(IcebergSchemaProperty.builder() .schemaFieldList(List.of(SchemaFieldProperty.builder() .name("name") .type("type") // the properties below are optional .required(false) .build())) .build()) .build()) .snapshotManagement(SnapshotManagementProperty.builder() .maxSnapshotAgeHours(123) .minSnapshotsToKeep(123) .status("status") .build()) .withoutMetadata("withoutMetadata") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnTable
.static interface
Contains details about the compaction settings for an Iceberg table.static interface
Contains details about the metadata for an Iceberg table.static interface
Contains details about the schema for an Iceberg table.static interface
Contains details about a schema field.static interface
Contains details about the snapshot management settings for an Iceberg table.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.s3tables.ITableRef
ITableRef.Jsii$Default, ITableRef.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnTable
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnTable
(software.amazon.jsii.JsiiObjectRef objRef) CfnTable
(software.constructs.Construct scope, String id, CfnTableProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the table.The version token of the table.The warehouse location of the table.Contains details about the compaction settings for an Iceberg table.Contains details about the metadata for an Iceberg table.The name of the namespace.The format of the table.Contains details about the Iceberg snapshot management settings for the table.The Amazon Resource Name (ARN) of the table bucket to create the table in.The name for the table.A reference to a Table resource.Indicates that you don't want to specify a schema for the table.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setCompaction
(IResolvable value) Contains details about the compaction settings for an Iceberg table.void
Contains details about the compaction settings for an Iceberg table.void
setIcebergMetadata
(IResolvable value) Contains details about the metadata for an Iceberg table.void
Contains details about the metadata for an Iceberg table.void
setNamespace
(String value) The name of the namespace.void
setOpenTableFormat
(String value) The format of the table.void
setSnapshotManagement
(IResolvable value) Contains details about the Iceberg snapshot management settings for the table.void
Contains details about the Iceberg snapshot management settings for the table.void
setTableBucketArn
(String value) The Amazon Resource Name (ARN) of the table bucket to create the table in.void
setTableName
(String value) The name for the table.void
setWithoutMetadata
(String value) Indicates that you don't want to specify a schema for the table.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnTable
protected CfnTable(software.amazon.jsii.JsiiObjectRef objRef) -
CfnTable
protected CfnTable(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnTable
@Stability(Stable) public CfnTable(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTableProps props) - 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
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrTableArn
The Amazon Resource Name (ARN) of the table. -
getAttrVersionToken
The version token of the table. -
getAttrWarehouseLocation
The warehouse location of the table. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTableRef
A reference to a Table resource.- Specified by:
getTableRef
in interfaceITableRef
-
getNamespace
The name of the namespace. -
setNamespace
The name of the namespace. -
getOpenTableFormat
The format of the table. -
setOpenTableFormat
The format of the table. -
getTableBucketArn
The Amazon Resource Name (ARN) of the table bucket to create the table in. -
setTableBucketArn
The Amazon Resource Name (ARN) of the table bucket to create the table in. -
getTableName
The name for the table. -
setTableName
The name for the table. -
getCompaction
Contains details about the compaction settings for an Iceberg table. -
setCompaction
Contains details about the compaction settings for an Iceberg table. -
setCompaction
Contains details about the compaction settings for an Iceberg table. -
getIcebergMetadata
Contains details about the metadata for an Iceberg table. -
setIcebergMetadata
Contains details about the metadata for an Iceberg table. -
setIcebergMetadata
Contains details about the metadata for an Iceberg table. -
getSnapshotManagement
Contains details about the Iceberg snapshot management settings for the table. -
setSnapshotManagement
Contains details about the Iceberg snapshot management settings for the table. -
setSnapshotManagement
@Stability(Stable) public void setSnapshotManagement(@Nullable CfnTable.SnapshotManagementProperty value) Contains details about the Iceberg snapshot management settings for the table. -
getWithoutMetadata
Indicates that you don't want to specify a schema for the table. -
setWithoutMetadata
Indicates that you don't want to specify a schema for the table.
-