software.amazon.awscdk.services.sns

Interface ITopic

All Superinterfaces:

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

All Known Subinterfaces:

ITopic.Jsii$Default

All Known Implementing Classes:

ITopic.Jsii$Proxy, Topic, TopicBase

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

Represents an SNS topic.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ITopic.Jsii$Default Internal default implementation for ITopic.
static class	ITopic.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

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.
Boolean	getFifo() Whether this topic is an Amazon SNS FIFO queue.
String	getTopicArn() The ARN of the topic.
String	getTopicName() The name of the topic.
Grant	grantPublish(IGrantable identity) 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 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

Methods inherited from interface software.amazon.awscdk.services.codestarnotifications.INotificationRuleTarget

bindAsNotificationRuleTarget

Method Detail

getFifo

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

Whether this topic is an Amazon SNS FIFO queue.

If false, this is a standard topic.

getTopicArn

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

The ARN of the topic.

getTopicName

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

The name of the topic.

addSubscription

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

Subscribe some endpoint to this topic.

Parameters:

subscription - This parameter is required.

addToResourcePolicy

@Stability(value=Stable)
 @NotNull
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.

Parameters:

statement - This parameter is required.

grantPublish

@Stability(value=Stable)
 @NotNull
Grant grantPublish(@NotNull
                                                      IGrantable identity)

Grant topic publishing permissions to the given identity.

Parameters:

identity - This parameter is required.

metric

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

Return the given named metric for this Topic.

Parameters:

metricName - This parameter is required.

props -

metric

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

Return the given named metric for this Topic.

Parameters:

metricName - This parameter is required.

metricNumberOfMessagesPublished

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

The number of messages published to your Amazon SNS topics.

Sum over 5 minutes

Parameters:

props -

metricNumberOfMessagesPublished

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

The number of messages published to your Amazon SNS topics.

Sum over 5 minutes

metricNumberOfNotificationsDelivered

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

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

Sum over 5 minutes

Parameters:

props -

metricNumberOfNotificationsDelivered

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

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

Sum over 5 minutes

metricNumberOfNotificationsFailed

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

The number of messages that Amazon SNS failed to deliver.

Sum over 5 minutes

Parameters:

props -

metricNumberOfNotificationsFailed

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

The number of messages that Amazon SNS failed to deliver.

Sum over 5 minutes

metricNumberOfNotificationsFilteredOut

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

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

Sum over 5 minutes

Parameters:

props -

metricNumberOfNotificationsFilteredOut

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

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

Sum over 5 minutes

metricNumberOfNotificationsFilteredOutInvalidAttributes

@Stability(value=Stable)
 @NotNull
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

Parameters:

props -

metricNumberOfNotificationsFilteredOutInvalidAttributes

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

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

Sum over 5 minutes

metricNumberOfNotificationsFilteredOutNoMessageAttributes

@Stability(value=Stable)
 @NotNull
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

Parameters:

props -

metricNumberOfNotificationsFilteredOutNoMessageAttributes

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

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

Sum over 5 minutes

metricPublishSize

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

Metric for the size of messages published through this topic.

Average over 5 minutes

Parameters:

props -

metricPublishSize

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

Metric for the size of messages published through this topic.

Average over 5 minutes

metricSMSMonthToDateSpentUSD

@Stability(value=Stable)
 @NotNull
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

Parameters:

props -

metricSMSMonthToDateSpentUSD

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

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

Maximum over 5 minutes

metricSMSSuccessRate

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

The rate of successful SMS message deliveries.

Sum over 5 minutes

Parameters:

props -

metricSMSSuccessRate

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

The rate of successful SMS message deliveries.

Sum over 5 minutes