interface S3DestinationConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Kinesis.CfnChannel.S3DestinationConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskinesis#CfnChannel_S3DestinationConfigurationProperty`
Java	`software.amazon.awscdk.services.kinesis.CfnChannel.S3DestinationConfigurationProperty`
Python	`aws_cdk.aws_kinesis.CfnChannel.S3DestinationConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_kinesis` » `CfnChannel` » `S3DestinationConfigurationProperty`

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 { aws_kinesis as kinesis } from 'aws-cdk-lib';
const s3DestinationConfigurationProperty: kinesis.CfnChannel.S3DestinationConfigurationProperty = {
  storageConfiguration: {
    bucketArn: 'bucketArn',
    compressionType: 'compressionType',
    expectedBucketOwner: 'expectedBucketOwner',

    // the properties below are optional
    outputKeyTemplate: 'outputKeyTemplate',
    storageClass: 'storageClass',
  },

  // the properties below are optional
  dataFreshnessInSeconds: 123,
  deadLetterQueueS3Configuration: {
    bucketArn: 'bucketArn',
    expectedBucketOwner: 'expectedBucketOwner',

    // the properties below are optional
    errorOutputPrefix: 'errorOutputPrefix',
  },
};

Properties

Name	Type	Description
storageConfiguration	`IResolvable` `\|` `S3StorageConfigurationProperty`	S3 storage configuration that describes the destination bucket and how delivered objects are stored.
dataFreshnessInSeconds?	`number`	The maximum time in seconds the channel buffers records before delivery if the minimum target file size is not reached.
deadLetterQueueS3Configuration?	`IResolvable` `\|` `DeadLetterQueueS3ConfigurationProperty`	Configuration of the S3 bucket used to capture records that cannot be delivered to the primary destination.

storageConfiguration

Type: IResolvable | S3StorageConfigurationProperty

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

dataFreshnessInSeconds?

Type: number (optional, default: 300)

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

deadLetterQueueS3Configuration?

Type: IResolvable | DeadLetterQueueS3ConfigurationProperty (optional)

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

AWS CDK