aggregator_v2s

Creates, updates, deletes, gets or lists an aggregator_v2s resource.

Overview

Name	aggregator_v2s
Type	Resource
Id	aws.securityhub.aggregator_v2s

Fields

The following fields are returned by SELECT queries:

get_aggregator_v2

Name	Datatype	Description
aggregation_region	string	The Amazon Web Services Region where data is aggregated. (pattern: <code>.\S.</code>)
aggregator_v2_arn	string	The ARN of the Aggregator V2. (pattern: <code>.\S.</code>)
linked_regions	array	The list of Regions that are linked to the aggregation Region.
region_linking_mode	string	Determines how Regions are linked to an Aggregator V2. (pattern: <code>.\S.</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_aggregator_v2	select	aggregator_v2_arn, region		Returns the configuration of the specified Aggregator V2.
create_aggregator_v2	insert	region, RegionLinkingMode		Enables aggregation across Amazon Web Services Regions.
update_aggregator_v2	update	aggregator_v2_arn, region, RegionLinkingMode		Udpates the configuration for the Aggregator V2.
delete_aggregator_v2	delete	aggregator_v2_arn, region		Deletes the Aggregator V2.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
aggregator_v2_arn	string	The ARN of the Aggregator V2.
region	string	AWS region (default: us-east-1)

SELECT examples

get_aggregator_v2

Returns the configuration of the specified Aggregator V2.

SELECT
aggregation_region,
aggregator_v2_arn,
linked_regions,
region_linking_mode
FROM aws.securityhub.aggregator_v2s
WHERE aggregator_v2_arn = '{{ aggregator_v2_arn }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_aggregator_v2

Enables aggregation across Amazon Web Services Regions.

INSERT INTO aws.securityhub.aggregator_v2s (
RegionLinkingMode,
LinkedRegions,
Tags,
ClientToken,
region
)
SELECT 
'{{ RegionLinkingMode }}' /* required */,
'{{ LinkedRegions }}',
'{{ Tags }}',
'{{ ClientToken }}',
'{{ region }}'
RETURNING
aggregation_region,
aggregator_v2_arn,
linked_regions,
region_linking_mode
;

Manifest

# Description fields are for documentation purposes
- name: aggregator_v2s
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the aggregator_v2s resource.
  - name: RegionLinkingMode
    value: "{{ RegionLinkingMode }}"
  - name: LinkedRegions
    value:
      - "{{ LinkedRegions }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: ClientToken
    value: "{{ ClientToken }}"

UPDATE examples

update_aggregator_v2

Udpates the configuration for the Aggregator V2.

UPDATE aws.securityhub.aggregator_v2s
SET 
RegionLinkingMode = '{{ RegionLinkingMode }}',
LinkedRegions = '{{ LinkedRegions }}'
WHERE 
aggregator_v2_arn = '{{ aggregator_v2_arn }}' --required
AND region = '{{ region }}' --required
AND RegionLinkingMode = '{{ RegionLinkingMode }}' --required
RETURNING
aggregation_region,
aggregator_v2_arn,
linked_regions,
region_linking_mode;

DELETE examples

delete_aggregator_v2

Deletes the Aggregator V2.

DELETE FROM aws.securityhub.aggregator_v2s
WHERE aggregator_v2_arn = '{{ aggregator_v2_arn }}' --required
AND region = '{{ region }}' --required
;