createFindingAggregator method

Future<CreateFindingAggregatorResponse> createFindingAggregator({ required String regionLinkingMode, List<String>? regions, })

Used to enable cross-Region aggregation. This operation can be invoked from the home Region only.

For information about how cross-Region aggregation works, see Understanding cross-Region aggregation in Security Hub CSPM in the Security Hub CSPM User Guide.

May throw AccessDeniedException. May throw InternalException. May throw InvalidAccessException. May throw InvalidInputException. May throw LimitExceededException.

Parameter regionLinkingMode : 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 CSPM 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 CSPM is enabled. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into them.
• ALL_REGIONS_EXCEPT_SPECIFIED - Aggregates findings from all of the Regions where Security Hub CSPM is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub CSPM also automatically aggregates findings from new Regions as Security Hub CSPM supports them and you opt into them.
• SPECIFIED_REGIONS - Aggregates findings only from the Regions listed in the Regions parameter. Security Hub CSPM does not automatically aggregate findings from new Regions.
• NO_REGIONS - Aggregates no data because no Regions are selected as linked Regions.

Parameter regions : If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that don't replicate and send findings to the home Region.

If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do replicate and send findings to the home Region.

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

Implementation

Future<CreateFindingAggregatorResponse> createFindingAggregator({
  required String regionLinkingMode,
  List<String>? regions,
}) async {
  final $payload = <String, dynamic>{
    'RegionLinkingMode': regionLinkingMode,
    if (regions != null) 'Regions': regions,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/findingAggregator/create',
    exceptionFnMap: _exceptionFns,
  );
  return CreateFindingAggregatorResponse.fromJson(response);
}