AWS::SecurityHub::AggregatorV2 - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::SecurityHub::AggregatorV2

Enables aggregation across AWS Regions. This API is in public preview and subject to change.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SecurityHub::AggregatorV2",
  "Properties" : {
      "LinkedRegions" : [ String, ... ],
      "RegionLinkingMode" : String,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::SecurityHub::AggregatorV2
Properties:
  LinkedRegions: 
    - String
  RegionLinkingMode: String
  Tags: 
    Key: Value

Properties

LinkedRegions

The list of Regions that are linked to the aggregation Region.

Required: Yes

Type: Array of String

Minimum: 1

Maximum: 50

Update requires: No interruption

RegionLinkingMode

Determines how Regions are linked to an Aggregator V2.

Required: Yes

Type: String

Allowed values: SPECIFIED_REGIONS

Update requires: No interruption

Tags

A list of key-value pairs to be applied to the AggregatorV2.

Required: No

Type: Object of String

Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Minimum: 0

Maximum: 256

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the AggregatorV2ARN for the AggregatorV2 created: arn:aws:securityhub:region:123456789012:aggregatorv2/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

AggregationRegion

The AWS Region where data is aggregated.

AggregatorV2Arn

The ARN of the AggregatorV2.