class TopicBase

Language	Type name
Python	aws_cdk.aws_sns.TopicBase
Java	software.amazon.awscdk.services.sns.TopicBase
.NET	Amazon.CDK.AWS.SNS.TopicBase
TypeScript (source)	@aws-cdk/aws-sns.TopicBase

Implements IConstruct, IResource, ITopic

Extends Resource

Implemented by Topic

Either a new or imported Topic.

Initializer

new TopicBase(scope: Construct, id: string, props?: ResourceProps)

Parameters

• scope Construct
• id string
• props ResourceProps

Properties

Name	Type	Description
autoCreatePolicy	boolean	Controls automatic creation of policy objects.
node	ConstructNode	Construct tree node which offers APIs for interacting with the construct tree.
stack	Stack	The stack in which this resource is defined.
topicArn	string
topicName	string

---

autoCreatePolicy

Type: boolean

Controls automatic creation of policy objects.

Set by subclasses.

---

node

Type: ConstructNode

Construct tree node which offers APIs for interacting with the construct tree.

---

stack

Type: Stack

The stack in which this resource is defined.

---

topicArn

Type: string

---

topicName

Type: string

Methods

Name	Description
addSubscription(subscription)	Subscribe some endpoint to this topic.
addToResourcePolicy(statement)	Adds a statement to the IAM resource policy associated with this topic.
grantPublish(grantee)	Grant topic publishing permissions to the given identity.
metric(metricName, props?)	Return the given named metric for this Topic.
metricNumberOfMessagesPublished(props?)	The number of messages published to your Amazon SNS topics.
metricNumberOfNotificationsDelivered(props?)	The number of messages successfully delivered from your Amazon SNS topics to subscribing endpoints.
metricNumberOfNotificationsFailed(props?)	The number of messages that Amazon SNS failed to deliver.
metricNumberOfNotificationsFilteredOut(props?)	The number of messages that were rejected by subscription filter policies.
metricNumberOfNotificationsFilteredOutInvalidAttributes(props?)	The number of messages that were rejected by subscription filter policies because the messages' attributes are invalid.
metricNumberOfNotificationsFilteredOutNoMessageAttributes(props?)	The number of messages that were rejected by subscription filter policies because the messages have no attributes.
metricPublishSize(props?)	Metric for the size of messages published through this topic.
metricSMSMonthToDateSpentUSD(props?)	The charges you have accrued since the start of the current calendar month for sending SMS messages.
metricSMSSuccessRate(props?)	The rate of successful SMS message deliveries.
toString()	Returns a string representation of this construct.

---

addSubscription(subscription)

public addSubscription(subscription: ITopicSubscription): void

Parameters

• subscription ITopicSubscription

Subscribe some endpoint to this topic.

---

addToResourcePolicy(statement)

public addToResourcePolicy(statement: PolicyStatement): void

Parameters

• statement PolicyStatement

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 improted (Topic.import), then this is a no-op.

---

grantPublish(grantee)

public grantPublish(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grant topic publishing permissions to the given identity.

---

metric(metricName, props?)

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

• metricName string
• props MetricOptions

Returns

• Metric

Return the given named metric for this Topic.

---

metricNumberOfMessagesPublished(props?)

public metricNumberOfMessagesPublished(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

The number of messages published to your Amazon SNS topics.

Sum over 5 minutes

---

metricNumberOfNotificationsDelivered(props?)

public metricNumberOfNotificationsDelivered(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

Sum over 5 minutes

---

metricNumberOfNotificationsFailed(props?)

public metricNumberOfNotificationsFailed(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

The number of messages that Amazon SNS failed to deliver.

Sum over 5 minutes

---

metricNumberOfNotificationsFilteredOut(props?)

public metricNumberOfNotificationsFilteredOut(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

Sum over 5 minutes

---

metricNumberOfNotificationsFilteredOutInvalidAttributes(props?)

public metricNumberOfNotificationsFilteredOutInvalidAttributes(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

Sum over 5 minutes

---

metricNumberOfNotificationsFilteredOutNoMessageAttributes(props?)

public metricNumberOfNotificationsFilteredOutNoMessageAttributes(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

Sum over 5 minutes

---

metricPublishSize(props?)

public metricPublishSize(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Metric for the size of messages published through this topic.

Average over 5 minutes

---

metricSMSMonthToDateSpentUSD(props?)

public metricSMSMonthToDateSpentUSD(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

Maximum over 5 minutes

---

metricSMSSuccessRate(props?)

public metricSMSSuccessRate(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

The rate of successful SMS message deliveries.

Sum over 5 minutes

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.