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. |
| open | string | The format of the table. |
| table | string | The Amazon Resource Name (ARN) of the table bucket to create the table in. |
| table | string | The name for the table. |
| compaction? | IResolvable | Compaction | Contains details about the compaction settings for an Iceberg table. |
| iceberg | IResolvable | Iceberg | Contains details about the metadata for an Iceberg table. |
| snapshot | IResolvable | Snapshot | Contains details about the Iceberg snapshot management settings for the table. |
| storage | IResolvable | Storage | Specifies storage class settings for the table. |
| tags? | Cfn[] | User tags (key-value pairs) to associate with the table. |
| without | string | Indicates that you don't want to specify a schema for the table. |
namespace
Type:
string
The name of the namespace.
openTableFormat
Type:
string
The format of the table.
tableBucketArn
Type:
string
The Amazon Resource Name (ARN) of the table bucket to create the table in.
tableName
Type:
string
The name for the table.
compaction?
Type:
IResolvable | Compaction
(optional)
Contains details about the compaction settings for an Iceberg table.
icebergMetadata?
Type:
IResolvable | Iceberg
(optional)
Contains details about the metadata for an Iceberg table.
snapshotManagement?
Type:
IResolvable | Snapshot
(optional)
Contains details about the Iceberg snapshot management settings for the table.
storageClassConfiguration?
Type:
IResolvable | Storage
(optional)
Specifies storage class settings for the table.
tags?
Type:
Cfn[]
(optional)
User tags (key-value pairs) to associate with the table.
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 .

.NET
Go
Java
Python
TypeScript