Interface ILoggingConfig

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

Namespace: Amazon.CDK.AWS.SNS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ILoggingConfig

Syntax (vb)

Public Interface ILoggingConfig

Remarks

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

ExampleMetadata: infused

Examples

Role role;

             var topic = new Topic(this, "MyTopic");

             topic.AddLoggingConfig(new LoggingConfig {
                 Protocol = LoggingProtocol.SQS,
                 FailureFeedbackRole = role,
                 SuccessFeedbackRole = role,
                 SuccessFeedbackSampleRate = 50
             });

Synopsis

Properties

FailureFeedbackRole	The IAM role to be used when logging failed message deliveries in Amazon CloudWatch.
Protocol	Indicates one of the supported protocols for the SNS topic.
SuccessFeedbackRole	The IAM role to be used when logging successful message deliveries in Amazon CloudWatch.
SuccessFeedbackSampleRate	The percentage of successful message deliveries to be logged in Amazon CloudWatch.

Properties

FailureFeedbackRole

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

IRole? FailureFeedbackRole { get; }

Property Value

IRole

Remarks

Default: None

Protocol

Indicates one of the supported protocols for the SNS topic.

LoggingProtocol Protocol { get; }

Property Value

LoggingProtocol

Remarks

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

ExampleMetadata: infused

SuccessFeedbackRole

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

IRole? SuccessFeedbackRole { get; }

Property Value

IRole

Remarks

Default: None

SuccessFeedbackSampleRate

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

double? SuccessFeedbackSampleRate { get; }

Property Value

double?

Remarks

Valid values are integer between 0-100

Default: None