Package software.amazon.awscdk.services.sns

Interface LoggingConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LoggingConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:14.146Z")
@Stability(Stable)
public interface LoggingConfig
extends software.amazon.jsii.JsiiSerializable

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

Example:

 Role role;
 Topic topic = new Topic(this, "MyTopic");
 topic.addLoggingConfig(LoggingConfig.builder()
         .protocol(LoggingProtocol.SQS)
         .failureFeedbackRole(role)
         .successFeedbackRole(role)
         .successFeedbackSampleRate(50)
         .build());
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	LoggingConfig.Builder	A builder for LoggingConfig
static final class	LoggingConfig.Jsii$Proxy	An implementation for LoggingConfig

Method Summary

Modifier and Type	Method	Description
static LoggingConfig.Builder	builder()
default IRole	getFailureFeedbackRole()	The IAM role to be used when logging failed message deliveries in Amazon CloudWatch.
LoggingProtocol	getProtocol()	Indicates one of the supported protocols for the SNS topic.
default IRole	getSuccessFeedbackRole()	The IAM role to be used when logging successful message deliveries in Amazon CloudWatch.
default Number	getSuccessFeedbackSampleRate()	The percentage of successful message deliveries to be logged in Amazon CloudWatch.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getProtocol

@Stability(Stable)
@NotNull
LoggingProtocol getProtocol()

Indicates one of the supported protocols for the SNS topic.

getFailureFeedbackRole

@Stability(Stable)
@Nullable
default IRole getFailureFeedbackRole()

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

Default: None

getSuccessFeedbackRole

@Stability(Stable)
@Nullable
default IRole getSuccessFeedbackRole()

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

Default: None

getSuccessFeedbackSampleRate

@Stability(Stable)
@Nullable
default Number getSuccessFeedbackSampleRate()

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

Valid values are integer between 0-100

Default: None

builder

@Stability(Stable)
static LoggingConfig.Builder builder()

Returns:

a LoggingConfig.Builder of LoggingConfig