Class FirehoseSubscriptionProps

Properties for an Amazon Data Firehose subscription.

Inheritance

object

FirehoseSubscriptionProps

Implements

IFirehoseSubscriptionProps

ISubscriptionProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.SNS.Subscriptions

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class FirehoseSubscriptionProps : IFirehoseSubscriptionProps, ISubscriptionProps

Syntax (vb)

Public Class FirehoseSubscriptionProps Implements IFirehoseSubscriptionProps, ISubscriptionProps

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.KinesisFirehose;
            DeliveryStream stream;


            var myTopic = new Topic(this, "Topic");

            myTopic.AddSubscription(new FirehoseSubscription(stream, new FirehoseSubscriptionProps {
                RawMessageDelivery = true
            }));

Synopsis

Constructors

FirehoseSubscriptionProps()

Properties for an Amazon Data Firehose subscription.

Properties

DeadLetterQueue	Queue to be used as dead letter queue.
FilterPolicy	The filter policy.
FilterPolicyWithMessageBody	The filter policy that is applied on the message body.
RawMessageDelivery	Whether to remove any Amazon SNS metadata from published messages.
Role	The role to assume to write messages to the Amazon Data Firehose delivery stream.

Constructors

FirehoseSubscriptionProps()

Properties for an Amazon Data Firehose subscription.

public FirehoseSubscriptionProps()

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.KinesisFirehose;
            DeliveryStream stream;


            var myTopic = new Topic(this, "Topic");

            myTopic.AddSubscription(new FirehoseSubscription(stream, new FirehoseSubscriptionProps {
                RawMessageDelivery = true
            }));

Properties

DeadLetterQueue

Queue to be used as dead letter queue.

public IQueue? DeadLetterQueue { get; set; }

Property Value

IQueue

Remarks

If not passed no dead letter queue is enabled.

Default: - No dead letter queue enabled.

FilterPolicy

The filter policy.

public IDictionary<string, SubscriptionFilter>? FilterPolicy { get; set; }

Property Value

IDictionary<string, SubscriptionFilter>

Remarks

Default: - all messages are delivered

FilterPolicyWithMessageBody

The filter policy that is applied on the message body.

public IDictionary<string, FilterOrPolicy>? FilterPolicyWithMessageBody { get; set; }

Property Value

IDictionary<string, FilterOrPolicy>

Remarks

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

Default: - all messages are delivered

RawMessageDelivery

Whether to remove any Amazon SNS metadata from published messages.

public bool? RawMessageDelivery { get; set; }

Property Value

bool?

Remarks

Default: false

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

Role

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

public IRole? Role { get; set; }

Property Value

IRole

Remarks

Default: - A new Role is created

Implements

IFirehoseSubscriptionProps

ISubscriptionProps