Class: AWSCDK::SecurityHub::CfnFindingAggregatorProps

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

Overview

Properties for defining a CfnFindingAggregator.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(region_linking_mode:, regions: nil) ⇒ CfnFindingAggregatorProps

Returns a new instance of CfnFindingAggregatorProps.

Parameters:

  • region_linking_mode (String) —

    Indicates whether to aggregate findings from all of the available Regions in the current partition.

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

    If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED , then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.



11
12
13
14
15
16
 
# File 'security_hub/cfn_finding_aggregator_props.rb', line 11

def initialize(region_linking_mode:, regions: nil)
  @region_linking_mode = region_linking_mode
  Jsii::Type.check_type(@region_linking_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "regionLinkingMode")
  @regions = regions
  Jsii::Type.check_type(@regions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "regions") unless @regions.nil?
end

Instance Attribute Details

#region_linking_mode ⇒ String (readonly)

Indicates whether to aggregate findings from all of the available Regions in the current partition.

Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.

The selected option also determines how to use the Regions provided in the Regions list.

In CloudFormation , the options for this property are as follows:

  • ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
  • ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
  • SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.

Returns:

  • (String)

See Also:



32
33
34
 
# File 'security_hub/cfn_finding_aggregator_props.rb', line 32

def region_linking_mode
  @region_linking_mode
end

#regions ⇒ Array<String>? (readonly)

If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED , then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.

If RegionLinkingMode is SPECIFIED_REGIONS , then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.

Returns:

  • (Array<String>, nil)

See Also:



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

def regions
  @regions
end

Class Method Details

.jsii_properties ⇒ Object 



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

def self.jsii_properties
  {
    :region_linking_mode => "regionLinkingMode",
    :regions => "regions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "regionLinkingMode" => @region_linking_mode,
    "regions" => @regions,
  })
  result.compact
end