Class: AWSCDK::ResilienceHub::CfnApp::EventSubscriptionProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
resilience_hub/cfn_app.rb

Overview

Indicates an event you would like to subscribe and get notification for.

Currently, AWS Resilience Hub supports notifications only for Drift detected and Scheduled assessment failure events.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(event_type:, name:, sns_topic_arn: nil) ⇒ EventSubscriptionProperty

Returns a new instance of EventSubscriptionProperty.

Parameters:

  • event_type (String) —

    The type of event you would like to subscribe and get notification for.

  • name (String) —

    Unique name to identify an event subscription.

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

    Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic.



637
638
639
640
641
642
643
644
 
# File 'resilience_hub/cfn_app.rb', line 637

def initialize(event_type:, name:, sns_topic_arn: nil)
  @event_type = event_type
  Jsii::Type.check_type(@event_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "eventType")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @sns_topic_arn = sns_topic_arn
  Jsii::Type.check_type(@sns_topic_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "snsTopicArn") unless @sns_topic_arn.nil?
end

Instance Attribute Details

#event_type ⇒ String (readonly)

The type of event you would like to subscribe and get notification for.

Currently, AWS Resilience Hub supports notifications only for Drift detected ( DriftDetected ) and Scheduled assessment failure ( ScheduledAssessmentFailure ) events.

Returns:

  • (String)

See Also:



652
653
654
 
# File 'resilience_hub/cfn_app.rb', line 652

def event_type
  @event_type
end

#name ⇒ String (readonly)

Unique name to identify an event subscription.

Returns:

  • (String)

See Also:



657
658
659
 
# File 'resilience_hub/cfn_app.rb', line 657

def name
  @name
end

#sns_topic_arn ⇒ String? (readonly)

Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic.

The format for this ARN is: arn:partition:sns:region:account:topic-name . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference guide.

Returns:

  • (String, nil)

See Also:



664
665
666
 
# File 'resilience_hub/cfn_app.rb', line 664

def sns_topic_arn
  @sns_topic_arn
end

Class Method Details

.jsii_properties ⇒ Object 



666
667
668
669
670
671
672
 
# File 'resilience_hub/cfn_app.rb', line 666

def self.jsii_properties
  {
    :event_type => "eventType",
    :name => "name",
    :sns_topic_arn => "snsTopicArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



674
675
676
677
678
679
680
681
682
 
# File 'resilience_hub/cfn_app.rb', line 674

def to_jsii
  result = {}
  result.merge!({
    "eventType" => @event_type,
    "name" => @name,
    "snsTopicArn" => @sns_topic_arn,
  })
  result.compact
end