Skip to content
v2.277.0

LoggingConfig Struct ​

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

Example ​

ts
declare const role: iam.Role;
const topic = new sns.Topic(this, 'MyTopic');

topic.addLoggingConfig({
  protocol: sns.LoggingProtocol.SQS,
  failureFeedbackRole: role,
  successFeedbackRole: role,
  successFeedbackSampleRate: 50,
});
python
# 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
)
java
Role role;

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

topic.addLoggingConfig(LoggingConfig.builder()
        .protocol(LoggingProtocol.SQS)
        .failureFeedbackRole(role)
        .successFeedbackRole(role)
        .successFeedbackSampleRate(50)
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
Role role;

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

topic.AddLoggingConfig(new LoggingConfig {
    Protocol = LoggingProtocol.SQS,
    FailureFeedbackRole = role,
    SuccessFeedbackRole = role,
    SuccessFeedbackSampleRate = 50
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var role Role

topic := sns.NewTopic(this, jsii.String("MyTopic"))

topic.AddLoggingConfig(&LoggingConfig{
	Protocol: sns.LoggingProtocol_SQS,
	FailureFeedbackRole: role,
	SuccessFeedbackRole: role,
	SuccessFeedbackSampleRate: jsii.Number(50),
})

Properties ​

failureFeedbackRoleoptionalIRoleReffailure_feedback_roleoptionalIRoleReffailureFeedbackRoleoptionalIRoleRefFailureFeedbackRoleoptionalIRoleRefFailureFeedbackRoleoptionalIRoleRef = None #
The IAM role to be used when logging failed message deliveries in Amazon CloudWatch.
Indicates one of the supported protocols for the SNS topic.
successFeedbackRoleoptionalIRoleRefsuccess_feedback_roleoptionalIRoleRefsuccessFeedbackRoleoptionalIRoleRefSuccessFeedbackRoleoptionalIRoleRefSuccessFeedbackRoleoptionalIRoleRef = None #
The IAM role to be used when logging successful message deliveries in Amazon CloudWatch.
successFeedbackSampleRateoptionalnumbersuccess_feedback_sample_rateoptionalint | floatsuccessFeedbackSampleRateoptionalNumberSuccessFeedbackSampleRateoptionaldoubleSuccessFeedbackSampleRateoptional*float64 = None #
The percentage of successful message deliveries to be logged in Amazon CloudWatch.

Valid values are integer between 0-100