interface DeliveryStreamProps 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.KinesisFirehose.Alpha.DeliveryStreamProps`
Go	`github.com/aws/aws-cdk-go/awscdkkinesisfirehosealpha/v2#DeliveryStreamProps`
Java	`software.amazon.awscdk.services.kinesisfirehose.alpha.DeliveryStreamProps`
Python	`aws_cdk.aws_kinesisfirehose_alpha.DeliveryStreamProps`
TypeScript (source)	`@aws-cdk/aws-kinesisfirehose-alpha` » `DeliveryStreamProps`

Properties for a new delivery stream.

Example

import * as firehose from '@aws-cdk/aws-kinesisfirehose-alpha';
import * as destinations from '@aws-cdk/aws-kinesisfirehose-destinations-alpha';

const bucket = new s3.Bucket(this, 'MyBucket');
const stream = new firehose.DeliveryStream(this, 'MyStream', {
  destination: new destinations.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 Kinesis 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.