securityhub_update_finding_aggregator: Updates the finding aggregation configuration

View source: R/securityhub_operations.R

securityhub_update_finding_aggregatorR Documentation

Updates the finding aggregation configuration

Description

Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use update_finding_aggregator to change the aggregation Region.

See https://www.paws-r-sdk.com/docs/securityhub_update_finding_aggregator/ for full documentation.

Usage

securityhub_update_finding_aggregator(
  FindingAggregatorArn,
  RegionLinkingMode,
  Regions = NULL
)

Arguments

FindingAggregatorArn

[required] The ARN of the finding aggregator. To obtain the ARN, use list_finding_aggregators.

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.


paws.security.identity documentation built on Sept. 12, 2024, 6:30 a.m.