standards

Creates, updates, deletes or gets a standard resource or lists standards in a region

Overview

Name	standards
Type	Resource
Description	The AWS::SecurityHub::Standard resource specifies the enablement of a security standard. The standard is identified by the StandardsArn property. To view a list of ASH standards and their Amazon Resource Names (ARNs), use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation. You must create a separate AWS::SecurityHub::Standard resource for each standard that you want to enable. For more information about ASH standards, see [standards reference](https://docs.aws.amazon.com/securityhub/latest/userguide/standards-reference.html) in the *User Guide*.
Id	aws.securityhub.standards

Fields

Name	Datatype	Description
standards_subscription_arn	string
standards_arn	string	The ARN of the standard that you want to enable. To view a list of available ASH standards and their ARNs, use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.
disabled_standards_controls	array	Specifies which controls are to be disabled in a standard. *Maximum*: 100
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	StandardsArn, 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 standards in a region.

SELECT
region,
standards_subscription_arn,
standards_arn,
disabled_standards_controls
FROM aws.securityhub.standards
WHERE region = 'us-east-1';

Gets all properties from an individual standard.

SELECT
region,
standards_subscription_arn,
standards_arn,
disabled_standards_controls
FROM aws.securityhub.standards
WHERE region = 'us-east-1' AND data__Identifier = '<StandardsSubscriptionArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.securityhub.standards (
 StandardsArn,
 region
)
SELECT 
'{{ StandardsArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.securityhub.standards (
 StandardsArn,
 DisabledStandardsControls,
 region
)
SELECT 
 '{{ StandardsArn }}',
 '{{ DisabledStandardsControls }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: standard
    props:
      - name: StandardsArn
        value: '{{ StandardsArn }}'
      - name: DisabledStandardsControls
        value:
          - StandardsControlArn: '{{ StandardsControlArn }}'
            Reason: '{{ Reason }}'

DELETE example

/*+ delete */
DELETE FROM aws.securityhub.standards
WHERE data__Identifier = '<StandardsSubscriptionArn>'
AND region = 'us-east-1';

Permissions

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

Create

securityhub:GetEnabledStandards,
securityhub:BatchEnableStandards,
securityhub:UpdateStandardsControl

Read

securityhub:GetEnabledStandards,
securityhub:DescribeStandardsControls

Update

securityhub:GetEnabledStandards,
securityhub:UpdateStandardsControl

Delete

securityhub:GetEnabledStandards,
securityhub:BatchDisableStandards

List

securityhub:GetEnabledStandards