Class: AWSCDK::Synthetics::CfnGroupProps

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

Overview

Properties for defining a CfnGroup.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, resource_arns: nil, tags: nil) ⇒ CfnGroupProps

Returns a new instance of CfnGroupProps.

Parameters:

  • name (String) —

    A name for the group. It can include any Unicode characters.

  • resource_arns (Array<String>, nil) (defaults to: nil) —

    The ARNs of the canaries that you want to associate with this group.

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

    The list of key-value pairs that are associated with the group.



12
13
14
15
16
17
18
19
 
# File 'synthetics/cfn_group_props.rb', line 12

def initialize(name:, resource_arns: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @resource_arns = resource_arns
  Jsii::Type.check_type(@resource_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "resourceArns") unless @resource_arns.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

#name ⇒ String (readonly)

A name for the group. It can include any Unicode characters.

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

Returns:

  • (String)

See Also:



27
28
29
 
# File 'synthetics/cfn_group_props.rb', line 27

def name
  @name
end

#resource_arns ⇒ Array<String>? (readonly)

The ARNs of the canaries that you want to associate with this group.

Returns:

  • (Array<String>, nil)

See Also:



32
33
34
 
# File 'synthetics/cfn_group_props.rb', line 32

def resource_arns
  @resource_arns
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The list of key-value pairs that are associated with the group.

Returns:

See Also:



37
38
39
 
# File 'synthetics/cfn_group_props.rb', line 37

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



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

def self.jsii_properties
  {
    :name => "name",
    :resource_arns => "resourceArns",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



47
48
49
50
51
52
53
54
55
 
# File 'synthetics/cfn_group_props.rb', line 47

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "resourceArns" => @resource_arns,
    "tags" => @tags,
  })
  result.compact
end