ITopic¶

class
aws_cdk.aws_sns.
ITopic
(*args, **kwargs)¶ Bases:
aws_cdk.core.IResource
,typing_extensions.Protocol

__init__
(*args, **kwargs)¶
Methods

add_subscription
(subscription)¶ Subscribe some endpoint to this topic.
 Parameters
subscription (
ITopicSubscription
) – Return type
None

add_to_resource_policy
(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 toaddToPolicy
. If the topic is improted (Topic.import
), then this is a noop. Parameters
statement (
PolicyStatement
) – Return type
None

grant_publish
(identity)¶ Grant topic publishing permissions to the given identity.
 Parameters
identity (
IGrantable
) – Return type

metric
(metric_name, *, color=None, dimensions=None, label=None, period=None, statistic=None, unit=None)¶ Return the given named metric for this Topic.
 Parameters
metric_name (
str
) –props –
color (
Optional
[str
]) – Color for this metric when added to a Graph in a Dashboard.dimensions (
Optional
[Mapping
[str
,Any
]]) – Dimensions of the metric. Default:  No dimensions.label (
Optional
[str
]) – Label for this metric when added to a Graph in a Dashboard.period (
Optional
[Duration
]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)statistic (
Optional
[str
]) – What function to use for aggregating. Can be one of the following:  “Minimum”  “min”  “Maximum”  “max”  “Average”  “avg”  “Sum”  “sum”  “SampleCount  “n”  “pNN.NN” Default: Averageunit (
Optional
[Unit
]) – Unit for the metric that is associated with the alarm.
 Return type

metric_number_of_messages_published
(*, color=None, dimensions=None, label=None, period=None, statistic=None, unit=None)¶ The number of messages published to your Amazon SNS topics.
Sum over 5 minutes
 Parameters
props –
color (
Optional
[str
]) – Color for this metric when added to a Graph in a Dashboard.dimensions (
Optional
[Mapping
[str
,Any
]]) – Dimensions of the metric. Default:  No dimensions.label (
Optional
[str
]) – Label for this metric when added to a Graph in a Dashboard.period (
Optional
[Duration
]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)statistic (
Optional
[str
]) – What function to use for aggregating. Can be one of the following:  “Minimum”  “min”  “Maximum”  “max”  “Average”  “avg”  “Sum”  “sum”  “SampleCount  “n”  “pNN.NN” Default: Averageunit (
Optional
[Unit
]) – Unit for the metric that is associated with the alarm.
 Return type

metric_number_of_notifications_delivered
(*, color=None, dimensions=None, label=None, period=None, statistic=None, unit=None)¶ The number of messages successfully delivered from your Amazon SNS topics to subscribing endpoints.
Sum over 5 minutes
 Parameters
props –
color (
Optional
[str
]) – Color for this metric when added to a Graph in a Dashboard.dimensions (
Optional
[Mapping
[str
,Any
]]) – Dimensions of the metric. Default:  No dimensions.label (
Optional
[str
]) – Label for this metric when added to a Graph in a Dashboard.period (
Optional
[Duration
]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)statistic (
Optional
[str
]) – What function to use for aggregating. Can be one of the following:  “Minimum”  “min”  “Maximum”  “max”  “Average”  “avg”  “Sum”  “sum”  “SampleCount  “n”  “pNN.NN” Default: Averageunit (
Optional
[Unit
]) – Unit for the metric that is associated with the alarm.
 Return type

metric_number_of_notifications_failed
(*, color=None, dimensions=None, label=None, period=None, statistic=None, unit=None)¶ The number of messages that Amazon SNS failed to deliver.
Sum over 5 minutes
 Parameters
props –
color (
Optional
[str
]) – Color for this metric when added to a Graph in a Dashboard.dimensions (
Optional
[Mapping
[str
,Any
]]) – Dimensions of the metric. Default:  No dimensions.label (
Optional
[str
]) – Label for this metric when added to a Graph in a Dashboard.period (
Optional
[Duration
]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)statistic (
Optional
[str
]) – What function to use for aggregating. Can be one of the following:  “Minimum”  “min”  “Maximum”  “max”  “Average”  “avg”  “Sum”  “sum”  “SampleCount  “n”  “pNN.NN” Default: Averageunit (
Optional
[Unit
]) – Unit for the metric that is associated with the alarm.
 Return type

metric_number_of_notifications_filtered_out
(*, color=None, dimensions=None, label=None, period=None, statistic=None, unit=None)¶ The number of messages that were rejected by subscription filter policies.
Sum over 5 minutes
 Parameters
props –
color (
Optional
[str
]) – Color for this metric when added to a Graph in a Dashboard.dimensions (
Optional
[Mapping
[str
,Any
]]) – Dimensions of the metric. Default:  No dimensions.label (
Optional
[str
]) – Label for this metric when added to a Graph in a Dashboard.period (
Optional
[Duration
]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)statistic (
Optional
[str
]) – What function to use for aggregating. Can be one of the following:  “Minimum”  “min”  “Maximum”  “max”  “Average”  “avg”  “Sum”  “sum”  “SampleCount  “n”  “pNN.NN” Default: Averageunit (
Optional
[Unit
]) – Unit for the metric that is associated with the alarm.
 Return type

metric_number_of_notifications_filtered_out_invalid_attributes
(*, color=None, dimensions=None, label=None, period=None, statistic=None, unit=None)¶ The number of messages that were rejected by subscription filter policies because the messages’ attributes are invalid.
Sum over 5 minutes
 Parameters
props –
color (
Optional
[str
]) – Color for this metric when added to a Graph in a Dashboard.dimensions (
Optional
[Mapping
[str
,Any
]]) – Dimensions of the metric. Default:  No dimensions.label (
Optional
[str
]) – Label for this metric when added to a Graph in a Dashboard.period (
Optional
[Duration
]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)statistic (
Optional
[str
]) – What function to use for aggregating. Can be one of the following:  “Minimum”  “min”  “Maximum”  “max”  “Average”  “avg”  “Sum”  “sum”  “SampleCount  “n”  “pNN.NN” Default: Averageunit (
Optional
[Unit
]) – Unit for the metric that is associated with the alarm.
 Return type

metric_number_of_notifications_filtered_out_no_message_attributes
(*, color=None, dimensions=None, label=None, period=None, statistic=None, unit=None)¶ The number of messages that were rejected by subscription filter policies because the messages have no attributes.
Sum over 5 minutes
 Parameters
props –
color (
Optional
[str
]) – Color for this metric when added to a Graph in a Dashboard.dimensions (
Optional
[Mapping
[str
,Any
]]) – Dimensions of the metric. Default:  No dimensions.label (
Optional
[str
]) – Label for this metric when added to a Graph in a Dashboard.period (
Optional
[Duration
]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)statistic (
Optional
[str
]) – What function to use for aggregating. Can be one of the following:  “Minimum”  “min”  “Maximum”  “max”  “Average”  “avg”  “Sum”  “sum”  “SampleCount  “n”  “pNN.NN” Default: Averageunit (
Optional
[Unit
]) – Unit for the metric that is associated with the alarm.
 Return type

metric_publish_size
(*, color=None, dimensions=None, label=None, period=None, statistic=None, unit=None)¶ Metric for the size of messages published through this topic.
Average over 5 minutes
 Parameters
props –
color (
Optional
[str
]) – Color for this metric when added to a Graph in a Dashboard.dimensions (
Optional
[Mapping
[str
,Any
]]) – Dimensions of the metric. Default:  No dimensions.label (
Optional
[str
]) – Label for this metric when added to a Graph in a Dashboard.period (
Optional
[Duration
]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)statistic (
Optional
[str
]) – What function to use for aggregating. Can be one of the following:  “Minimum”  “min”  “Maximum”  “max”  “Average”  “avg”  “Sum”  “sum”  “SampleCount  “n”  “pNN.NN” Default: Averageunit (
Optional
[Unit
]) – Unit for the metric that is associated with the alarm.
 Return type

metric_sms_month_to_date_spent_usd
(*, color=None, dimensions=None, label=None, period=None, statistic=None, unit=None)¶ The charges you have accrued since the start of the current calendar month for sending SMS messages.
Maximum over 5 minutes
 Parameters
props –
color (
Optional
[str
]) – Color for this metric when added to a Graph in a Dashboard.dimensions (
Optional
[Mapping
[str
,Any
]]) – Dimensions of the metric. Default:  No dimensions.label (
Optional
[str
]) – Label for this metric when added to a Graph in a Dashboard.period (
Optional
[Duration
]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)statistic (
Optional
[str
]) – What function to use for aggregating. Can be one of the following:  “Minimum”  “min”  “Maximum”  “max”  “Average”  “avg”  “Sum”  “sum”  “SampleCount  “n”  “pNN.NN” Default: Averageunit (
Optional
[Unit
]) – Unit for the metric that is associated with the alarm.
 Return type

metric_sms_success_rate
(*, color=None, dimensions=None, label=None, period=None, statistic=None, unit=None)¶ The rate of successful SMS message deliveries.
Sum over 5 minutes
 Parameters
props –
color (
Optional
[str
]) – Color for this metric when added to a Graph in a Dashboard.dimensions (
Optional
[Mapping
[str
,Any
]]) – Dimensions of the metric. Default:  No dimensions.label (
Optional
[str
]) – Label for this metric when added to a Graph in a Dashboard.period (
Optional
[Duration
]) – The period over which the specified statistic is applied. Default: Duration.minutes(5)statistic (
Optional
[str
]) – What function to use for aggregating. Can be one of the following:  “Minimum”  “min”  “Maximum”  “max”  “Average”  “avg”  “Sum”  “sum”  “SampleCount  “n”  “pNN.NN” Default: Averageunit (
Optional
[Unit
]) – Unit for the metric that is associated with the alarm.
 Return type
Attributes

node
¶ The construct node in the tree.
 Return type

topic_arn
¶ attribute: :attribute:: true
 Return type
str

topic_name
¶ attribute: :attribute:: true
 Return type
str
