Package software.amazon.awscdk.services.sns.subscriptions

Interface FirehoseSubscriptionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SubscriptionProps

All Known Implementing Classes:

FirehoseSubscriptionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:40.846Z")
@Stability(Stable)
public interface FirehoseSubscriptionProps
extends software.amazon.jsii.JsiiSerializable, SubscriptionProps

Properties for an Amazon Data Firehose subscription.

Example:

 import software.amazon.awscdk.services.kinesisfirehose.*;
 DeliveryStream stream;
 Topic myTopic = new Topic(this, "Topic");
 myTopic.addSubscription(FirehoseSubscription.Builder.create(stream)
         .rawMessageDelivery(true)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	FirehoseSubscriptionProps.Builder	A builder for FirehoseSubscriptionProps
static final class	FirehoseSubscriptionProps.Jsii$Proxy	An implementation for FirehoseSubscriptionProps

Method Summary

Modifier and Type	Method	Description
static FirehoseSubscriptionProps.Builder	builder()
default Boolean	getRawMessageDelivery()	Whether to remove any Amazon SNS metadata from published messages.
default IRole	getRole()	The role to assume to write messages to the Amazon Data Firehose delivery stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.sns.subscriptions.SubscriptionProps

getDeadLetterQueue, getFilterPolicy, getFilterPolicyWithMessageBody

Method Details

getRawMessageDelivery

@Stability(Stable)
@Nullable
default Boolean getRawMessageDelivery()

Whether to remove any Amazon SNS metadata from published messages.

Default: false

See Also:

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

getRole

@Stability(Stable)
@Nullable
default IRole getRole()

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

Default: - A new Role is created

builder

@Stability(Stable)
static FirehoseSubscriptionProps.Builder builder()

Returns:

a FirehoseSubscriptionProps.Builder of FirehoseSubscriptionProps