2.185.0

interface S3BucketProps

LanguageType name
.NETAmazon.CDK.AWS.KinesisFirehose.S3BucketProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskinesisfirehose#S3BucketProps
Javasoftware.amazon.awscdk.services.kinesisfirehose.S3BucketProps
Pythonaws_cdk.aws_kinesisfirehose.S3BucketProps
TypeScript (source)aws-cdk-lib » aws_kinesisfirehose » S3BucketProps

Props for defining an S3 destination of an Amazon Data Firehose delivery stream.

Example

// Provide a Lambda function that will transform records before delivery, with custom
// buffering and retry configuration
const lambdaFunction = new lambda.Function(this, 'Processor', {
  runtime: lambda.Runtime.NODEJS_LATEST,
  handler: 'index.handler',
  code: lambda.Code.fromAsset(path.join(__dirname, 'process-records')),
});
const lambdaProcessor = new firehose.LambdaFunctionProcessor(lambdaFunction, {
  bufferInterval: Duration.minutes(5),
  bufferSize: Size.mebibytes(5),
  retries: 5,
});
declare const bucket: s3.Bucket;
const s3Destination = new firehose.S3Bucket(bucket, {
  processor: lambdaProcessor,
});
new firehose.DeliveryStream(this, 'Delivery Stream', {
  destination: s3Destination,
});

Properties

NameTypeDescription
bufferingInterval?DurationThe length of time that Firehose buffers incoming data before delivering it to the S3 bucket.
bufferingSize?SizeThe size of the buffer that Amazon Data Firehose uses for incoming data before delivering it to the S3 bucket.
compression?CompressionThe type of compression that Amazon Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket.
dataOutputPrefix?stringA prefix that Amazon Data Firehose evaluates and adds to records before writing them to S3.
encryptionKey?IKeyThe AWS KMS key used to encrypt the data that it delivers to your Amazon S3 bucket.
errorOutputPrefix?stringA prefix that Amazon Data Firehose evaluates and adds to failed records before writing them to S3.
loggingConfig?ILoggingConfigConfiguration that determines whether to log errors during data transformation or delivery failures, and specifies the CloudWatch log group for storing error logs.
processor?IDataProcessorThe data transformation that should be performed on the data before writing to the destination.
role?IRoleThe IAM role associated with this destination.
s3Backup?DestinationS3BackupPropsThe configuration for backing up source records to S3.

bufferingInterval?

Type: Duration (optional, default: Duration.seconds(300))

The length of time that Firehose buffers incoming data before delivering it to the S3 bucket.

Minimum: Duration.seconds(0) Maximum: Duration.seconds(900)

bufferingSize?

Type: Size (optional, default: Size.mebibytes(5))

The size of the buffer that Amazon Data Firehose uses for incoming data before delivering it to the S3 bucket.

Minimum: Size.mebibytes(1) Maximum: Size.mebibytes(128)

compression?

Type: Compression (optional, default: UNCOMPRESSED)

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

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

dataOutputPrefix?

Type: string (optional, default: "YYYY/MM/DD/HH")

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

This prefix appears immediately following the bucket name.

See also: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html

encryptionKey?

Type: IKey (optional, default: Data is not encrypted.)

The AWS KMS key used to encrypt the data that it delivers to your Amazon S3 bucket.

errorOutputPrefix?

Type: string (optional, default: "YYYY/MM/DD/HH")

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

This prefix appears immediately following the bucket name.

See also: https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html

loggingConfig?

Type: ILoggingConfig (optional, default: errors will be logged and a log group will be created for you.)

Configuration that determines whether to log errors during data transformation or delivery failures, and specifies the CloudWatch log group for storing error logs.

processor?

Type: IDataProcessor (optional, default: no data transformation will occur.)

The data transformation that should be performed on the data before writing to the destination.

role?

Type: IRole (optional, default: a role will be created with default permissions.)

The IAM role associated with this destination.

Assumed by Amazon Data Firehose to invoke processors and write to destinations

s3Backup?

Type: DestinationS3BackupProps (optional, default: source records will not be backed up to S3.)

The configuration for backing up source records to S3.

← PreviousNext →