software.amazon.awscdk.services.ses.actions

Interface SnsProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SnsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-11T19:24:38.111Z")
 @Stability(value=Experimental)
public interface SnsProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Construction properties for a SNS action.

Example:

 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.core.*;
 Bucket bucket = new Bucket(this, "Bucket");
 Topic topic = new Topic(this, "Topic");
 ReceiptRuleSet.Builder.create(this, "RuleSet")
         .rules(List.of(ReceiptRuleOptions.builder()
                 .recipients(List.of("hello@aws.com"))
                 .actions(List.of(
                     AddHeader.Builder.create()
                             .name("X-Special-Header")
                             .value("aws")
                             .build(),
                     S3.Builder.create()
                             .bucket(bucket)
                             .objectKeyPrefix("emails/")
                             .topic(topic)
                             .build()))
                 .build(), ReceiptRuleOptions.builder()
                 .recipients(List.of("aws.com"))
                 .actions(List.of(
                     Sns.Builder.create()
                             .topic(topic)
                             .build()))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SnsProps.Builder	builder()
default EmailEncoding	getEncoding() (experimental) The encoding to use for the email within the Amazon SNS notification.
ITopic	getTopic() (experimental) The SNS topic to notify.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTopic

@Stability(value=Experimental)
 @NotNull
ITopic getTopic()

(experimental) The SNS topic to notify.

getEncoding

@Stability(value=Experimental)
 @Nullable
default EmailEncoding getEncoding()

(experimental) The encoding to use for the email within the Amazon SNS notification.

Default: UTF-8

builder

@Stability(value=Experimental)
static SnsProps.Builder builder()

Returns:

a SnsProps.Builder of SnsProps