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

Class EmailSubscription

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.sns.subscriptions.EmailSubscription

All Implemented Interfaces:

ITopicSubscription, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:09.915Z")
@Stability(Stable)
public class EmailSubscription
extends software.amazon.jsii.JsiiObject
implements ITopicSubscription

Use an email address as a subscription target.

Email subscriptions require confirmation.

Example:

 Topic myTopic = new Topic(this, "Topic");
 CfnParameter emailAddress = new CfnParameter(this, "email-param");
 myTopic.addSubscription(new EmailSubscription(emailAddress.getValueAsString()));
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EmailSubscription.Builder	A fluent builder for EmailSubscription.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.sns.ITopicSubscription

ITopicSubscription.Jsii$Default, ITopicSubscription.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	EmailSubscription(String emailAddress)
	EmailSubscription(String emailAddress, EmailSubscriptionProps props)
protected	EmailSubscription(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	EmailSubscription(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
TopicSubscriptionConfig	bind(ITopic _topic)	Returns a configuration for an email address to subscribe to an SNS topic.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

EmailSubscription

protected EmailSubscription(software.amazon.jsii.JsiiObjectRef objRef)

EmailSubscription

protected EmailSubscription(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

EmailSubscription

@Stability(Stable)
public EmailSubscription(@NotNull
 String emailAddress,
 @Nullable
 EmailSubscriptionProps props)

Parameters:

emailAddress - This parameter is required.

props -

EmailSubscription

@Stability(Stable)
public EmailSubscription(@NotNull
 String emailAddress)

Parameters:

emailAddress - This parameter is required.

Method Details

bind

@Stability(Stable)
@NotNull
public TopicSubscriptionConfig bind(@NotNull
 ITopic _topic)

Returns a configuration for an email address to subscribe to an SNS topic.

Specified by:

bind in interface ITopicSubscription

Parameters:

_topic - This parameter is required.