interface S3DestinationConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.KinesisFirehose.CfnDeliveryStream.S3DestinationConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskinesisfirehose#CfnDeliveryStream_S3DestinationConfigurationProperty`
Java	`software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.S3DestinationConfigurationProperty`
Python	`aws_cdk.aws_kinesisfirehose.CfnDeliveryStream.S3DestinationConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_kinesisfirehose` » `CfnDeliveryStream` » `S3DestinationConfigurationProperty`

The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesisfirehose as kinesisfirehose } from 'aws-cdk-lib';
const s3DestinationConfigurationProperty: kinesisfirehose.CfnDeliveryStream.S3DestinationConfigurationProperty = {
  bucketArn: 'bucketArn',
  roleArn: 'roleArn',

  // the properties below are optional
  bufferingHints: {
    intervalInSeconds: 123,
    sizeInMBs: 123,
  },
  cloudWatchLoggingOptions: {
    enabled: false,
    logGroupName: 'logGroupName',
    logStreamName: 'logStreamName',
  },
  compressionFormat: 'compressionFormat',
  encryptionConfiguration: {
    kmsEncryptionConfig: {
      awskmsKeyArn: 'awskmsKeyArn',
    },
    noEncryptionConfig: 'noEncryptionConfig',
  },
  errorOutputPrefix: 'errorOutputPrefix',
  prefix: 'prefix',
};

Properties

Name	Type	Description
bucketArn	`string`	The Amazon Resource Name (ARN) of the Amazon S3 bucket to send data to.
roleArn	`string`	The ARN of an AWS Identity and Access Management (IAM) role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS (if you enable data encryption).
bufferingHints?	`IResolvable` `\|` `BufferingHintsProperty`	Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon S3 bucket.
cloudWatchLoggingOptions?	`IResolvable` `\|` `CloudWatchLoggingOptionsProperty`	The CloudWatch logging options for your Firehose stream.
compressionFormat?	`string`	The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket.
encryptionConfiguration?	`IResolvable` `\|` `EncryptionConfigurationProperty`	Configures Amazon Simple Storage Service (Amazon S3) server-side encryption.
errorOutputPrefix?	`string`	A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.
prefix?	`string`	A prefix that Kinesis Data Firehose adds to the files that it delivers to the Amazon S3 bucket.

bucketArn

Type: string

The Amazon Resource Name (ARN) of the Amazon S3 bucket to send data to.

roleArn

Type: string

The ARN of an AWS Identity and Access Management (IAM) role that grants Kinesis Data Firehose access to your Amazon S3 bucket and AWS KMS (if you enable data encryption).

For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide .

bufferingHints?

Type: IResolvable | BufferingHintsProperty (optional)

Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon S3 bucket.

cloudWatchLoggingOptions?

Type: IResolvable | CloudWatchLoggingOptionsProperty (optional)

The CloudWatch logging options for your Firehose stream.

compressionFormat?

Type: string (optional)

The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket.

For valid values, see the CompressionFormat content for the S3DestinationConfiguration data type in the Amazon Kinesis Data Firehose API Reference .

encryptionConfiguration?

Type: IResolvable | EncryptionConfigurationProperty (optional)

Configures Amazon Simple Storage Service (Amazon S3) server-side encryption.

Kinesis Data Firehose uses AWS Key Management Service ( AWS KMS) to encrypt the data that it delivers to your Amazon S3 bucket.

errorOutputPrefix?

Type: string (optional)

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3.

This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects .

prefix?

Type: string (optional)

A prefix that Kinesis Data Firehose adds to the files that it delivers to the Amazon S3 bucket.

The prefix helps you identify the files that Kinesis Data Firehose delivered.