LoggingConfig

class aws_cdk.aws_sns.LoggingConfig(*, protocol, failure_feedback_role=None, success_feedback_role=None, success_feedback_sample_rate=None)

Bases: object

A logging configuration for delivery status of messages sent from SNS topic to subscribed endpoints.

Parameters:

• protocol (LoggingProtocol) – Indicates one of the supported protocols for the SNS topic.

• failure_feedback_role (Optional[IRole]) – The IAM role to be used when logging failed message deliveries in Amazon CloudWatch. Default: None

• success_feedback_role (Optional[IRole]) – The IAM role to be used when logging successful message deliveries in Amazon CloudWatch. Default: None

• success_feedback_sample_rate (Union[int, float, None]) – The percentage of successful message deliveries to be logged in Amazon CloudWatch. Valid values are integer between 0-100 Default: None

See:

https://docs.aws.amazon.com/sns/latest/dg/sns-topic-attributes.html.

ExampleMetadata:

infused

Example:

# role: iam.Role

topic = sns.Topic(self, "MyTopic")

topic.add_logging_config(
    protocol=sns.LoggingProtocol.SQS,
    failure_feedback_role=role,
    success_feedback_role=role,
    success_feedback_sample_rate=50
)

Attributes

failure_feedback_role

The IAM role to be used when logging failed message deliveries in Amazon CloudWatch.

Default:

None

protocol

Indicates one of the supported protocols for the SNS topic.

success_feedback_role

The IAM role to be used when logging successful message deliveries in Amazon CloudWatch.

Default:

None

success_feedback_sample_rate

The percentage of successful message deliveries to be logged in Amazon CloudWatch.

Valid values are integer between 0-100

Default:

None