software.amazon.awscdk.services.events.targets

Interface SnsTopicProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TargetBaseProps

All Known Implementing Classes:

SnsTopicProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.342Z")
 @Stability(value=Stable)
public interface SnsTopicProps
extends software.amazon.jsii.JsiiSerializable, TargetBaseProps

Customize the SNS Topic Event Target.

Example:

 Rule onCommitRule;
 Topic topic;
 onCommitRule.addTarget(SnsTopic.Builder.create(topic)
         .message(RuleTargetInput.fromText(String.format("A commit was pushed to the repository %s on branch %s", ReferenceEvent.getRepositoryName(), ReferenceEvent.getReferenceName())))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SnsTopicProps.Builder	builder()
default RuleTargetInput	getMessage() The message to send to the topic.

Methods inherited from interface software.amazon.awscdk.services.events.targets.TargetBaseProps

getDeadLetterQueue, getMaxEventAge, getRetryAttempts

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMessage

@Stability(value=Stable)
 @Nullable
default RuleTargetInput getMessage()

The message to send to the topic.

Default: the entire EventBridge event

builder

@Stability(value=Stable)
static SnsTopicProps.Builder builder()

Specified by:

builder in interface TargetBaseProps

Returns:

a SnsTopicProps.Builder of SnsTopicProps