@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:42.082Z") public interface ITopic extends IResource, INotificationRuleTarget
Modifier and Type | Interface and Description |
---|---|
static interface |
ITopic.Jsii$Default
Internal default implementation for
ITopic . |
static class |
ITopic.Jsii$Proxy
A proxy class which represents a concrete javascript instance of this type.
|
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.
|
java.lang.Boolean |
getFifo()
Whether this topic is an Amazon SNS FIFO queue.
|
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.
|
applyRemovalPolicy, getEnv, getStack
getNode
bindAsNotificationRuleTarget
java.lang.Boolean getFifo()
If false, this is a standard topic.
java.lang.String getTopicArn()
java.lang.String getTopicName()
void addSubscription(ITopicSubscription subscription)
subscription
- This parameter is required.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.
statement
- This parameter is required.Grant grantPublish(IGrantable identity)
identity
- This parameter is required.Metric metric(java.lang.String metricName, MetricOptions props)
metricName
- This parameter is required.props
- Metric metric(java.lang.String metricName)
metricName
- This parameter is required.Metric metricNumberOfMessagesPublished(MetricOptions props)
Sum over 5 minutes
props
- Metric metricNumberOfMessagesPublished()
Sum over 5 minutes
Metric metricNumberOfNotificationsDelivered(MetricOptions props)
Sum over 5 minutes
props
- Metric metricNumberOfNotificationsDelivered()
Sum over 5 minutes
Metric metricNumberOfNotificationsFailed(MetricOptions props)
Sum over 5 minutes
props
- Metric metricNumberOfNotificationsFailed()
Sum over 5 minutes
Metric metricNumberOfNotificationsFilteredOut(MetricOptions props)
Sum over 5 minutes
props
- Metric metricNumberOfNotificationsFilteredOut()
Sum over 5 minutes
Metric metricNumberOfNotificationsFilteredOutInvalidAttributes(MetricOptions props)
Sum over 5 minutes
props
- Metric metricNumberOfNotificationsFilteredOutInvalidAttributes()
Sum over 5 minutes
Metric metricNumberOfNotificationsFilteredOutNoMessageAttributes(MetricOptions props)
Sum over 5 minutes
props
- Metric metricNumberOfNotificationsFilteredOutNoMessageAttributes()
Sum over 5 minutes
Metric metricPublishSize(MetricOptions props)
Average over 5 minutes
props
- Metric metricPublishSize()
Average over 5 minutes
Metric metricSMSMonthToDateSpentUSD(MetricOptions props)
Maximum over 5 minutes
props
- Metric metricSMSMonthToDateSpentUSD()
Maximum over 5 minutes
Metric metricSMSSuccessRate(MetricOptions props)
Sum over 5 minutes
props
- Metric metricSMSSuccessRate()
Sum over 5 minutes