Package software.amazon.awscdk.cfnpropertymixins.services.kinesis

Interface CfnChannelPropsMixin.S3TableConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannelPropsMixin.S3TableConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnChannelPropsMixin

@Stability(Stable)
public static interface CfnChannelPropsMixin.S3TableConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.kinesis.*;
 S3TableConfigurationProperty s3TableConfigurationProperty = S3TableConfigurationProperty.builder()
         .compressionType("compressionType")
         .namespace("namespace")
         .partitionSpec(PartitionSpecProperty.builder()
                 .partitionFields(List.of(PartitionFieldProperty.builder()
                         .sourceName("sourceName")
                         .transform("transform")
                         .build()))
                 .build())
         .tableBucketArn("tableBucketArn")
         .tableName("tableName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3tableconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnChannelPropsMixin.S3TableConfigurationProperty.Builder	A builder for CfnChannelPropsMixin.S3TableConfigurationProperty
static final class	CfnChannelPropsMixin.S3TableConfigurationProperty.Jsii$Proxy	An implementation for CfnChannelPropsMixin.S3TableConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnChannelPropsMixin.S3TableConfigurationProperty.Builder	builder()
default String	getCompressionType()	The compression algorithm applied to objects delivered to the S3 Tables destination.
default String	getNamespace()	The name of the S3 Tables namespace that contains the destination table.
default Object	getPartitionSpec()	Partitioning specification for the destination Iceberg table.
default String	getTableBucketArn()	The ARN of the S3 Tables table bucket for record delivery.
default String	getTableName()	The name of the destination S3 Tables table.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCompressionType

@Stability(Stable)
@Nullable
default String getCompressionType()

The compression algorithm applied to objects delivered to the S3 Tables destination.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3tableconfiguration.html#cfn-kinesis-channel-s3tableconfiguration-compressiontype

getNamespace

@Stability(Stable)
@Nullable
default String getNamespace()

The name of the S3 Tables namespace that contains the destination table.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3tableconfiguration.html#cfn-kinesis-channel-s3tableconfiguration-namespace

getPartitionSpec

@Stability(Stable)
@Nullable
default Object getPartitionSpec()

Partitioning specification for the destination Iceberg table.

Follows the S3 Tables / Iceberg PartitionSpec format.

Returns union: either IResolvable or CfnChannelPropsMixin.PartitionSpecProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3tableconfiguration.html#cfn-kinesis-channel-s3tableconfiguration-partitionspec

getTableBucketArn

@Stability(Stable)
@Nullable
default String getTableBucketArn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3tableconfiguration.html#cfn-kinesis-channel-s3tableconfiguration-tablebucketarn

getTableName

@Stability(Stable)
@Nullable
default String getTableName()

The name of the destination S3 Tables table.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-s3tableconfiguration.html#cfn-kinesis-channel-s3tableconfiguration-tablename

builder

@Stability(Stable)
static CfnChannelPropsMixin.S3TableConfigurationProperty.Builder builder()

Returns:

a CfnChannelPropsMixin.S3TableConfigurationProperty.Builder of CfnChannelPropsMixin.S3TableConfigurationProperty