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

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
aggregator_v2_arn	string	The ARN of the AggregatorV2 being created and assigned as the unique identifier
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	aggregator_v2s	INSERT	RegionLinkingMode, LinkedRegions, region
delete_resource	aggregator_v2s	DELETE	Identifier, region
update_resource	aggregator_v2s	UPDATE	Identifier, PatchDocument, region
list_resources	aggregator_v2s_list_only	SELECT	region
get_resource	aggregator_v2s	SELECT	Identifier, region

SELECT examples

get (all properties)

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 = '{{ region }}' AND
  Identifier = '{{ aggregator_v2_arn }}';

list (identifiers only)

Lists all aggregator_v2s in a region.

SELECT
  region,
  aggregator_v2_arn
FROM awscc.securityhub.aggregator_v2s_list_only
WHERE
  region = '{{ region }}';

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
  '{{ region_linking_mode }}',
  '{{ linked_regions }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.securityhub.aggregator_v2s (
  RegionLinkingMode,
  LinkedRegions,
  Tags,
  region
)
SELECT
  '{{ region_linking_mode }}',
  '{{ linked_regions }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

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

UPDATE example

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

/*+ update */
UPDATE awscc.securityhub.aggregator_v2s
SET PatchDocument = string('{{ {
    "RegionLinkingMode": region_linking_mode,
    "LinkedRegions": linked_regions,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ aggregator_v2_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.securityhub.aggregator_v2s
WHERE
  Identifier = '{{ aggregator_v2_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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