Class UrlSubscriptionProps
Options for URL subscriptions.
Inheritance
Namespace: Amazon.CDK.AWS.SNS.Subscriptions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class UrlSubscriptionProps : Object, IUrlSubscriptionProps, ISubscriptionProps
Syntax (vb)
Public Class UrlSubscriptionProps
Inherits Object
Implements IUrlSubscriptionProps, ISubscriptionProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SNS;
using Amazon.CDK.AWS.SNS.Subscriptions;
using Amazon.CDK.AWS.SQS;
FilterOrPolicy filterOrPolicy;
Queue queue;
SubscriptionFilter subscriptionFilter;
var urlSubscriptionProps = new UrlSubscriptionProps {
DeadLetterQueue = queue,
FilterPolicy = new Dictionary<string, SubscriptionFilter> {
{ "filterPolicyKey", subscriptionFilter }
},
FilterPolicyWithMessageBody = new Dictionary<string, FilterOrPolicy> {
{ "filterPolicyWithMessageBodyKey", filterOrPolicy }
},
Protocol = SubscriptionProtocol.HTTP,
RawMessageDelivery = false
};
Synopsis
Constructors
UrlSubscriptionProps() |
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. |
Protocol | The subscription's protocol. |
RawMessageDelivery | The message to the queue is the same as it was sent to the topic. |
Constructors
UrlSubscriptionProps()
public UrlSubscriptionProps()
Properties
DeadLetterQueue
Queue to be used as dead letter queue.
public IQueue DeadLetterQueue { get; set; }
Property Value
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
System.Collections.Generic.IDictionary<System.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
System.Collections.Generic.IDictionary<System.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
Protocol
The subscription's protocol.
public Nullable<SubscriptionProtocol> Protocol { get; set; }
Property Value
System.Nullable<SubscriptionProtocol>
Remarks
Default: - Protocol is derived from url
RawMessageDelivery
The message to the queue is the same as it was sent to the topic.
public Nullable<bool> RawMessageDelivery { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
If false, the message will be wrapped in an SNS envelope.
Default: false