software.amazon.awscdk.services.sns

Interface ITopic

All Superinterfaces:

IConstruct, IDependable, INotificationRuleTarget, IResource

All Known Subinterfaces:

ITopic.Jsii$Default

All Known Implementing Classes:

ITopic.Jsii$Proxy, Topic, TopicBase

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:42.082Z")
public interface ITopic
extends 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
void	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.
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.
Grant	grantPublish(IGrantable identity) Grant topic publishing permissions to the given identity.
Metric	metric(java.lang.String metricName) Return the given named metric for this Topic.
Metric	metric(java.lang.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.core.IResource

applyRemovalPolicy, getEnv, getStack

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

getNode

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

bindAsNotificationRuleTarget

Method Detail

getFifo

java.lang.Boolean getFifo()

Whether this topic is an Amazon SNS FIFO queue.

If false, this is a standard topic.

getTopicArn

java.lang.String getTopicArn()

The ARN of the topic.

getTopicName

java.lang.String getTopicName()

The name of the topic.

addSubscription

void addSubscription(ITopicSubscription subscription)

Subscribe some endpoint to this topic.

Parameters:

subscription - This parameter is required.

addToResourcePolicy

AddToResourcePolicyResult addToResourcePolicy(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

Grant grantPublish(IGrantable identity)

Grant topic publishing permissions to the given identity.

Parameters:

identity - This parameter is required.

metric

Metric metric(java.lang.String metricName,
              MetricOptions props)

Return the given named metric for this Topic.

Parameters:

metricName - This parameter is required.

props -

metric

Metric metric(java.lang.String metricName)

Return the given named metric for this Topic.

Parameters:

metricName - This parameter is required.

metricNumberOfMessagesPublished

Metric metricNumberOfMessagesPublished(MetricOptions props)

The number of messages published to your Amazon SNS topics.

Sum over 5 minutes

Parameters:

props -

metricNumberOfMessagesPublished

Metric metricNumberOfMessagesPublished()

The number of messages published to your Amazon SNS topics.

Sum over 5 minutes

metricNumberOfNotificationsDelivered

Metric metricNumberOfNotificationsDelivered(MetricOptions props)

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

Sum over 5 minutes

Parameters:

props -

metricNumberOfNotificationsDelivered

Metric metricNumberOfNotificationsDelivered()

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

Sum over 5 minutes

metricNumberOfNotificationsFailed

Metric metricNumberOfNotificationsFailed(MetricOptions props)

The number of messages that Amazon SNS failed to deliver.

Sum over 5 minutes

Parameters:

props -

metricNumberOfNotificationsFailed

Metric metricNumberOfNotificationsFailed()

The number of messages that Amazon SNS failed to deliver.

Sum over 5 minutes

metricNumberOfNotificationsFilteredOut

Metric metricNumberOfNotificationsFilteredOut(MetricOptions props)

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

Sum over 5 minutes

Parameters:

props -

metricNumberOfNotificationsFilteredOut

Metric metricNumberOfNotificationsFilteredOut()

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

Sum over 5 minutes

metricNumberOfNotificationsFilteredOutInvalidAttributes

Metric metricNumberOfNotificationsFilteredOutInvalidAttributes(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

Metric metricNumberOfNotificationsFilteredOutInvalidAttributes()

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

Sum over 5 minutes

metricNumberOfNotificationsFilteredOutNoMessageAttributes

Metric metricNumberOfNotificationsFilteredOutNoMessageAttributes(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

Metric metricNumberOfNotificationsFilteredOutNoMessageAttributes()

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

Sum over 5 minutes

metricPublishSize

Metric metricPublishSize(MetricOptions props)

Metric for the size of messages published through this topic.

Average over 5 minutes

Parameters:

props -

metricPublishSize

Metric metricPublishSize()

Metric for the size of messages published through this topic.

Average over 5 minutes

metricSMSMonthToDateSpentUSD

Metric metricSMSMonthToDateSpentUSD(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

Metric metricSMSMonthToDateSpentUSD()

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

Maximum over 5 minutes

metricSMSSuccessRate

Metric metricSMSSuccessRate(MetricOptions props)

The rate of successful SMS message deliveries.

Sum over 5 minutes

Parameters:

props -

metricSMSSuccessRate

Metric metricSMSSuccessRate()

The rate of successful SMS message deliveries.

Sum over 5 minutes