Interface LoggingConfig

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
LoggingConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-25T14:21:24.042Z") @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:
  • 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