software.amazon.awscdk.services.sns

Class TopicBase

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.sns.TopicBase

All Implemented Interfaces:

IConstruct, IDependable, IResource, INotificationRuleTarget, ITopic

Direct Known Subclasses:

Topic

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:52.438Z")
public abstract class TopicBase
extends Resource
implements ITopic

Either a new or imported Topic.

Nested Class Summary

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.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TopicBase(software.amazon.jsii.JsiiObjectRef objRef)
protected	TopicBase(software.constructs.Construct scope, java.lang.String id)
protected	TopicBase(software.constructs.Construct scope, java.lang.String id, ResourceProps props)

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.
NotificationRuleTargetConfig	bindAsNotificationRuleTarget(software.constructs.Construct _scope) Represents a notification target That allows SNS topic to associate with this rule target.
protected abstract java.lang.Boolean	getAutoCreatePolicy() Controls automatic creation of policy objects.
abstract java.lang.Boolean	getFifo() Whether this topic is an Amazon SNS FIFO queue.
abstract java.lang.String	getTopicArn() The ARN of the topic.
abstract java.lang.String	getTopicName() The name of the topic.
Grant	grantPublish(IGrantable grantee) 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.
protected java.util.List<java.lang.String>	validate() Validate the current construct.

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

TopicBase

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

TopicBase

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

TopicBase

protected TopicBase(software.constructs.Construct scope,
                    java.lang.String id,
                    ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

TopicBase

protected TopicBase(software.constructs.Construct scope,
                    java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addSubscription

public void addSubscription(ITopicSubscription subscription)

Subscribe some endpoint to this topic.

Specified by:

addSubscription in interface ITopic

Parameters:

subscription - This parameter is required.

addToResourcePolicy

public 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.

Specified by:

addToResourcePolicy in interface ITopic

Parameters:

statement - This parameter is required.

bindAsNotificationRuleTarget

public NotificationRuleTargetConfig bindAsNotificationRuleTarget(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

public Grant grantPublish(IGrantable grantee)

Grant topic publishing permissions to the given identity.

Specified by:

grantPublish in interface ITopic

Parameters:

grantee - This parameter is required.

metric

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

Return the given named metric for this Topic.

Specified by:

metric in interface ITopic

Parameters:

metricName - This parameter is required.

props -

metric

public Metric metric(java.lang.String metricName)

Return the given named metric for this Topic.

Specified by:

metric in interface ITopic

Parameters:

metricName - This parameter is required.

metricNumberOfMessagesPublished

public Metric metricNumberOfMessagesPublished(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

public Metric metricNumberOfMessagesPublished()

The number of messages published to your Amazon SNS topics.

Sum over 5 minutes

Specified by:

metricNumberOfMessagesPublished in interface ITopic

metricNumberOfNotificationsDelivered

public Metric metricNumberOfNotificationsDelivered(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

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

public Metric metricNumberOfNotificationsFailed(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

public Metric metricNumberOfNotificationsFailed()

The number of messages that Amazon SNS failed to deliver.

Sum over 5 minutes

Specified by:

metricNumberOfNotificationsFailed in interface ITopic

metricNumberOfNotificationsFilteredOut

public Metric metricNumberOfNotificationsFilteredOut(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

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

public 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

Specified by:

metricNumberOfNotificationsFilteredOutInvalidAttributes in interface ITopic

Parameters:

props -

metricNumberOfNotificationsFilteredOutInvalidAttributes

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

public 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

Specified by:

metricNumberOfNotificationsFilteredOutNoMessageAttributes in interface ITopic

Parameters:

props -

metricNumberOfNotificationsFilteredOutNoMessageAttributes

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

public Metric metricPublishSize(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

public Metric metricPublishSize()

Metric for the size of messages published through this topic.

Average over 5 minutes

Specified by:

metricPublishSize in interface ITopic

metricSMSMonthToDateSpentUSD

public 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

Specified by:

metricSMSMonthToDateSpentUSD in interface ITopic

Parameters:

props -

metricSMSMonthToDateSpentUSD

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

public Metric metricSMSSuccessRate(MetricOptions props)

The rate of successful SMS message deliveries.

Sum over 5 minutes

Specified by:

metricSMSSuccessRate in interface ITopic

Parameters:

props -

metricSMSSuccessRate

public Metric metricSMSSuccessRate()

The rate of successful SMS message deliveries.

Sum over 5 minutes

Specified by:

metricSMSSuccessRate in interface ITopic

validate

protected java.util.List<java.lang.String> validate()

Validate the current construct.

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

Overrides:

validate in class Construct

Returns:

An array of validation error messages, or an empty array if the construct is valid.

getAutoCreatePolicy

protected abstract java.lang.Boolean getAutoCreatePolicy()

Controls automatic creation of policy objects.

Set by subclasses.

getFifo

public abstract 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

getTopicArn

public abstract java.lang.String getTopicArn()

The ARN of the topic.

Specified by:

getTopicArn in interface ITopic

getTopicName

public abstract java.lang.String getTopicName()

The name of the topic.

Specified by:

getTopicName in interface ITopic