Class: AWSCDK::XRay::CfnGroupProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
x_ray/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(group_name:, filter_expression: nil, insights_configuration: nil, tags: nil) ⇒ CfnGroupProps

Returns a new instance of CfnGroupProps.

Parameters:

  • group_name (String) —

    The unique case-sensitive name of the group.

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

    The filter expression defining the parameters to include traces.

  • insights_configuration (AWSCDK::IResolvable, AWSCDK::XRay::CfnGroup::InsightsConfigurationProperty, nil) (defaults to: nil) —

    The structure containing configurations related to insights.

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

    An array of key-value pairs to apply to this resource.



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

def initialize(group_name:, filter_expression: nil, insights_configuration: nil, tags: nil)
  @group_name = group_name
  Jsii::Type.check_type(@group_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "groupName")
  @filter_expression = filter_expression
  Jsii::Type.check_type(@filter_expression, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filterExpression") unless @filter_expression.nil?
  @insights_configuration = insights_configuration.is_a?(Hash) ? ::AWSCDK::XRay::CfnGroup::InsightsConfigurationProperty.new(**insights_configuration.transform_keys(&:to_sym)) : insights_configuration
  Jsii::Type.check_type(@insights_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c194cmF5LkNmbkdyb3VwLkluc2lnaHRzQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "insightsConfiguration") unless @insights_configuration.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

#filter_expression ⇒ String? (readonly)

The filter expression defining the parameters to include traces.

Returns:

  • (String, nil)

See Also:



33
34
35
 
# File 'x_ray/cfn_group_props.rb', line 33

def filter_expression
  @filter_expression
end

#group_name ⇒ String (readonly)

The unique case-sensitive name of the group.

Returns:

  • (String)

See Also:



28
29
30
 
# File 'x_ray/cfn_group_props.rb', line 28

def group_name
  @group_name
end

#insights_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The structure containing configurations related to insights.

  • The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
  • The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.

Returns:

See Also:



41
42
43
 
# File 'x_ray/cfn_group_props.rb', line 41

def insights_configuration
  @insights_configuration
end

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

An array of key-value pairs to apply to this resource.

Returns:

See Also:



46
47
48
 
# File 'x_ray/cfn_group_props.rb', line 46

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



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

def self.jsii_properties
  {
    :group_name => "groupName",
    :filter_expression => "filterExpression",
    :insights_configuration => "insightsConfiguration",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



57
58
59
60
61
62
63
64
65
66
 
# File 'x_ray/cfn_group_props.rb', line 57

def to_jsii
  result = {}
  result.merge!({
    "groupName" => @group_name,
    "filterExpression" => @filter_expression,
    "insightsConfiguration" => @insights_configuration,
    "tags" => @tags,
  })
  result.compact
end