Package software.amazon.awscdk.services.securityhub

Class CfnFindingAggregator

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.securityhub.CfnFindingAggregator
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2025-01-15T21:09:27.153Z") @Stability(Stable) public class CfnFindingAggregator extends CfnResource implements IInspectable
The AWS::SecurityHub::FindingAggregator resource enables cross-Region aggregation.

When cross-Region aggregation is enabled, you can aggregate findings, finding updates, insights, control compliance statuses, and security scores from one or more linked Regions to a single aggregation Region. You can then view and manage all of this data from the aggregation Region. For more details about cross-Region aggregation, see Cross-Region aggregation in the AWS Security Hub User Guide

This resource must be created in the Region that you want to designate as your aggregation Region.

Cross-Region aggregation is also a prerequisite for using central configuration in Security Hub .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.securityhub.*;
 CfnFindingAggregator cfnFindingAggregator = CfnFindingAggregator.Builder.create(this, "MyCfnFindingAggregator")
         .regionLinkingMode("regionLinkingMode")
         // the properties below are optional
         .regions(List.of("regions"))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFindingAggregator

      protected CfnFindingAggregator(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFindingAggregator

      protected CfnFindingAggregator(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFindingAggregator

      @Stability(Stable) public CfnFindingAggregator(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnFindingAggregatorProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrFindingAggregationRegion

      @Stability(Stable) @NotNull public String getAttrFindingAggregationRegion()
      The home Region.

      Findings generated in linked Regions are replicated and sent to the home Region.

    • getAttrFindingAggregatorArn

      @Stability(Stable) @NotNull public String getAttrFindingAggregatorArn()
      The ARN of the finding aggregator.

      You use the finding aggregator ARN to retrieve details for, update, and delete the finding aggregator.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRegionLinkingMode

      @Stability(Stable) @NotNull public String getRegionLinkingMode()
      Indicates whether to aggregate findings from all of the available Regions in the current partition.

    • setRegionLinkingMode

      @Stability(Stable) public void setRegionLinkingMode(@NotNull String value)
      Indicates whether to aggregate findings from all of the available Regions in the current partition.

    • getRegions

      @Stability(Stable) @Nullable public List<String> getRegions()
      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.

    • setRegions

      @Stability(Stable) public void setRegions(@Nullable List<String> value)
      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.