Skip to content
v2.275.0

S3TableConfigurationProperty Struct ​

An S3 Tables destination including its table bucket, namespace, table name, and partition spec.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesis as kinesis } from 'aws-cdk-lib';
const s3TableConfigurationProperty: kinesis.CfnChannel.S3TableConfigurationProperty = {
  compressionType: 'compressionType',
  namespace: 'namespace',
  tableBucketArn: 'tableBucketArn',
  tableName: 'tableName',

  // the properties below are optional
  partitionSpec: {
    partitionFields: [{
      sourceName: 'sourceName',
      transform: 'transform',
    }],
  },
};

Properties ​

compressionTypestringcompression_typestrcompressionTypeStringCompressionTypestringCompressionType*stringrequired#
The compression algorithm applied to objects delivered to the S3 Tables destination.
namespacestringnamespacestrnamespaceStringNamespacestringNamespace*stringrequired#
The name of the S3 Tables namespace that contains the destination table.
partitionSpecoptionalIResolvable | CfnChannel.PartitionSpecPropertypartition_specoptionaltyping.Union[IResolvable, PartitionSpecProperty]partitionSpecoptionalIResolvablePartitionSpecoptionalIResolvablePartitionSpecoptionalinterface{}#
Partitioning specification for the destination Iceberg table.

Follows the S3 Tables / Iceberg PartitionSpec format.

tableBucketArnstringtable_bucket_arnstrtableBucketArnStringTableBucketArnstringTableBucketArn*stringrequired#
The ARN of the S3 Tables table bucket for record delivery.

Buckets can be cross-account but must be in the same region as the channel.

tableNamestringtable_namestrtableNameStringTableNamestringTableName*stringrequired#
The name of the destination S3 Tables table.

The table is created for the customer if it does not yet exist.