Package 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.104.0 (build e79254c)", date="2024-11-22T02:24:02.075Z") @Stability(Stable) public class SnsTopic extends software.amazon.jsii.JsiiObject implements IRuleTarget
Use an SNS topic as a target for Amazon EventBridge rules.

If the topic is imported the required permissions to publish to that topic need to be set manually.

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
    Description
    static final 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
    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
    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