software.amazon.awscdk.services.sns

Class TopicBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.sns.TopicBase

All Implemented Interfaces:

IResource, INotificationRuleTarget, ITopic, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

Topic

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.245Z")
 @Stability(value=Stable)
public abstract class TopicBase
extends Resource
implements ITopic

Either a new or imported Topic.

Nested Class Summary

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.sns.ITopic

ITopic.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TopicBase(software.constructs.Construct scope, String id)
protected	TopicBase(software.constructs.Construct scope, String id, ResourceProps props)
protected	TopicBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TopicBase(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Subscription	addSubscription(ITopicSubscription subscription) Subscribe some endpoint to this topic.
AddToResourcePolicyResult	addToResourcePolicy(PolicyStatement statement) Adds a statement to the IAM resource policy associated with this topic.
NotificationRuleTargetConfig	bindAsNotificationRuleTarget(software.constructs.Construct _scope) Represents a notification target That allows SNS topic to associate with this rule target.
protected abstract Boolean	getAutoCreatePolicy() Controls automatic creation of policy objects.
abstract Boolean	getFifo() Whether this topic is an Amazon SNS FIFO queue.
abstract String	getTopicArn() The ARN of the topic.
abstract String	getTopicName() The name of the topic.
Grant	grantPublish(IGrantable grantee) Grant topic publishing permissions to the given identity.
Metric	metric(String metricName) Return the given named metric for this Topic.
Metric	metric(String metricName, MetricOptions props) Return the given named metric for this Topic.
Metric	metricNumberOfMessagesPublished() The number of messages published to your Amazon SNS topics.
Metric	metricNumberOfMessagesPublished(MetricOptions props) The number of messages published to your Amazon SNS topics.
Metric	metricNumberOfNotificationsDelivered() The number of messages successfully delivered from your Amazon SNS topics to subscribing endpoints.
Metric	metricNumberOfNotificationsDelivered(MetricOptions props) The number of messages successfully delivered from your Amazon SNS topics to subscribing endpoints.
Metric	metricNumberOfNotificationsFailed() The number of messages that Amazon SNS failed to deliver.
Metric	metricNumberOfNotificationsFailed(MetricOptions props) The number of messages that Amazon SNS failed to deliver.
Metric	metricNumberOfNotificationsFilteredOut() The number of messages that were rejected by subscription filter policies.
Metric	metricNumberOfNotificationsFilteredOut(MetricOptions props) The number of messages that were rejected by subscription filter policies.
Metric	metricNumberOfNotificationsFilteredOutInvalidAttributes() The number of messages that were rejected by subscription filter policies because the messages' attributes are invalid.
Metric	metricNumberOfNotificationsFilteredOutInvalidAttributes(MetricOptions props) The number of messages that were rejected by subscription filter policies because the messages' attributes are invalid.
Metric	metricNumberOfNotificationsFilteredOutNoMessageAttributes() The number of messages that were rejected by subscription filter policies because the messages have no attributes.
Metric	metricNumberOfNotificationsFilteredOutNoMessageAttributes(MetricOptions props) The number of messages that were rejected by subscription filter policies because the messages have no attributes.
Metric	metricPublishSize() Metric for the size of messages published through this topic.
Metric	metricPublishSize(MetricOptions props) Metric for the size of messages published through this topic.
Metric	metricSMSMonthToDateSpentUSD() The charges you have accrued since the start of the current calendar month for sending SMS messages.
Metric	metricSMSMonthToDateSpentUSD(MetricOptions props) The charges you have accrued since the start of the current calendar month for sending SMS messages.
Metric	metricSMSSuccessRate() The rate of successful SMS message deliveries.
Metric	metricSMSSuccessRate(MetricOptions props) The rate of successful SMS message deliveries.

Methods inherited from class software.amazon.awscdk.Resource

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

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

TopicBase

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

TopicBase

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

TopicBase

@Stability(value=Stable)
protected TopicBase(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @Nullable
                                             ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

TopicBase

@Stability(value=Stable)
protected TopicBase(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addSubscription

@Stability(value=Stable)
 @NotNull
public Subscription addSubscription(@NotNull
                                                                       ITopicSubscription subscription)

Subscribe some endpoint to this topic.

Specified by:

addSubscription in interface ITopic

Parameters:

subscription - This parameter is required.

addToResourcePolicy

@Stability(value=Stable)
 @NotNull
public AddToResourcePolicyResult addToResourcePolicy(@NotNull
                                                                                        PolicyStatement statement)

Adds a statement to the IAM resource policy associated with this topic.

If this topic was created in this stack (new Topic), a topic policy will be automatically created upon the first call to addToPolicy. If the topic is imported (Topic.import), then this is a no-op.

Specified by:

addToResourcePolicy in interface ITopic

Parameters:

statement - This parameter is required.

bindAsNotificationRuleTarget

@Stability(value=Stable)
 @NotNull
public NotificationRuleTargetConfig bindAsNotificationRuleTarget(@NotNull
                                                                                                    software.constructs.Construct _scope)

Represents a notification target That allows SNS topic to associate with this rule target.

Specified by:

bindAsNotificationRuleTarget in interface INotificationRuleTarget

Parameters:

_scope - This parameter is required.

grantPublish

@Stability(value=Stable)
 @NotNull
public Grant grantPublish(@NotNull
                                                             IGrantable grantee)

Grant topic publishing permissions to the given identity.

Specified by:

grantPublish in interface ITopic

Parameters:

grantee - This parameter is required.

metric

@Stability(value=Stable)
 @NotNull
public Metric metric(@NotNull
                                                        String metricName,
                                                        @Nullable
                                                        MetricOptions props)

Return the given named metric for this Topic.

Specified by:

metric in interface ITopic

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(value=Stable)
 @NotNull
public Metric metric(@NotNull
                                                        String metricName)

Return the given named metric for this Topic.

Specified by:

metric in interface ITopic

Parameters:

metricName - This parameter is required.

metricNumberOfMessagesPublished

@Stability(value=Stable)
 @NotNull
public Metric metricNumberOfMessagesPublished(@Nullable
                                                                                 MetricOptions props)

The number of messages published to your Amazon SNS topics.

Sum over 5 minutes

Specified by:

metricNumberOfMessagesPublished in interface ITopic

Parameters:

props -

metricNumberOfMessagesPublished

@Stability(value=Stable)
 @NotNull
public Metric metricNumberOfMessagesPublished()

The number of messages published to your Amazon SNS topics.

Sum over 5 minutes

Specified by:

metricNumberOfMessagesPublished in interface ITopic

metricNumberOfNotificationsDelivered

@Stability(value=Stable)
 @NotNull
public Metric metricNumberOfNotificationsDelivered(@Nullable
                                                                                      MetricOptions props)

The number of messages successfully delivered from your Amazon SNS topics to subscribing endpoints.

Sum over 5 minutes

Specified by:

metricNumberOfNotificationsDelivered in interface ITopic

Parameters:

props -

metricNumberOfNotificationsDelivered

@Stability(value=Stable)
 @NotNull
public Metric metricNumberOfNotificationsDelivered()

The number of messages successfully delivered from your Amazon SNS topics to subscribing endpoints.

Sum over 5 minutes

Specified by:

metricNumberOfNotificationsDelivered in interface ITopic

metricNumberOfNotificationsFailed

@Stability(value=Stable)
 @NotNull
public Metric metricNumberOfNotificationsFailed(@Nullable
                                                                                   MetricOptions props)

The number of messages that Amazon SNS failed to deliver.

Sum over 5 minutes

Specified by:

metricNumberOfNotificationsFailed in interface ITopic

Parameters:

props -

metricNumberOfNotificationsFailed

@Stability(value=Stable)
 @NotNull
public Metric metricNumberOfNotificationsFailed()

The number of messages that Amazon SNS failed to deliver.

Sum over 5 minutes

Specified by:

metricNumberOfNotificationsFailed in interface ITopic

metricNumberOfNotificationsFilteredOut

@Stability(value=Stable)
 @NotNull
public Metric metricNumberOfNotificationsFilteredOut(@Nullable
                                                                                        MetricOptions props)

The number of messages that were rejected by subscription filter policies.

Sum over 5 minutes

Specified by:

metricNumberOfNotificationsFilteredOut in interface ITopic

Parameters:

props -

metricNumberOfNotificationsFilteredOut

@Stability(value=Stable)
 @NotNull
public Metric metricNumberOfNotificationsFilteredOut()

The number of messages that were rejected by subscription filter policies.

Sum over 5 minutes

Specified by:

metricNumberOfNotificationsFilteredOut in interface ITopic

metricNumberOfNotificationsFilteredOutInvalidAttributes

@Stability(value=Stable)
 @NotNull
public Metric metricNumberOfNotificationsFilteredOutInvalidAttributes(@Nullable
                                                                                                         MetricOptions props)

The number of messages that were rejected by subscription filter policies because the messages' attributes are invalid.

Sum over 5 minutes

Specified by:

metricNumberOfNotificationsFilteredOutInvalidAttributes in interface ITopic

Parameters:

props -

metricNumberOfNotificationsFilteredOutInvalidAttributes

@Stability(value=Stable)
 @NotNull
public Metric metricNumberOfNotificationsFilteredOutInvalidAttributes()

The number of messages that were rejected by subscription filter policies because the messages' attributes are invalid.

Sum over 5 minutes

Specified by:

metricNumberOfNotificationsFilteredOutInvalidAttributes in interface ITopic

metricNumberOfNotificationsFilteredOutNoMessageAttributes

@Stability(value=Stable)
 @NotNull
public Metric metricNumberOfNotificationsFilteredOutNoMessageAttributes(@Nullable
                                                                                                           MetricOptions props)

The number of messages that were rejected by subscription filter policies because the messages have no attributes.

Sum over 5 minutes

Specified by:

metricNumberOfNotificationsFilteredOutNoMessageAttributes in interface ITopic

Parameters:

props -

metricNumberOfNotificationsFilteredOutNoMessageAttributes

@Stability(value=Stable)
 @NotNull
public Metric metricNumberOfNotificationsFilteredOutNoMessageAttributes()

The number of messages that were rejected by subscription filter policies because the messages have no attributes.

Sum over 5 minutes

Specified by:

metricNumberOfNotificationsFilteredOutNoMessageAttributes in interface ITopic

metricPublishSize

@Stability(value=Stable)
 @NotNull
public Metric metricPublishSize(@Nullable
                                                                   MetricOptions props)

Metric for the size of messages published through this topic.

Average over 5 minutes

Specified by:

metricPublishSize in interface ITopic

Parameters:

props -

metricPublishSize

@Stability(value=Stable)
 @NotNull
public Metric metricPublishSize()

Metric for the size of messages published through this topic.

Average over 5 minutes

Specified by:

metricPublishSize in interface ITopic

metricSMSMonthToDateSpentUSD

@Stability(value=Stable)
 @NotNull
public Metric metricSMSMonthToDateSpentUSD(@Nullable
                                                                              MetricOptions props)

The charges you have accrued since the start of the current calendar month for sending SMS messages.

Maximum over 5 minutes

Specified by:

metricSMSMonthToDateSpentUSD in interface ITopic

Parameters:

props -

metricSMSMonthToDateSpentUSD

@Stability(value=Stable)
 @NotNull
public Metric metricSMSMonthToDateSpentUSD()

The charges you have accrued since the start of the current calendar month for sending SMS messages.

Maximum over 5 minutes

Specified by:

metricSMSMonthToDateSpentUSD in interface ITopic

metricSMSSuccessRate

@Stability(value=Stable)
 @NotNull
public Metric metricSMSSuccessRate(@Nullable
                                                                      MetricOptions props)

The rate of successful SMS message deliveries.

Sum over 5 minutes

Specified by:

metricSMSSuccessRate in interface ITopic

Parameters:

props -

metricSMSSuccessRate

@Stability(value=Stable)
 @NotNull
public Metric metricSMSSuccessRate()

The rate of successful SMS message deliveries.

Sum over 5 minutes

Specified by:

metricSMSSuccessRate in interface ITopic

getAutoCreatePolicy

@Stability(value=Stable)
 @NotNull
protected abstract Boolean getAutoCreatePolicy()

Controls automatic creation of policy objects.

Set by subclasses.

getFifo

@Stability(value=Stable)
 @NotNull
public abstract Boolean getFifo()

Whether this topic is an Amazon SNS FIFO queue.

If false, this is a standard topic.

Specified by:

getFifo in interface ITopic

getTopicArn

@Stability(value=Stable)
 @NotNull
public abstract String getTopicArn()

The ARN of the topic.

Specified by:

getTopicArn in interface ITopic

getTopicName

@Stability(value=Stable)
 @NotNull
public abstract String getTopicName()

The name of the topic.

Specified by:

getTopicName in interface ITopic