software.amazon.awscdk.services.sns

Class ITopic.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.sns.ITopic.Jsii$Proxy

All Implemented Interfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, INotificationRuleTarget, INotificationRuleTarget.Jsii$Default, ITopic, ITopic.Jsii$Default

Enclosing interface:

ITopic

public static final class ITopic.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements ITopic.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

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

ITopic.Jsii$Default, ITopic.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

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.
void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
NotificationRuleTargetConfig	bindAsNotificationRuleTarget(software.constructs.Construct scope) Returns a target configuration for notification rule.
ResourceEnvironment	getEnv() The environment this resource belongs to.
java.lang.Boolean	getFifo() Whether this topic is an Amazon SNS FIFO queue.
ConstructNode	getNode() The construct tree node for this construct.
Stack	getStack() The stack in which this resource is defined.
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Detail

getNode

public final ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface ITopic.Jsii$Default

getEnv

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

Specified by:

getEnv in interface ITopic.Jsii$Default

getStack

public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface ITopic.Jsii$Default

getFifo

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

Specified by:

getFifo in interface ITopic.Jsii$Default

getTopicArn

public final java.lang.String getTopicArn()

The ARN of the topic.

Specified by:

getTopicArn in interface ITopic

Specified by:

getTopicArn in interface ITopic.Jsii$Default

getTopicName

public final java.lang.String getTopicName()

The name of the topic.

Specified by:

getTopicName in interface ITopic

Specified by:

getTopicName in interface ITopic.Jsii$Default

applyRemovalPolicy

public final void applyRemovalPolicy(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

Specified by:

applyRemovalPolicy in interface ITopic.Jsii$Default

Parameters:

policy - This parameter is required.

bindAsNotificationRuleTarget

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

Specified by:

bindAsNotificationRuleTarget in interface ITopic.Jsii$Default

Parameters:

scope - This parameter is required.

addSubscription

public final void addSubscription(ITopicSubscription subscription)

Subscribe some endpoint to this topic.

Specified by:

addSubscription in interface ITopic

Specified by:

addSubscription in interface ITopic.Jsii$Default

Parameters:

subscription - This parameter is required.

addToResourcePolicy

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

Specified by:

addToResourcePolicy in interface ITopic.Jsii$Default

Parameters:

statement - This parameter is required.

grantPublish

public final Grant grantPublish(IGrantable identity)

Grant topic publishing permissions to the given identity.

Specified by:

grantPublish in interface ITopic

Specified by:

grantPublish in interface ITopic.Jsii$Default

Parameters:

identity - This parameter is required.

metric

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

Return the given named metric for this Topic.

Specified by:

metric in interface ITopic

Specified by:

metric in interface ITopic.Jsii$Default

Parameters:

metricName - This parameter is required.

props -

metric

public final 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 final Metric metricNumberOfMessagesPublished(MetricOptions props)

The number of messages published to your Amazon SNS topics.

Sum over 5 minutes

Specified by:

metricNumberOfMessagesPublished in interface ITopic

Specified by:

metricNumberOfMessagesPublished in interface ITopic.Jsii$Default

Parameters:

props -

metricNumberOfMessagesPublished

public final Metric metricNumberOfMessagesPublished()

The number of messages published to your Amazon SNS topics.

Sum over 5 minutes

Specified by:

metricNumberOfMessagesPublished in interface ITopic

metricNumberOfNotificationsDelivered

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

Specified by:

metricNumberOfNotificationsDelivered in interface ITopic.Jsii$Default

Parameters:

props -

metricNumberOfNotificationsDelivered

public final 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 final Metric metricNumberOfNotificationsFailed(MetricOptions props)

The number of messages that Amazon SNS failed to deliver.

Sum over 5 minutes

Specified by:

metricNumberOfNotificationsFailed in interface ITopic

Specified by:

metricNumberOfNotificationsFailed in interface ITopic.Jsii$Default

Parameters:

props -

metricNumberOfNotificationsFailed

public final Metric metricNumberOfNotificationsFailed()

The number of messages that Amazon SNS failed to deliver.

Sum over 5 minutes

Specified by:

metricNumberOfNotificationsFailed in interface ITopic

metricNumberOfNotificationsFilteredOut

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

Specified by:

metricNumberOfNotificationsFilteredOut in interface ITopic.Jsii$Default

Parameters:

props -

metricNumberOfNotificationsFilteredOut

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

Specified by:

metricNumberOfNotificationsFilteredOutInvalidAttributes in interface ITopic.Jsii$Default

Parameters:

props -

metricNumberOfNotificationsFilteredOutInvalidAttributes

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

Specified by:

metricNumberOfNotificationsFilteredOutNoMessageAttributes in interface ITopic.Jsii$Default

Parameters:

props -

metricNumberOfNotificationsFilteredOutNoMessageAttributes

public final 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 final Metric metricPublishSize(MetricOptions props)

Metric for the size of messages published through this topic.

Average over 5 minutes

Specified by:

metricPublishSize in interface ITopic

Specified by:

metricPublishSize in interface ITopic.Jsii$Default

Parameters:

props -

metricPublishSize

public final Metric metricPublishSize()

Metric for the size of messages published through this topic.

Average over 5 minutes

Specified by:

metricPublishSize in interface ITopic

metricSMSMonthToDateSpentUSD

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

Specified by:

metricSMSMonthToDateSpentUSD in interface ITopic.Jsii$Default

Parameters:

props -

metricSMSMonthToDateSpentUSD

public final 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 final Metric metricSMSSuccessRate(MetricOptions props)

The rate of successful SMS message deliveries.

Sum over 5 minutes

Specified by:

metricSMSSuccessRate in interface ITopic

Specified by:

metricSMSSuccessRate in interface ITopic.Jsii$Default

Parameters:

props -

metricSMSSuccessRate

public final Metric metricSMSSuccessRate()

The rate of successful SMS message deliveries.

Sum over 5 minutes

Specified by:

metricSMSSuccessRate in interface ITopic