2.222.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

// Create service roles for the delivery stream and destination.
// These can be used for other purposes and granted access to different resources.
// They must include the Amazon Data Firehose service principal in their trust policies.
// Two separate roles are shown below, but the same role can be used for both purposes.
const deliveryStreamRole = new iam.Role(this, 'Delivery Stream Role', {
  assumedBy: new iam.ServicePrincipal('firehose.amazonaws.com'),
});
const destinationRole = new iam.Role(this, 'Destination Role', {
  assumedBy: new iam.ServicePrincipal('firehose.amazonaws.com'),
});

// Specify the roles created above when defining the destination and delivery stream.
declare const bucket: s3.Bucket;
const destination = new firehose.S3Bucket(bucket, { role: destinationRole });
new firehose.DeliveryStream(this, 'Delivery Stream', {
  destination: destination,
  role: deliveryStreamRole,
});

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.
dataFormatConversion?DataFormatConversionPropsThe input format, output format, and schema config for converting data from the JSON format to the Parquet or ORC format before writing to Amazon S3.
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.
fileExtension?stringSpecify a file extension.
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.
processors?IDataProcessor[]The 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.
timeZone?TimeZoneThe time zone you prefer.

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) when record data format conversion is disabled, Size.mebibytes(128) when it is enabled)

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

Minimum: Size.mebibytes(1) when record data format conversion is disabled, Size.mebibytes(64) when it is enabled 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.

dataFormatConversion?

Type: DataFormatConversionProps (optional, default: no data format conversion is done)

The input format, output format, and schema config for converting data from the JSON format to the Parquet or ORC format before writing to Amazon S3.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-extendeds3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration-dataformatconversionconfiguration

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

fileExtension?

Type: string (optional, default: The default file extension appended by Data Format Conversion or S3 compression features)

Specify a file extension.

It will override the default file extension appended by Data Format Conversion or S3 compression features such as .parquet or .gz.

File extension must start with a period (.) and can contain allowed characters: 0-9a-z!-_.*'().

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

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?⚠️

⚠️ Deprecated: Use processors instead.

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

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

processors?

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.

timeZone?

Type: TimeZone (optional, default: UTC)

The time zone you prefer.

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

← PreviousNext →