SnsTopic

class aws_cdk.aws_events_targets.SnsTopic(topic, *, message=None, dead_letter_queue=None, max_event_age=None, retry_attempts=None)

Bases: object

Use an SNS topic as a target for Amazon EventBridge rules.

If the topic is imported the required permissions to publish to that topic need to be set manually.

Example:

# publish to an SNS topic every time code is committed
# to a CodeCommit repository
repository.on_commit("onCommit", target=targets.SnsTopic(topic))

Parameters:

topic (ITopic) –
message (Optional[RuleTargetInput]) – The message to send to the topic. Default: the entire EventBridge event
dead_letter_queue (Optional[IQueue]) – The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue. The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue. Default: - no dead-letter queue
max_event_age (Optional[Duration]) – The maximum age of a request that Lambda sends to a function for processing. Minimum value of 60. Maximum value of 86400. Default: Duration.hours(24)
retry_attempts (Union[int, float, None]) – The maximum number of times to retry when the function returns an error. Minimum value of 0. Maximum value of 185. Default: 185

Methods

bind(_rule, _id=None)

Returns a RuleTarget that can be used to trigger this SNS topic as a result from an EventBridge event.

Parameters:

See:

Return type:

RuleTargetConfig

Attributes