Class: AWSCDK::Synthetics::GroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
synthetics/group_props.rb

Overview

Properties for defining a CloudWatch Synthetics Group.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(canaries: nil, group_name: nil) ⇒ GroupProps

Returns a new instance of GroupProps.

Parameters:

  • canaries (Array<AWSCDK::Synthetics::ICanary>, nil) (defaults to: nil) —

    List of canaries to associate with this group.

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

    A name for the group. Must contain only lowercase alphanumeric characters, hyphens, or underscores, and be at most 64 characters.



9
10
11
12
13
14
 
# File 'synthetics/group_props.rb', line 9

def initialize(canaries: nil, group_name: nil)
  @canaries = canaries
  Jsii::Type.check_type(@canaries, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zeW50aGV0aWNzLklDYW5hcnkifSwia2luZCI6ImFycmF5In19")), "canaries") unless @canaries.nil?
  @group_name = group_name
  Jsii::Type.check_type(@group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "groupName") unless @group_name.nil?
end

Instance Attribute Details

#canaries ⇒ Array<AWSCDK::Synthetics::ICanary>? (readonly)

Note:

Default: - No canaries are associated with the group initially

List of canaries to associate with this group.

Each group can contain as many as 10 canaries.

Returns:



22
23
24
 
# File 'synthetics/group_props.rb', line 22

def canaries
  @canaries
end

#group_name ⇒ String? (readonly)

Note:

Default: - A unique name will be generated from the construct ID

A name for the group. Must contain only lowercase alphanumeric characters, hyphens, or underscores, and be at most 64 characters.

The names for all groups in your account, across all Regions, must be unique.

Returns:

  • (String, nil) 


29
30
31
 
# File 'synthetics/group_props.rb', line 29

def group_name
  @group_name
end

Class Method Details

.jsii_properties ⇒ Object 



31
32
33
34
35
36
 
# File 'synthetics/group_props.rb', line 31

def self.jsii_properties
  {
    :canaries => "canaries",
    :group_name => "groupName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



38
39
40
41
42
43
44
45
 
# File 'synthetics/group_props.rb', line 38

def to_jsii
  result = {}
  result.merge!({
    "canaries" => @canaries,
    "groupName" => @group_name,
  })
  result.compact
end