Package software.amazon.awscdk.services.kinesis

Interface CfnChannel.S3DestinationConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannel.S3DestinationConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnChannel

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

Configuration for delivery to a vanilla S3 bucket destination.

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.*;
 S3DestinationConfigurationProperty s3DestinationConfigurationProperty = S3DestinationConfigurationProperty.builder()
         .storageConfiguration(S3StorageConfigurationProperty.builder()
                 .bucketArn("bucketArn")
                 .compressionType("compressionType")
                 .expectedBucketOwner("expectedBucketOwner")
                 // the properties below are optional
                 .outputKeyTemplate("outputKeyTemplate")
                 .storageClass("storageClass")
                 .build())
         // the properties below are optional
         .dataFreshnessInSeconds(123)
         .deadLetterQueueS3Configuration(DeadLetterQueueS3ConfigurationProperty.builder()
                 .bucketArn("bucketArn")
                 .expectedBucketOwner("expectedBucketOwner")
                 // the properties below are optional
                 .errorOutputPrefix("errorOutputPrefix")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnChannel.S3DestinationConfigurationProperty.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.
default Object	getDeadLetterQueueS3Configuration()	Configuration of the S3 bucket used to capture records that cannot be delivered to the primary destination.
Object	getStorageConfiguration()	S3 storage configuration that describes the destination bucket and how delivered objects are stored.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStorageConfiguration

@Stability(Stable)
@NotNull
Object getStorageConfiguration()

S3 storage configuration that describes the destination bucket and how delivered objects are stored.

Returns union: either IResolvable or CfnChannel.S3StorageConfigurationProperty

See Also:

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

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-s3destinationconfiguration.html#cfn-kinesis-channel-s3destinationconfiguration-datafreshnessinseconds

getDeadLetterQueueS3Configuration

@Stability(Stable)
@Nullable
default 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-s3destinationconfiguration.html#cfn-kinesis-channel-s3destinationconfiguration-deadletterqueues3configuration

builder

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

Returns:

a CfnChannel.S3DestinationConfigurationProperty.Builder of CfnChannel.S3DestinationConfigurationProperty