Class EmailSubscriptionProps
Options for email subscriptions.
Inheritance
Namespace: Amazon.CDK.AWS.SNS.Subscriptions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class EmailSubscriptionProps : Object, IEmailSubscriptionProps, ISubscriptionProps
Syntax (vb)
Public Class EmailSubscriptionProps
Inherits Object
Implements IEmailSubscriptionProps, 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 emailSubscriptionProps = new EmailSubscriptionProps {
DeadLetterQueue = queue,
FilterPolicy = new Dictionary<string, SubscriptionFilter> {
{ "filterPolicyKey", subscriptionFilter }
},
FilterPolicyWithMessageBody = new Dictionary<string, FilterOrPolicy> {
{ "filterPolicyWithMessageBodyKey", filterOrPolicy }
},
Json = false
};
Synopsis
Constructors
EmailSubscriptionProps() |
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. |
Json | Indicates if the full notification JSON should be sent to the email address or just the message text. |
Constructors
EmailSubscriptionProps()
public EmailSubscriptionProps()
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
Json
Indicates if the full notification JSON should be sent to the email address or just the message text.
public Nullable<bool> Json { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false (Message text)