hub_v2s

Creates, updates, deletes or gets a hub_v2 resource or lists hub_v2s in a region

Overview

Name	hub_v2s
Type	Resource
Description	The AWS::SecurityHub::HubV2 resource represents the implementation of the AWS Security Hub V2 service in your account. Only one hubv2 resource can created in each region in which you enable Security Hub V2.
Id	awscc.securityhub.hub_v2s

Fields

get (all properties)

Name	Datatype	Description
hub_v2_arn	string	The Amazon Resource Name of the Security Hub V2 resource.
subscribed_at	string	The date and time, in UTC and ISO 8601 format.
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
hub_v2_arn	string	The Amazon Resource Name of the Security Hub V2 resource.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	hub_v2s	INSERT	region
delete_resource	hub_v2s	DELETE	Identifier, region
update_resource	hub_v2s	UPDATE	Identifier, PatchDocument, region
list_resources	hub_v2s_list_only	SELECT	region
get_resource	hub_v2s	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual hub_v2.

SELECT
  region,
  hub_v2_arn,
  subscribed_at,
  tags
FROM awscc.securityhub.hub_v2s
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ hub_v2_arn }}';

list (identifiers only)

Lists all hub_v2s in a region.

SELECT
  region,
  hub_v2_arn
FROM awscc.securityhub.hub_v2s_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.securityhub.hub_v2s (
  Tags,
  region
)
SELECT
  '{{ 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: hub_v2
  props:
    - name: tags
      value: {}

UPDATE example

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

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

DELETE example

/*+ delete */
DELETE FROM awscc.securityhub.hub_v2s
WHERE
  Identifier = '{{ hub_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 hub_v2s resource, the following permissions are required:

Create

securityhub:EnableSecurityHubV2,
securityhub:DescribeSecurityHubV2,
securityhub:TagResource,
iam:CreateServiceLinkedRole

Read

securityhub:DescribeSecurityHubV2,
securityhub:ListTagsForResource

Update

securityhub:DescribeSecurityHubV2,
securityhub:TagResource,
securityhub:UntagResource,
securityhub:ListTagsForResource

Delete

securityhub:DescribeSecurityHubV2,
securityhub:DisableSecurityHubV2

List

securityhub:DescribeSecurityHubV2,
securityhub:ListTagsForResource