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

Interface EmailSubscriptionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SubscriptionProps

All Known Implementing Classes:

EmailSubscriptionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:41.452Z")
@Stability(Stable)
public interface EmailSubscriptionProps
extends software.amazon.jsii.JsiiSerializable, SubscriptionProps

Options for email subscriptions.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sns.*;
 import software.amazon.awscdk.services.sns.subscriptions.*;
 import software.amazon.awscdk.services.sqs.*;
 Queue queue;
 SubscriptionFilter subscriptionFilter;
 EmailSubscriptionProps emailSubscriptionProps = EmailSubscriptionProps.builder()
         .deadLetterQueue(queue)
         .filterPolicy(Map.of(
                 "filterPolicyKey", subscriptionFilter))
         .json(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static EmailSubscriptionProps.Builder	builder()
default Boolean	getJson()	Indicates if the full notification JSON should be sent to the email address or just the message text.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getDeadLetterQueue, getFilterPolicy

Method Details

getJson

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

Indicates if the full notification JSON should be sent to the email address or just the message text.

Default: false (Message text)

builder

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

Returns:

a EmailSubscriptionProps.Builder of EmailSubscriptionProps