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
ITopic
.-
Nested Class Summary
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.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.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.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
-
Method Summary
Modifier and TypeMethodDescriptiondefault 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 Boolean
Enables content-based deduplication for FIFO topics.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
The ARN of the topic.default String
The name of the topic.default Grant
grantPublish
(IGrantable identity) Grant topic publishing permissions to the given identity.default Grant
grantSubscribe
(IGrantable identity) Grant topic subscribing permissions to the given identity.default Metric
metric
(String metricName, MetricOptions props) Return the given named metric for this Topic.default Metric
The number of messages published to your Amazon SNS topics.default Metric
The number of messages successfully delivered from your Amazon SNS topics to subscribing endpoints.default Metric
The number of messages that Amazon SNS failed to deliver.default Metric
The number of messages that were rejected by subscription filter policies.default Metric
The number of messages that were rejected by subscription filter policies because the messages' attributes are invalid.default Metric
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
The charges you have accrued since the start of the current calendar month for sending SMS messages.default Metric
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 Details
-
getNode
@Stability(Stable) @NotNull default software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
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 interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getContentBasedDeduplication
Enables content-based deduplication for FIFO topics.- Specified by:
getContentBasedDeduplication
in interfaceITopic
-
getFifo
Whether this topic is an Amazon SNS FIFO queue.If false, this is a standard topic.
-
getTopicArn
The ARN of the topic.- Specified by:
getTopicArn
in interfaceITopic
-
getTopicName
The name of the topic.- Specified by:
getTopicName
in interfaceITopic
-
applyRemovalPolicy
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 interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
bindAsNotificationRuleTarget
@Stability(Stable) @NotNull default NotificationRuleTargetConfig bindAsNotificationRuleTarget(@NotNull software.constructs.Construct scope) Returns a target configuration for notification rule.- Specified by:
bindAsNotificationRuleTarget
in interfaceINotificationRuleTarget
- Specified by:
bindAsNotificationRuleTarget
in interfaceINotificationRuleTarget.Jsii$Default
- Parameters:
scope
- This parameter is required.
-
addSubscription
@Stability(Stable) @NotNull default Subscription addSubscription(@NotNull ITopicSubscription subscription) Subscribe some endpoint to this topic.- Specified by:
addSubscription
in interfaceITopic
- Parameters:
subscription
- This parameter is required.
-
addToResourcePolicy
@Stability(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 toaddToResourcePolicy
. If the topic is imported (Topic.import
), then this is a no-op.- Specified by:
addToResourcePolicy
in interfaceITopic
- Parameters:
statement
- This parameter is required.
-
grantPublish
Grant topic publishing permissions to the given identity.- Specified by:
grantPublish
in interfaceITopic
- Parameters:
identity
- This parameter is required.
-
grantSubscribe
Grant topic subscribing permissions to the given identity.- Specified by:
grantSubscribe
in interfaceITopic
- Parameters:
identity
- This parameter is required.
-
metric
@Stability(Stable) @NotNull default Metric metric(@NotNull String metricName, @Nullable MetricOptions props) Return the given named metric for this Topic. -
metricNumberOfMessagesPublished
@Stability(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 interfaceITopic
- Parameters:
props
-
-
metricNumberOfNotificationsDelivered
@Stability(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 interfaceITopic
- Parameters:
props
-
-
metricNumberOfNotificationsFailed
@Stability(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 interfaceITopic
- Parameters:
props
-
-
metricNumberOfNotificationsFilteredOut
@Stability(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 interfaceITopic
- Parameters:
props
-
-
metricNumberOfNotificationsFilteredOutInvalidAttributes
@Stability(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 interfaceITopic
- Parameters:
props
-
-
metricNumberOfNotificationsFilteredOutNoMessageAttributes
@Stability(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 interfaceITopic
- Parameters:
props
-
-
metricPublishSize
Metric for the size of messages published through this topic.Average over 5 minutes
- Specified by:
metricPublishSize
in interfaceITopic
- Parameters:
props
-
-
metricSMSMonthToDateSpentUSD
@Stability(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 interfaceITopic
- Parameters:
props
-
-
metricSMSSuccessRate
The rate of successful SMS message deliveries.Sum over 5 minutes
- Specified by:
metricSMSSuccessRate
in interfaceITopic
- Parameters:
props
-
-