interface FirehoseSubscriptionProps

Language	Type name
.NET	Amazon.CDK.AWS.SNS.Subscriptions.FirehoseSubscriptionProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssnssubscriptions#FirehoseSubscriptionProps
Java	software.amazon.awscdk.services.sns.subscriptions.FirehoseSubscriptionProps
Python	aws_cdk.aws_sns_subscriptions.FirehoseSubscriptionProps
TypeScript (source)	aws-cdk-lib » aws_sns_subscriptions » FirehoseSubscriptionProps

Properties for an Amazon Data Firehose subscription.

Example

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

const myTopic = new sns.Topic(this, 'Topic');
declare const stream: firehose.DeliveryStream;

myTopic.addSubscription(new subscriptions.FirehoseSubscription(stream, {
  rawMessageDelivery: true,
}));

Properties

Name	Type	Description
deadLetterQueue?	IQueue	Queue to be used as dead letter queue.
filterPolicy?	{ [string]: SubscriptionFilter }	The filter policy.
filterPolicyWithMessageBody?	{ [string]: FilterOrPolicy }	The filter policy that is applied on the message body.
rawMessageDelivery?	boolean	Whether to remove any Amazon SNS metadata from published messages.
role?	IRole	The role to assume to write messages to the Amazon Data Firehose delivery stream.

---

deadLetterQueue?

Type: IQueue (optional, default: No dead letter queue enabled.)

Queue to be used as dead letter queue.

If not passed no dead letter queue is enabled.

---

filterPolicy?

Type: { [string]: SubscriptionFilter } (optional, default: all messages are delivered)

The filter policy.

---

filterPolicyWithMessageBody?

Type: { [string]: FilterOrPolicy } (optional, default: all messages are delivered)

The filter policy that is applied on the message body.

To apply a filter policy to the message attributes, use filterPolicy. A maximum of one of filterPolicyWithMessageBody and filterPolicy may be used.

---

rawMessageDelivery?

Type: boolean (optional, default: false)

Whether to remove any Amazon SNS metadata from published messages.

See also: https://docs.aws.amazon.com/sns/latest/dg/sns-large-payload-raw-message-delivery.html

---

role?

Type: IRole (optional, default: A new Role is created)

The role to assume to write messages to the Amazon Data Firehose delivery stream.