interface S3BucketProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.KinesisFirehose.Destinations.Alpha.S3BucketProps |
Go | github.com/aws/aws-cdk-go/awscdkkinesisfirehosedestinationsalpha/v2#S3BucketProps |
Java | software.amazon.awscdk.services.kinesisfirehose.destinations.alpha.S3BucketProps |
Python | aws_cdk.aws_kinesisfirehose_destinations_alpha.S3BucketProps |
TypeScript (source) | @aws-cdk/aws-kinesisfirehose-destinations-alpha ยป S3BucketProps |
Props for defining an S3 destination of a Kinesis 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 destinations.S3Bucket(bucket, {
processor: lambdaProcessor,
});
new firehose.DeliveryStream(this, 'Delivery Stream', {
destinations: [s3Destination],
});
Properties
Name | Type | Description |
---|---|---|
buffering | Duration | The length of time that Firehose buffers incoming data before delivering it to the S3 bucket. |
buffering | Size | The size of the buffer that Kinesis Data Firehose uses for incoming data before delivering it to the S3 bucket. |
compression? | Compression | The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket. |
data | string | A prefix that Kinesis Data Firehose evaluates and adds to records before writing them to S3. |
encryption | IKey | The AWS KMS key used to encrypt the data that it delivers to your Amazon S3 bucket. |
error | string | A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. |
log | ILog | The CloudWatch log group where log streams will be created to hold error logs. |
logging? | boolean | If true, log errors when data transformation or data delivery fails. |
processor? | IData | The data transformation that should be performed on the data before writing to the destination. |
role? | IRole | The IAM role associated with this destination. |
s3 | Destination | The 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 Kinesis 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 Kinesis 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 Kinesis 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 Kinesis 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
logGroup?
Type:
ILog
(optional, default: if logging
is set to true
, a log group will be created for you.)
The CloudWatch log group where log streams will be created to hold error logs.
logging?
Type:
boolean
(optional, default: true - errors are logged.)
If true, log errors when data transformation or data delivery fails.
If logGroup
is provided, this will be implicitly set to true
.
processor?
Type:
IData
(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 Kinesis Data Firehose to invoke processors and write to destinations
s3Backup?
Type:
Destination
(optional, default: source records will not be backed up to S3.)
The configuration for backing up source records to S3.