1.204.0

interface DeliveryStreamProps 🔹

LanguageType name
.NETAmazon.CDK.AWS.KinesisFirehose.DeliveryStreamProps
Javasoftware.amazon.awscdk.services.kinesisfirehose.DeliveryStreamProps
Pythonaws_cdk.aws_kinesisfirehose.DeliveryStreamProps
TypeScript (source)@aws-cdk/aws-kinesisfirehose » DeliveryStreamProps

Properties for a new 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_14_X,
  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

NameTypeDescription
destinations🔹IDestination[]The destinations that this delivery stream will deliver data to.
deliveryStreamName?🔹stringA name for the delivery stream.
encryption?🔹StreamEncryptionIndicates the type of customer master key (CMK) to use for server-side encryption, if any.
encryptionKey?🔹IKeyCustomer managed key to server-side encrypt data in the stream.
role?🔹IRoleThe IAM role associated with this delivery stream.
sourceStream?🔹IStreamThe Kinesis data stream to use as a source for this delivery stream.

destinations🔹

Type: IDestination[]

The destinations that this delivery stream will deliver data to.

Only a singleton array is supported at this time.

deliveryStreamName?🔹

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

A name for the delivery stream.

encryption?🔹

Type: StreamEncryption (optional, default: StreamEncryption.UNENCRYPTED - unless encryptionKey is provided, in which case this will be implicitly set to StreamEncryption.CUSTOMER_MANAGED)

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

encryptionKey?🔹

Type: IKey (optional, default: no KMS key will be used; if encryption is set to CUSTOMER_MANAGED, a KMS key will be created for you)

Customer managed key to server-side encrypt data in the stream.

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.

sourceStream?🔹

Type: IStream (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.

← PreviousNext →