aws-cdk-lib.aws_sns.CfnTopic.LoggingConfigProperty

LoggingConfigProperty Struct

The LoggingConfig property type specifies the Delivery status logging configuration for an AWS::SNS::Topic .

Source

Generated code

Type last changed

v2.115.0 · 14 Dec 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sns as sns } from 'aws-cdk-lib';
const loggingConfigProperty: sns.CfnTopic.LoggingConfigProperty = {
  protocol: 'protocol',

  // the properties below are optional
  failureFeedbackRoleArn: 'failureFeedbackRoleArn',
  successFeedbackRoleArn: 'successFeedbackRoleArn',
  successFeedbackSampleRate: 'successFeedbackSampleRate',
};

Properties

failureFeedbackRoleArn?optionalstringfailure_feedback_role_arn?optionalstrfailureFeedbackRoleArn?optionalStringFailureFeedbackRoleArn?optionalstringFailureFeedbackRoleArn?optional*string#

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

protocolstringprotocolstrprotocolStringProtocolstringProtocol*stringrequired#

Indicates one of the supported protocols for the Amazon SNS topic.

At least one of the other three LoggingConfig properties is recommend along with Protocol .

successFeedbackRoleArn?optionalstringsuccess_feedback_role_arn?optionalstrsuccessFeedbackRoleArn?optionalStringSuccessFeedbackRoleArn?optionalstringSuccessFeedbackRoleArn?optional*string#

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

successFeedbackSampleRate?optionalstringsuccess_feedback_sample_rate?optionalstrsuccessFeedbackSampleRate?optionalStringSuccessFeedbackSampleRate?optionalstringSuccessFeedbackSampleRate?optional*string#

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

Valid percentage values range from 0 to 100.