Class: AWSCDK::Notifications::CfnNotificationConfigurationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
notifications/cfn_notification_configuration_props.rb

Overview

Properties for defining a CfnNotificationConfiguration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description:, name:, aggregation_duration: nil, tags: nil) ⇒ CfnNotificationConfigurationProps

Returns a new instance of CfnNotificationConfigurationProps.

Parameters:

  • description (String)

    The description of the NotificationConfiguration .

  • name (String)

    The name of the NotificationConfiguration .

  • aggregation_duration (String, nil) (defaults to: nil)

    The aggregation preference of the NotificationConfiguration .

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil)

    A map of tags assigned to a NotificationConfiguration .



13
14
15
16
17
18
19
20
21
22
# File 'notifications/cfn_notification_configuration_props.rb', line 13

def initialize(description:, name:, aggregation_duration: nil, tags: nil)
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @aggregation_duration = aggregation_duration
  Jsii::Type.check_type(@aggregation_duration, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "aggregationDuration") unless @aggregation_duration.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#aggregation_durationString? (readonly)

The aggregation preference of the NotificationConfiguration .

  • Values:
  • LONG
  • Aggregate notifications for long periods of time (12 hours).
  • SHORT
  • Aggregate notifications for short periods of time (5 minutes).
  • NONE
  • Don't aggregate notifications.


48
49
50
# File 'notifications/cfn_notification_configuration_props.rb', line 48

def aggregation_duration
  @aggregation_duration
end

#descriptionString (readonly)

The description of the NotificationConfiguration .



28
29
30
# File 'notifications/cfn_notification_configuration_props.rb', line 28

def description
  @description
end

#nameString (readonly)

The name of the NotificationConfiguration .

Supports RFC 3986's unreserved characters.



35
36
37
# File 'notifications/cfn_notification_configuration_props.rb', line 35

def name
  @name
end

#tagsArray<AWSCDK::CfnTag>? (readonly)

A map of tags assigned to a NotificationConfiguration .



53
54
55
# File 'notifications/cfn_notification_configuration_props.rb', line 53

def tags
  @tags
end

Class Method Details

.jsii_propertiesObject



55
56
57
58
59
60
61
62
# File 'notifications/cfn_notification_configuration_props.rb', line 55

def self.jsii_properties
  {
    :description => "description",
    :name => "name",
    :aggregation_duration => "aggregationDuration",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsiiObject



64
65
66
67
68
69
70
71
72
73
# File 'notifications/cfn_notification_configuration_props.rb', line 64

def to_jsii
  result = {}
  result.merge!({
    "description" => @description,
    "name" => @name,
    "aggregationDuration" => @aggregation_duration,
    "tags" => @tags,
  })
  result.compact
end