Skip to content

Create Finding Aggregator

securityhub_create_finding_aggregator R Documentation

Used to enable finding aggregation

Description

Used to enable finding aggregation. Must be called from the aggregation Region.

For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.

Usage

securityhub_create_finding_aggregator(RegionLinkingMode, Regions)

Arguments

RegionLinkingMode

[required] 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.

The options are as follows:

  • ALL_REGIONS - Aggregates 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 - Aggregates 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 - Aggregates findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.

  • NO_REGIONS - Aggregates no data because no Regions are selected as linked Regions.

Regions

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.

An InvalidInputException error results if you populate this field while RegionLinkingMode is NO_REGIONS.

Value

A list with the following syntax: 

list(
  FindingAggregatorArn = "string",
  FindingAggregationRegion = "string",
  RegionLinkingMode = "string",
  Regions = list(
    "string"
  )
)

Request syntax

svc$create_finding_aggregator(
  RegionLinkingMode = "string",
  Regions = list(
    "string"
  )
)

Examples

## Not run: 
# The following example creates a finding aggregator. This is required to
# enable cross-Region aggregation.
svc$create_finding_aggregator(
  RegionLinkingMode = "SPECIFIED_REGIONS",
  Regions = list(
    "us-west-1",
    "us-west-2"
  )
)

## End(Not run)