software.amazon.awscdk.services.sns

Interface ITopic.Jsii$Default

All Superinterfaces:

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

All Known Implementing Classes:

ITopic.Jsii$Proxy

Enclosing interface:

ITopic

@Internal
public static interface ITopic.Jsii$Default
extends ITopic, IResource.Jsii$Default, INotificationRuleTarget.Jsii$Default

Internal default implementation for ITopic.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.sns.ITopic

ITopic.Jsii$Default, ITopic.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default Subscription	addSubscription(ITopicSubscription subscription) Subscribe some endpoint to this topic.
default AddToResourcePolicyResult	addToResourcePolicy(PolicyStatement statement) Adds a statement to the IAM resource policy associated with this topic.
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default NotificationRuleTargetConfig	bindAsNotificationRuleTarget(software.constructs.Construct scope) Returns a target configuration for notification rule.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default Boolean	getFifo() Whether this topic is an Amazon SNS FIFO queue.
default software.constructs.Node	getNode() The tree node.
default Stack	getStack() The stack in which this resource is defined.
default String	getTopicArn() The ARN of the topic.
default String	getTopicName() The name of the topic.
default Grant	grantPublish(IGrantable identity) Grant topic publishing permissions to the given identity.
default Metric	metric(String metricName, MetricOptions props) Return the given named metric for this Topic.
default Metric	metricNumberOfMessagesPublished(MetricOptions props) The number of messages published to your Amazon SNS topics.
default Metric	metricNumberOfNotificationsDelivered(MetricOptions props) The number of messages successfully delivered from your Amazon SNS topics to subscribing endpoints.
default Metric	metricNumberOfNotificationsFailed(MetricOptions props) The number of messages that Amazon SNS failed to deliver.
default Metric	metricNumberOfNotificationsFilteredOut(MetricOptions props) The number of messages that were rejected by subscription filter policies.
default Metric	metricNumberOfNotificationsFilteredOutInvalidAttributes(MetricOptions props) The number of messages that were rejected by subscription filter policies because the messages' attributes are invalid.
default Metric	metricNumberOfNotificationsFilteredOutNoMessageAttributes(MetricOptions props) The number of messages that were rejected by subscription filter policies because the messages have no attributes.
default Metric	metricPublishSize(MetricOptions props) Metric for the size of messages published through this topic.
default Metric	metricSMSMonthToDateSpentUSD(MetricOptions props) The charges you have accrued since the start of the current calendar month for sending SMS messages.
default Metric	metricSMSSuccessRate(MetricOptions props) The rate of successful SMS message deliveries.

Methods inherited from interface software.amazon.awscdk.services.sns.ITopic

metric, metricNumberOfMessagesPublished, metricNumberOfNotificationsDelivered, metricNumberOfNotificationsFailed, metricNumberOfNotificationsFilteredOut, metricNumberOfNotificationsFilteredOutInvalidAttributes, metricNumberOfNotificationsFilteredOutNoMessageAttributes, metricPublishSize, metricSMSMonthToDateSpentUSD, metricSMSSuccessRate

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Stable)
 @NotNull
default ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getFifo

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

The ARN of the topic.

Specified by:

getTopicArn in interface ITopic

getTopicName

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

The name of the topic.

Specified by:

getTopicName in interface ITopic

applyRemovalPolicy

@Stability(value=Stable)
default void applyRemovalPolicy(@NotNull
                                                         RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

bindAsNotificationRuleTarget

@Stability(value=Stable)
 @NotNull
default NotificationRuleTargetConfig bindAsNotificationRuleTarget(@NotNull
                                                                                                     software.constructs.Construct scope)

Returns a target configuration for notification rule.

Specified by:

bindAsNotificationRuleTarget in interface INotificationRuleTarget

Specified by:

bindAsNotificationRuleTarget in interface INotificationRuleTarget.Jsii$Default

Parameters:

scope - This parameter is required.

addSubscription

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

grantPublish

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

Grant topic publishing permissions to the given identity.

Specified by:

grantPublish in interface ITopic

Parameters:

identity - This parameter is required.

metric

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

metricNumberOfMessagesPublished

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

metricNumberOfNotificationsDelivered

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

metricNumberOfNotificationsFailed

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

metricNumberOfNotificationsFilteredOut

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

metricNumberOfNotificationsFilteredOutInvalidAttributes

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

metricNumberOfNotificationsFilteredOutNoMessageAttributes

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

metricPublishSize

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

metricSMSMonthToDateSpentUSD

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

metricSMSSuccessRate

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

The rate of successful SMS message deliveries.

Sum over 5 minutes

Specified by:

metricSMSSuccessRate in interface ITopic

Parameters:

props -