aggregator_v2s

Creates, updates, deletes or gets an aggregator_v2 resource or lists aggregator_v2s in a region

Overview

Name	aggregator_v2s
Type	Resource
Description	The AWS::SecurityHub::AggregatorV2 resource represents the AWS Security Hub AggregatorV2 in your account. One aggregatorv2 resource is created for each account in non opt-in region in which you configure region linking mode.
Id	awscc.securityhub.aggregator_v2s

Fields

Name	Datatype	Description
aggregator_v2_arn	string	The ARN of the AggregatorV2 being created and assigned as the unique identifier
region_linking_mode	string	Indicates to link a list of included Regions
linked_regions	array	The list of included Regions
tags	object	A key-value pair to associate with the Security Hub V2 resource. You can specify a key that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
region	string	AWS region.

For more information, see AWS::SecurityHub::AggregatorV2.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	RegionLinkingMode, LinkedRegions, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual aggregator_v2.

SELECT
region,
aggregator_v2_arn,
region_linking_mode,
linked_regions,
tags,
aggregation_region
FROM awscc.securityhub.aggregator_v2s
WHERE region = 'us-east-1' AND data__Identifier = '<AggregatorV2Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new aggregator_v2 resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.securityhub.aggregator_v2s (
 RegionLinkingMode,
 LinkedRegions,
 region
)
SELECT 
'{{ RegionLinkingMode }}',
 '{{ LinkedRegions }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.securityhub.aggregator_v2s (
 RegionLinkingMode,
 LinkedRegions,
 Tags,
 region
)
SELECT 
 '{{ RegionLinkingMode }}',
 '{{ LinkedRegions }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: aggregator_v2
    props:
      - name: RegionLinkingMode
        value: '{{ RegionLinkingMode }}'
      - name: LinkedRegions
        value:
          - '{{ LinkedRegions[0] }}'
      - name: Tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM awscc.securityhub.aggregator_v2s
WHERE data__Identifier = '<AggregatorV2Arn>'
AND region = 'us-east-1';

Permissions

To operate on the aggregator_v2s resource, the following permissions are required:

Create

securityhub:CreateAggregatorV2,
securityhub:GetAggregatorV2,
securityhub:TagResource,
securityhub:ListTagsForResource

Read

securityhub:GetAggregatorV2,
securityhub:ListTagsForResource

Update

securityhub:UpdateAggregatorV2,
securityhub:GetAggregatorV2,
securityhub:TagResource,
securityhub:UntagResource,
securityhub:ListTagsForResource

Delete

securityhub:DeleteAggregatorV2

List

securityhub:ListAggregatorsV2,
securityhub:ListTagsForResource