SnsTopicProps

class aws_cdk.aws_events_targets.SnsTopicProps(*, dead_letter_queue=None, max_event_age=None, retry_attempts=None, authorize_using_role=None, message=None, role=None)

Bases: TargetBaseProps

Customize the SNS Topic Event Target.

Parameters:

  • 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

  • authorize_using_role (Optional[bool]) – Specifies whether an IAM role should be used to publish to the topic. Default: - true if role is provided, false otherwise

  • message (Optional[RuleTargetInput]) – The message to send to the topic. Default: the entire EventBridge event

  • role (Optional[IRole]) – The IAM role to be used to publish to the topic. Default: - a new role will be created if authorizeUsingRole is true

ExampleMetadata:

infused

Example:

# on_commit_rule: events.Rule
# topic: sns.Topic


on_commit_rule.add_target(targets.SnsTopic(topic,
    message=events.RuleTargetInput.from_object({
        "DataType": f"custom_{events.EventField.fromPath('$.detail-type')}"
    })
))

Attributes

authorize_using_role

Specifies whether an IAM role should be used to publish to the topic.

Default:

  • true if role is provided, false otherwise

dead_letter_queue

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

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)

message

The message to send to the topic.

Default:

the entire EventBridge event

retry_attempts

The maximum number of times to retry when the function returns an error.

Minimum value of 0. Maximum value of 185.

Default:

185

role

The IAM role to be used to publish to the topic.

Default:

  • a new role will be created if authorizeUsingRole is true