Package 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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default

Enclosing interface:

ITopic

@Internal
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IDependable

IDependable.Jsii$Default, IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codestarnotifications.INotificationRuleTarget

INotificationRuleTarget.Jsii$Default, INotificationRuleTarget.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

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

ITopic.Jsii$Default, ITopic.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Jsii$Proxy

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

Method Details

getNode

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

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

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

@Stability(Stable)
@NotNull
public final 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

@Stability(Stable)
@NotNull
public final String getTopicArn()

The ARN of the topic.

Specified by:

getTopicArn in interface ITopic

Specified by:

getTopicArn in interface ITopic.Jsii$Default

getTopicName

@Stability(Stable)
@NotNull
public final String getTopicName()

The name of the topic.

Specified by:

getTopicName in interface ITopic

Specified by:

getTopicName in interface ITopic.Jsii$Default

applyRemovalPolicy

@Stability(Stable)
public final 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

Specified by:

applyRemovalPolicy in interface ITopic.Jsii$Default

Parameters:

policy - This parameter is required.

bindAsNotificationRuleTarget

@Stability(Stable)
@NotNull
public final 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

Specified by:

bindAsNotificationRuleTarget in interface ITopic.Jsii$Default

Parameters:

scope - This parameter is required.

addSubscription

@Stability(Stable)
public final void addSubscription(@NotNull
 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

@Stability(Stable)
@NotNull
public final 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

Specified by:

addToResourcePolicy in interface ITopic.Jsii$Default

Parameters:

statement - This parameter is required.

grantPublish

@Stability(Stable)
@NotNull
public final Grant grantPublish(@NotNull
 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

@Stability(Stable)
@NotNull
public final Metric metric(@NotNull
 String metricName,
 @Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metric(@NotNull
 String metricName)

Return the given named metric for this Topic.

Specified by:

metric in interface ITopic

Parameters:

metricName - This parameter is required.

metricNumberOfMessagesPublished

@Stability(Stable)
@NotNull
public final 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

Specified by:

metricNumberOfMessagesPublished in interface ITopic.Jsii$Default

Parameters:

props -

metricNumberOfMessagesPublished

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

@Stability(Stable)
@NotNull
public final 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

Specified by:

metricNumberOfNotificationsDelivered in interface ITopic.Jsii$Default

Parameters:

props -

metricNumberOfNotificationsDelivered

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

@Stability(Stable)
@NotNull
public final 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

Specified by:

metricNumberOfNotificationsFailed in interface ITopic.Jsii$Default

Parameters:

props -

metricNumberOfNotificationsFailed

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

@Stability(Stable)
@NotNull
public final 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

Specified by:

metricNumberOfNotificationsFilteredOut in interface ITopic.Jsii$Default

Parameters:

props -

metricNumberOfNotificationsFilteredOut

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

@Stability(Stable)
@NotNull
public final 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

Specified by:

metricNumberOfNotificationsFilteredOutInvalidAttributes in interface ITopic.Jsii$Default

Parameters:

props -

metricNumberOfNotificationsFilteredOutInvalidAttributes

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

@Stability(Stable)
@NotNull
public final 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

Specified by:

metricNumberOfNotificationsFilteredOutNoMessageAttributes in interface ITopic.Jsii$Default

Parameters:

props -

metricNumberOfNotificationsFilteredOutNoMessageAttributes

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

@Stability(Stable)
@NotNull
public final 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

Specified by:

metricPublishSize in interface ITopic.Jsii$Default

Parameters:

props -

metricPublishSize

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

@Stability(Stable)
@NotNull
public final 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

Specified by:

metricSMSMonthToDateSpentUSD in interface ITopic.Jsii$Default

Parameters:

props -

metricSMSMonthToDateSpentUSD

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

@Stability(Stable)
@NotNull
public final Metric metricSMSSuccessRate(@Nullable
 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

@Stability(Stable)
@NotNull
public final Metric metricSMSSuccessRate()

The rate of successful SMS message deliveries.

Sum over 5 minutes

Specified by:

metricSMSSuccessRate in interface ITopic