Class CfnFindingAggregator
- All Implemented Interfaces:
IEnvironmentAware,IInspectable,IFindingAggregatorRef,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
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:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.services.securityhub.IFindingAggregatorRef
IFindingAggregatorRef.Jsii$Default, IFindingAggregatorRef.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnFindingAggregator(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnFindingAggregator(software.amazon.jsii.JsiiObjectRef objRef) CfnFindingAggregator(software.constructs.Construct scope, String id, CfnFindingAggregatorProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe home Region.The ARN of the finding aggregator.A reference to a FindingAggregator resource.Indicates whether to aggregate findings from all of the available Regions in the current partition.IfRegionLinkingModeisALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidsetRegionLinkingMode(String value) Indicates whether to aggregate findings from all of the available Regions in the current partition.voidsetRegions(List<String> value) IfRegionLinkingModeisALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.awscdk.IEnvironmentAware
getEnvMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- 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:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrFindingAggregationRegion
The home Region.Findings generated in linked Regions are replicated and sent to the home Region.
-
getAttrFindingAggregatorArn
The ARN of the finding aggregator.You use the finding aggregator ARN to retrieve details for, update, and delete the finding aggregator.
-
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getFindingAggregatorRef
A reference to a FindingAggregator resource.- Specified by:
getFindingAggregatorRefin interfaceIFindingAggregatorRef
-
getRegionLinkingMode
Indicates whether to aggregate findings from all of the available Regions in the current partition. -
setRegionLinkingMode
Indicates whether to aggregate findings from all of the available Regions in the current partition. -
getRegions
IfRegionLinkingModeisALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region. -
setRegions
IfRegionLinkingModeisALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region.
-