software.amazon.awscdk.services.sns

Class Topic

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.sns.TopicBase

software.amazon.awscdk.services.sns.Topic

All Implemented Interfaces:

IConstruct, IDependable, IResource, INotificationRuleTarget, ITopic

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:42.106Z")
public class Topic
extends TopicBase

A new SNS topic.

Example:

 import software.amazon.awscdk.services.sns.*;
 Topic topic = new Topic(this, "MyTopic");
 TopicRule topicRule = TopicRule.Builder.create(this, "TopicRule")
         .sql(IotSql.fromStringAsVer20160323("SELECT topic(2) as device_id, year, month, day FROM 'device/+/data'"))
         .actions(List.of(
             SnsTopicAction.Builder.create(topic)
                     .messageFormat(SnsActionMessageFormat.JSON)
                     .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

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

ITopic.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Topic(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Topic(software.amazon.jsii.JsiiObjectRef objRef)
	Topic(software.constructs.Construct scope, java.lang.String id)
	Topic(software.constructs.Construct scope, java.lang.String id, TopicProps props)

Method Summary

Modifier and Type	Method and Description
static ITopic	fromTopicArn(software.constructs.Construct scope, java.lang.String id, java.lang.String topicArn) Import an existing SNS topic provided an ARN.
protected java.lang.Boolean	getAutoCreatePolicy() Controls automatic creation of policy objects.
java.lang.Boolean	getFifo() Whether this topic is an Amazon SNS FIFO queue.
java.lang.String	getTopicArn() The ARN of the topic.
java.lang.String	getTopicName() The name of the topic.

Methods inherited from class software.amazon.awscdk.services.sns.TopicBase

addSubscription, addToResourcePolicy, bindAsNotificationRuleTarget, grantPublish, metric, metric, metricNumberOfMessagesPublished, metricNumberOfMessagesPublished, metricNumberOfNotificationsDelivered, metricNumberOfNotificationsDelivered, metricNumberOfNotificationsFailed, metricNumberOfNotificationsFailed, metricNumberOfNotificationsFilteredOut, metricNumberOfNotificationsFilteredOut, metricNumberOfNotificationsFilteredOutInvalidAttributes, metricNumberOfNotificationsFilteredOutInvalidAttributes, metricNumberOfNotificationsFilteredOutNoMessageAttributes, metricNumberOfNotificationsFilteredOutNoMessageAttributes, metricPublishSize, metricPublishSize, metricSMSMonthToDateSpentUSD, metricSMSMonthToDateSpentUSD, metricSMSSuccessRate, metricSMSSuccessRate, validate

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

Topic

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

Topic

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

Topic

public Topic(software.constructs.Construct scope,
             java.lang.String id,
             TopicProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Topic

public Topic(software.constructs.Construct scope,
             java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromTopicArn

public static ITopic fromTopicArn(software.constructs.Construct scope,
                                  java.lang.String id,
                                  java.lang.String topicArn)

Import an existing SNS topic provided an ARN.

Parameters:

scope - The parent creating construct. This parameter is required.

id - The construct's name. This parameter is required.

topicArn - topic ARN (i.e. arn:aws:sns:us-east-2:444455556666:MyTopic). This parameter is required.

getAutoCreatePolicy

protected java.lang.Boolean getAutoCreatePolicy()

Controls automatic creation of policy objects.

Set by subclasses.

Specified by:

getAutoCreatePolicy in class TopicBase

getFifo

public java.lang.Boolean getFifo()

Whether this topic is an Amazon SNS FIFO queue.

If false, this is a standard topic.

Specified by:

getFifo in interface ITopic

Specified by:

getFifo in class TopicBase

getTopicArn

public java.lang.String getTopicArn()

The ARN of the topic.

Specified by:

getTopicArn in interface ITopic

Specified by:

getTopicArn in class TopicBase

getTopicName

public java.lang.String getTopicName()

The name of the topic.

Specified by:

getTopicName in interface ITopic

Specified by:

getTopicName in class TopicBase