interface DeliveryStreamProps

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

Properties for a new delivery stream.

Example

import * as firehose from 'aws-cdk-lib/aws-kinesisfirehose';

const bucket = new s3.Bucket(this, 'MyBucket');
const stream = new firehose.DeliveryStream(this, 'MyStream', {
  destination: new firehose.S3Bucket(bucket),
});

const topicRule = new iot.TopicRule(this, 'TopicRule', {
  sql: iot.IotSql.fromStringAsVer20160323("SELECT * FROM 'device/+/data'"),
  actions: [
    new actions.FirehosePutRecordAction(stream, {
      batchMode: true,
      recordSeparator: actions.FirehoseRecordSeparator.NEWLINE,
    }),
  ],
});

Properties

Name	Type	Description
destination	IDestination	The destination that this delivery stream will deliver data to.
deliveryStreamName?	string	A name for the delivery stream.
encryption?	StreamEncryption	Indicates the type of customer master key (CMK) to use for server-side encryption, if any.
role?	IRole	The IAM role associated with this delivery stream.
source?	ISource	The Kinesis data stream to use as a source for this delivery stream.

---

destination

Type: IDestination

The destination that this delivery stream will deliver data to.

---

deliveryStreamName?

Type: string (optional, default: a name is generated by CloudFormation.)

A name for the delivery stream.

---

encryption?

Type: StreamEncryption (optional, default: StreamEncryption.unencrypted())

Indicates the type of customer master key (CMK) to use for server-side encryption, if any.

---

role?

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

The IAM role associated with this delivery stream.

Assumed by Amazon Data Firehose to read from sources and encrypt data server-side.

---

source?

Type: ISource (optional, default: data must be written to the delivery stream via a direct put.)

The Kinesis data stream to use as a source for this delivery stream.