Package software.amazon.awscdk.services.sns

Interface CfnTopic.LoggingConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopic.LoggingConfigProperty.Jsii$Proxy

Enclosing class:

CfnTopic

@Stability(Stable)
public static interface CfnTopic.LoggingConfigProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sns.*;
 LoggingConfigProperty loggingConfigProperty = LoggingConfigProperty.builder()
         .protocol("protocol")
         // the properties below are optional
         .failureFeedbackRoleArn("failureFeedbackRoleArn")
         .successFeedbackRoleArn("successFeedbackRoleArn")
         .successFeedbackSampleRate("successFeedbackSampleRate")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-loggingconfig.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopic.LoggingConfigProperty.Builder	builder()
default String	getFailureFeedbackRoleArn()	The IAM role ARN to be used when logging failed message deliveries in Amazon CloudWatch.
String	getProtocol()	Indicates one of the supported protocols for the Amazon SNS topic.
default String	getSuccessFeedbackRoleArn()	The IAM role ARN to be used when logging successful message deliveries in Amazon CloudWatch.
default String	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
String getProtocol()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-loggingconfig.html#cfn-sns-topic-loggingconfig-protocol

getFailureFeedbackRoleArn

@Stability(Stable)
@Nullable
default String getFailureFeedbackRoleArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-loggingconfig.html#cfn-sns-topic-loggingconfig-failurefeedbackrolearn

getSuccessFeedbackRoleArn

@Stability(Stable)
@Nullable
default String getSuccessFeedbackRoleArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-loggingconfig.html#cfn-sns-topic-loggingconfig-successfeedbackrolearn

getSuccessFeedbackSampleRate

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

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

Valid percentage values range from 0 to 100.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-loggingconfig.html#cfn-sns-topic-loggingconfig-successfeedbacksamplerate

builder

@Stability(Stable)
static CfnTopic.LoggingConfigProperty.Builder builder()

Returns:

a CfnTopic.LoggingConfigProperty.Builder of CfnTopic.LoggingConfigProperty