Class CfnFindingAggregator
The AWS::SecurityHub::FindingAggregator
resource enables cross-Region aggregation.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.SecurityHub
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFindingAggregator : CfnResource, IInspectable
Syntax (vb)
Public Class CfnFindingAggregator Inherits CfnResource Implements IInspectable
Remarks
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 .
CloudformationResource: AWS::SecurityHub::FindingAggregator
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SecurityHub;
var cfnFindingAggregator = new CfnFindingAggregator(this, "MyCfnFindingAggregator", new CfnFindingAggregatorProps {
RegionLinkingMode = "regionLinkingMode",
// the properties below are optional
Regions = new [] { "regions" }
});
Synopsis
Constructors
CfnFindingAggregator(Construct, string, ICfnFindingAggregatorProps) | The |
Properties
AttrFindingAggregationRegion | The home Region. |
AttrFindingAggregatorArn | The ARN of the finding aggregator. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | The |
RegionLinkingMode | Indicates whether to aggregate findings from all of the available Regions in the current partition. |
Regions | If |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<string, object>) | The |
Constructors
CfnFindingAggregator(Construct, string, ICfnFindingAggregatorProps)
The AWS::SecurityHub::FindingAggregator
resource enables cross-Region aggregation.
public CfnFindingAggregator(Construct scope, string id, ICfnFindingAggregatorProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnFindingAggregatorProps
Resource properties.
Remarks
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 .
CloudformationResource: AWS::SecurityHub::FindingAggregator
ExampleMetadata: fixture=_generated
Properties
AttrFindingAggregationRegion
The home Region.
public virtual string AttrFindingAggregationRegion { get; }
Property Value
Remarks
Findings generated in linked Regions are replicated and sent to the home Region.
CloudformationAttribute: FindingAggregationRegion
AttrFindingAggregatorArn
The ARN of the finding aggregator.
public virtual string AttrFindingAggregatorArn { get; }
Property Value
Remarks
You use the finding aggregator ARN to retrieve details for, update, and delete the finding aggregator.
CloudformationAttribute: FindingAggregatorArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
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 .
CloudformationResource: AWS::SecurityHub::FindingAggregator
ExampleMetadata: fixture=_generated
CfnProperties
The AWS::SecurityHub::FindingAggregator
resource enables cross-Region aggregation.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
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 .
CloudformationResource: AWS::SecurityHub::FindingAggregator
ExampleMetadata: fixture=_generated
RegionLinkingMode
Indicates whether to aggregate findings from all of the available Regions in the current partition.
public virtual string RegionLinkingMode { get; set; }
Property Value
Remarks
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 .
CloudformationResource: AWS::SecurityHub::FindingAggregator
ExampleMetadata: fixture=_generated
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.
public virtual string[]? Regions { get; set; }
Property Value
string[]
Remarks
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 .
CloudformationResource: AWS::SecurityHub::FindingAggregator
ExampleMetadata: fixture=_generated
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
Remarks
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 .
CloudformationResource: AWS::SecurityHub::FindingAggregator
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
The AWS::SecurityHub::FindingAggregator
resource enables cross-Region aggregation.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
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 .
CloudformationResource: AWS::SecurityHub::FindingAggregator
ExampleMetadata: fixture=_generated