software.amazon.awscdk.services.events.targets

Class SnsTopic

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.events.targets.SnsTopic

All Implemented Interfaces:

IRuleTarget, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.342Z")
 @Stability(value=Stable)
public class SnsTopic
extends software.amazon.jsii.JsiiObject
implements IRuleTarget

Use an SNS topic as a target for Amazon EventBridge rules.

Example:

 // publish to an SNS topic every time code is committed
 // to a CodeCommit repository
 repository.onCommit("onCommit", OnCommitOptions.builder().target(new SnsTopic(topic)).build());
 

Nested Class Summary

Nested Classes

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

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.events.IRuleTarget

IRuleTarget.Jsii$Default, IRuleTarget.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	SnsTopic(ITopic topic)
	SnsTopic(ITopic topic, SnsTopicProps props)
protected	SnsTopic(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SnsTopic(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
RuleTargetConfig	bind(IRule _rule) Returns a RuleTarget that can be used to trigger this SNS topic as a result from an EventBridge event.
RuleTargetConfig	bind(IRule _rule, String _id) Returns a RuleTarget that can be used to trigger this SNS topic as a result from an EventBridge event.
ITopic	getTopic()

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 Detail

SnsTopic

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

SnsTopic

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

SnsTopic

@Stability(value=Stable)
public SnsTopic(@NotNull
                                         ITopic topic,
                                         @Nullable
                                         SnsTopicProps props)

Parameters:

topic - This parameter is required.

props -

SnsTopic

@Stability(value=Stable)
public SnsTopic(@NotNull
                                         ITopic topic)

Parameters:

topic - This parameter is required.

Method Detail

bind

@Stability(value=Stable)
 @NotNull
public RuleTargetConfig bind(@NotNull
                                                                IRule _rule,
                                                                @Nullable
                                                                String _id)

Returns a RuleTarget that can be used to trigger this SNS topic as a result from an EventBridge event.

Specified by:

bind in interface IRuleTarget

Parameters:

_rule - This parameter is required.

_id -

See Also:

https://docs.aws.amazon.com/eventbridge/latest/userguide/resource-based-policies-eventbridge.html#sns-permissions

bind

@Stability(value=Stable)
 @NotNull
public RuleTargetConfig bind(@NotNull
                                                                IRule _rule)

Returns a RuleTarget that can be used to trigger this SNS topic as a result from an EventBridge event.

Specified by:

bind in interface IRuleTarget

Parameters:

_rule - This parameter is required.

See Also:

https://docs.aws.amazon.com/eventbridge/latest/userguide/resource-based-policies-eventbridge.html#sns-permissions

getTopic

@Stability(value=Stable)
 @NotNull
public ITopic getTopic()