Class: AWSCDK::SecurityHub::CfnInsightProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
security_hub/cfn_insight_props.rb

Overview

Properties for defining a CfnInsight.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(filters:, group_by_attribute:, name:) ⇒ CfnInsightProps

Returns a new instance of CfnInsightProps.

Parameters:



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

def initialize(filters:, group_by_attribute:, name:)
  @filters = filters.is_a?(Hash) ? ::AWSCDK::SecurityHub::CfnInsight::AWSSecurityFindingFiltersProperty.new(**filters.transform_keys(&:to_sym)) : filters
  Jsii::Type.check_type(@filters, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZWN1cml0eWh1Yi5DZm5JbnNpZ2h0LkF3c1NlY3VyaXR5RmluZGluZ0ZpbHRlcnNQcm9wZXJ0eSJ9XX19")), "filters")
  @group_by_attribute = group_by_attribute
  Jsii::Type.check_type(@group_by_attribute, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "groupByAttribute")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
end

Instance Attribute Details

#filters ⇒ AWSCDK::IResolvable, AWSCDK::SecurityHub::CfnInsight::AWSSecurityFindingFiltersProperty (readonly)

One or more attributes used to filter the findings included in the insight.

The insight only includes findings that match the criteria defined in the filters. You can filter by up to ten finding attributes. For each attribute, you can provide up to 20 filter values.

Returns:

See Also:



27
28
29
 
# File 'security_hub/cfn_insight_props.rb', line 27

def filters
  @filters
end

#group_by_attribute ⇒ String (readonly)

The grouping attribute for the insight's findings.

Indicates how to group the matching findings, and identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.

Returns:

  • (String)

See Also:



34
35
36
 
# File 'security_hub/cfn_insight_props.rb', line 34

def group_by_attribute
  @group_by_attribute
end

#name ⇒ String (readonly)

The name of a Security Hub CSPM insight.

Returns:

  • (String)

See Also:



39
40
41
 
# File 'security_hub/cfn_insight_props.rb', line 39

def name
  @name
end

Class Method Details

.jsii_properties ⇒ Object 



41
42
43
44
45
46
47
 
# File 'security_hub/cfn_insight_props.rb', line 41

def self.jsii_properties
  {
    :filters => "filters",
    :group_by_attribute => "groupByAttribute",
    :name => "name",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



49
50
51
52
53
54
55
56
57
 
# File 'security_hub/cfn_insight_props.rb', line 49

def to_jsii
  result = {}
  result.merge!({
    "filters" => @filters,
    "groupByAttribute" => @group_by_attribute,
    "name" => @name,
  })
  result.compact
end