Package software.amazon.awscdk.services.kinesis

Interface CfnChannel.S3TablesDestinationConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannel.S3TablesDestinationConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnChannel

@Stability(Stable)
public static interface CfnChannel.S3TablesDestinationConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Configuration for delivery to S3 Tables destinations.

Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified on the channel.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kinesis.*;
 S3TablesDestinationConfigurationProperty s3TablesDestinationConfigurationProperty = S3TablesDestinationConfigurationProperty.builder()
         .deadLetterQueueS3Configuration(DeadLetterQueueS3ConfigurationProperty.builder()
                 .bucketArn("bucketArn")
                 .expectedBucketOwner("expectedBucketOwner")
                 // the properties below are optional
                 .errorOutputPrefix("errorOutputPrefix")
                 .build())
         .s3TablesConfigurationList(List.of(S3TableConfigurationProperty.builder()
                 .compressionType("compressionType")
                 .namespace("namespace")
                 .tableBucketArn("tableBucketArn")
                 .tableName("tableName")
                 // the properties below are optional
                 .partitionSpec(PartitionSpecProperty.builder()
                         .partitionFields(List.of(PartitionFieldProperty.builder()
                                 .sourceName("sourceName")
                                 .transform("transform")
                                 .build()))
                         .build())
                 .build()))
         // the properties below are optional
         .dataFreshnessInSeconds(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnChannel.S3TablesDestinationConfigurationProperty.Builder	builder()
default Number	getDataFreshnessInSeconds()	The maximum time in seconds the channel buffers records before delivery if the minimum target file size is not reached.
Object	getDeadLetterQueueS3Configuration()	Configuration of the S3 bucket used to capture records that cannot be delivered to the primary destination.
Object	getS3TablesConfigurationList()	The list of S3 Tables destinations.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeadLetterQueueS3Configuration

@Stability(Stable)
@NotNull
Object getDeadLetterQueueS3Configuration()

Configuration of the S3 bucket used to capture records that cannot be delivered to the primary destination.

Returns union: either IResolvable or CfnChannel.DeadLetterQueueS3ConfigurationProperty

See Also:

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

getS3TablesConfigurationList

@Stability(Stable)
@NotNull
Object getS3TablesConfigurationList()

The list of S3 Tables destinations.

v1 supports a single element; the list shape allows future extensibility to fan out to multiple tables.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnChannel.S3TableConfigurationProperty>

See Also:

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

getDataFreshnessInSeconds

@Stability(Stable)
@Nullable
default Number getDataFreshnessInSeconds()

The maximum time in seconds the channel buffers records before delivery if the minimum target file size is not reached.

Default: - 300

See Also:

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

builder

@Stability(Stable)
static CfnChannel.S3TablesDestinationConfigurationProperty.Builder builder()

Returns:

a CfnChannel.S3TablesDestinationConfigurationProperty.Builder of CfnChannel.S3TablesDestinationConfigurationProperty