Class: AWSCDK::SNS::CfnTopic::LoggingConfigProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sns/cfn_topic.rb

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(protocol:, failure_feedback_role_arn: nil, success_feedback_role_arn: nil, success_feedback_sample_rate: nil) ⇒ LoggingConfigProperty

Returns a new instance of LoggingConfigProperty.

Parameters:

  • protocol (String) —

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

  • failure_feedback_role_arn (String, nil) (defaults to: nil) —

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

  • success_feedback_role_arn (String, nil) (defaults to: nil) —

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

  • success_feedback_sample_rate (String, nil) (defaults to: nil) —

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



686
687
688
689
690
691
692
693
694
695
 
# File 'sns/cfn_topic.rb', line 686

def initialize(protocol:, failure_feedback_role_arn: nil, success_feedback_role_arn: nil, success_feedback_sample_rate: nil)
  @protocol = protocol
  Jsii::Type.check_type(@protocol, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "protocol")
  @failure_feedback_role_arn = failure_feedback_role_arn
  Jsii::Type.check_type(@failure_feedback_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "failureFeedbackRoleArn") unless @failure_feedback_role_arn.nil?
  @success_feedback_role_arn = success_feedback_role_arn
  Jsii::Type.check_type(@success_feedback_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "successFeedbackRoleArn") unless @success_feedback_role_arn.nil?
  @success_feedback_sample_rate = success_feedback_sample_rate
  Jsii::Type.check_type(@success_feedback_sample_rate, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "successFeedbackSampleRate") unless @success_feedback_sample_rate.nil?
end

Instance Attribute Details

#failure_feedback_role_arn ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



708
709
710
 
# File 'sns/cfn_topic.rb', line 708

def failure_feedback_role_arn
  @failure_feedback_role_arn
end

#protocol ⇒ String (readonly)

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 .

Returns:

  • (String)

See Also:



703
704
705
 
# File 'sns/cfn_topic.rb', line 703

def protocol
  @protocol
end

#success_feedback_role_arn ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



713
714
715
 
# File 'sns/cfn_topic.rb', line 713

def success_feedback_role_arn
  @success_feedback_role_arn
end

#success_feedback_sample_rate ⇒ String? (readonly)

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

Valid percentage values range from 0 to 100.

Returns:

  • (String, nil)

See Also:



720
721
722
 
# File 'sns/cfn_topic.rb', line 720

def success_feedback_sample_rate
  @success_feedback_sample_rate
end

Class Method Details

.jsii_properties ⇒ Object 



722
723
724
725
726
727
728
729
 
# File 'sns/cfn_topic.rb', line 722

def self.jsii_properties
  {
    :protocol => "protocol",
    :failure_feedback_role_arn => "failureFeedbackRoleArn",
    :success_feedback_role_arn => "successFeedbackRoleArn",
    :success_feedback_sample_rate => "successFeedbackSampleRate",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



731
732
733
734
735
736
737
738
739
740
 
# File 'sns/cfn_topic.rb', line 731

def to_jsii
  result = {}
  result.merge!({
    "protocol" => @protocol,
    "failureFeedbackRoleArn" => @failure_feedback_role_arn,
    "successFeedbackRoleArn" => @success_feedback_role_arn,
    "successFeedbackSampleRate" => @success_feedback_sample_rate,
  })
  result.compact
end