interface CfnTableProps

Language	Type name
.NET	Amazon.CDK.AWS.S3Tables.CfnTableProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awss3tables#CfnTableProps
Java	software.amazon.awscdk.services.s3tables.CfnTableProps
Python	aws_cdk.aws_s3tables.CfnTableProps
TypeScript	aws-cdk-lib » aws_s3tables » CfnTableProps

Properties for defining a CfnTable.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3tables as s3tables } from 'aws-cdk-lib';
const cfnTableProps: s3tables.CfnTableProps = {
  namespace: 'namespace',
  openTableFormat: 'openTableFormat',
  tableBucketArn: 'tableBucketArn',
  tableName: 'tableName',

  // the properties below are optional
  compaction: {
    status: 'status',
    targetFileSizeMb: 123,
  },
  icebergMetadata: {
    icebergSchema: {
      schemaFieldList: [{
        name: 'name',
        type: 'type',

        // the properties below are optional
        required: false,
      }],
    },
  },
  snapshotManagement: {
    maxSnapshotAgeHours: 123,
    minSnapshotsToKeep: 123,
    status: 'status',
  },
  storageClassConfiguration: {
    storageClass: 'storageClass',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  withoutMetadata: 'withoutMetadata',
};

Properties

Name	Type	Description
namespace	string	The name of the namespace.
openTableFormat	string	The format of the table.
tableBucketArn	string	The Amazon Resource Name (ARN) of the table bucket to create the table in.
tableName	string	The name for the table.
compaction?	IResolvable | CompactionProperty	Contains details about the compaction settings for an Iceberg table.
icebergMetadata?	IResolvable | IcebergMetadataProperty	Contains details about the metadata for an Iceberg table.
snapshotManagement?	IResolvable | SnapshotManagementProperty	Contains details about the Iceberg snapshot management settings for the table.
storageClassConfiguration?	IResolvable | StorageClassConfigurationProperty	The configuration details for the storage class of tables or table buckets.
tags?	CfnTag[]	User tags (key-value pairs) to associate with the table.
withoutMetadata?	string	Indicates that you don't want to specify a schema for the table.

---

namespace

Type: string

The name of the namespace.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-namespace

---

openTableFormat

Type: string

The format of the table.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-opentableformat

---

tableBucketArn

Type: string

The Amazon Resource Name (ARN) of the table bucket to create the table in.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-tablebucketarn

---

tableName

Type: string

The name for the table.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-tablename

---

compaction?

Type: IResolvable | CompactionProperty (optional)

Contains details about the compaction settings for an Iceberg table.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-compaction

---

icebergMetadata?

Type: IResolvable | IcebergMetadataProperty (optional)

Contains details about the metadata for an Iceberg table.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-icebergmetadata

---

snapshotManagement?

Type: IResolvable | SnapshotManagementProperty (optional)

Contains details about the Iceberg snapshot management settings for the table.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-snapshotmanagement

---

storageClassConfiguration?

Type: IResolvable | StorageClassConfigurationProperty (optional)

The configuration details for the storage class of tables or table buckets.

This allows you to optimize storage costs by selecting the appropriate storage class based on your access patterns and performance requirements.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-storageclassconfiguration

---

tags?

Type: CfnTag[] (optional)

User tags (key-value pairs) to associate with the table.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-tags

---

withoutMetadata?

Type: string (optional)

Indicates that you don't want to specify a schema for the table.

This property is mutually exclusive to IcebergMetadata , and its only possible value is Yes .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html#cfn-s3tables-table-withoutmetadata