public static final class ITopic.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements ITopic.Jsii$Default
ITopic.Jsii$Default, ITopic.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) |
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.
|
public final ConstructNode getNode()
getNode
in interface IConstruct
getNode
in interface IConstruct.Jsii$Default
getNode
in interface IResource.Jsii$Default
getNode
in interface ITopic.Jsii$Default
public final ResourceEnvironment getEnv()
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.
getEnv
in interface IResource
getEnv
in interface IResource.Jsii$Default
getEnv
in interface ITopic.Jsii$Default
public final Stack getStack()
getStack
in interface IResource
getStack
in interface IResource.Jsii$Default
getStack
in interface ITopic.Jsii$Default
public final java.lang.Boolean getFifo()
If false, this is a standard topic.
getFifo
in interface ITopic
getFifo
in interface ITopic.Jsii$Default
public final java.lang.String getTopicArn()
getTopicArn
in interface ITopic
getTopicArn
in interface ITopic.Jsii$Default
public final java.lang.String getTopicName()
getTopicName
in interface ITopic
getTopicName
in interface ITopic.Jsii$Default
public final void applyRemovalPolicy(RemovalPolicy policy)
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
).
applyRemovalPolicy
in interface IResource
applyRemovalPolicy
in interface IResource.Jsii$Default
applyRemovalPolicy
in interface ITopic.Jsii$Default
policy
- This parameter is required.public final NotificationRuleTargetConfig bindAsNotificationRuleTarget(software.constructs.Construct scope)
bindAsNotificationRuleTarget
in interface INotificationRuleTarget
bindAsNotificationRuleTarget
in interface INotificationRuleTarget.Jsii$Default
bindAsNotificationRuleTarget
in interface ITopic.Jsii$Default
scope
- This parameter is required.public final void addSubscription(ITopicSubscription subscription)
addSubscription
in interface ITopic
addSubscription
in interface ITopic.Jsii$Default
subscription
- This parameter is required.public final AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement)
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.
addToResourcePolicy
in interface ITopic
addToResourcePolicy
in interface ITopic.Jsii$Default
statement
- This parameter is required.public final Grant grantPublish(IGrantable identity)
grantPublish
in interface ITopic
grantPublish
in interface ITopic.Jsii$Default
identity
- This parameter is required.public final Metric metric(java.lang.String metricName, MetricOptions props)
metric
in interface ITopic
metric
in interface ITopic.Jsii$Default
metricName
- This parameter is required.props
- public final Metric metric(java.lang.String metricName)
public final Metric metricNumberOfMessagesPublished(MetricOptions props)
Sum over 5 minutes
metricNumberOfMessagesPublished
in interface ITopic
metricNumberOfMessagesPublished
in interface ITopic.Jsii$Default
props
- public final Metric metricNumberOfMessagesPublished()
Sum over 5 minutes
metricNumberOfMessagesPublished
in interface ITopic
public final Metric metricNumberOfNotificationsDelivered(MetricOptions props)
Sum over 5 minutes
metricNumberOfNotificationsDelivered
in interface ITopic
metricNumberOfNotificationsDelivered
in interface ITopic.Jsii$Default
props
- public final Metric metricNumberOfNotificationsDelivered()
Sum over 5 minutes
metricNumberOfNotificationsDelivered
in interface ITopic
public final Metric metricNumberOfNotificationsFailed(MetricOptions props)
Sum over 5 minutes
metricNumberOfNotificationsFailed
in interface ITopic
metricNumberOfNotificationsFailed
in interface ITopic.Jsii$Default
props
- public final Metric metricNumberOfNotificationsFailed()
Sum over 5 minutes
metricNumberOfNotificationsFailed
in interface ITopic
public final Metric metricNumberOfNotificationsFilteredOut(MetricOptions props)
Sum over 5 minutes
metricNumberOfNotificationsFilteredOut
in interface ITopic
metricNumberOfNotificationsFilteredOut
in interface ITopic.Jsii$Default
props
- public final Metric metricNumberOfNotificationsFilteredOut()
Sum over 5 minutes
metricNumberOfNotificationsFilteredOut
in interface ITopic
public final Metric metricNumberOfNotificationsFilteredOutInvalidAttributes(MetricOptions props)
Sum over 5 minutes
metricNumberOfNotificationsFilteredOutInvalidAttributes
in interface ITopic
metricNumberOfNotificationsFilteredOutInvalidAttributes
in interface ITopic.Jsii$Default
props
- public final Metric metricNumberOfNotificationsFilteredOutInvalidAttributes()
Sum over 5 minutes
metricNumberOfNotificationsFilteredOutInvalidAttributes
in interface ITopic
public final Metric metricNumberOfNotificationsFilteredOutNoMessageAttributes(MetricOptions props)
Sum over 5 minutes
metricNumberOfNotificationsFilteredOutNoMessageAttributes
in interface ITopic
metricNumberOfNotificationsFilteredOutNoMessageAttributes
in interface ITopic.Jsii$Default
props
- public final Metric metricNumberOfNotificationsFilteredOutNoMessageAttributes()
Sum over 5 minutes
metricNumberOfNotificationsFilteredOutNoMessageAttributes
in interface ITopic
public final Metric metricPublishSize(MetricOptions props)
Average over 5 minutes
metricPublishSize
in interface ITopic
metricPublishSize
in interface ITopic.Jsii$Default
props
- public final Metric metricPublishSize()
Average over 5 minutes
metricPublishSize
in interface ITopic
public final Metric metricSMSMonthToDateSpentUSD(MetricOptions props)
Maximum over 5 minutes
metricSMSMonthToDateSpentUSD
in interface ITopic
metricSMSMonthToDateSpentUSD
in interface ITopic.Jsii$Default
props
- public final Metric metricSMSMonthToDateSpentUSD()
Maximum over 5 minutes
metricSMSMonthToDateSpentUSD
in interface ITopic
public final Metric metricSMSSuccessRate(MetricOptions props)
Sum over 5 minutes
metricSMSSuccessRate
in interface ITopic
metricSMSSuccessRate
in interface ITopic.Jsii$Default
props
- public final Metric metricSMSSuccessRate()
Sum over 5 minutes
metricSMSSuccessRate
in interface ITopic