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',
  },
  withoutMetadata: 'withoutMetadata',
};

Properties

Name	Type	Description
namespace	string	The name of the namespace.
openTableFormat	string	Format of the table.
tableBucketArn	string	The Amazon Resource Name (ARN) of the specified table bucket.
tableName	string	The name for the table.
compaction?	IResolvable | CompactionProperty	Settings governing the Compaction maintenance action.
icebergMetadata?	IResolvable | IcebergMetadataProperty	Contains details about the metadata for an Iceberg table.
snapshotManagement?	IResolvable | SnapshotManagementProperty	Contains details about the snapshot management settings for an Iceberg 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

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 specified table bucket.

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)

Settings governing the Compaction maintenance action.

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 snapshot management settings for an Iceberg table.

A snapshot is expired when it exceeds MinSnapshotsToKeep and MaxSnapshotAgeHours.

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

---

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