security_requirement_packs

Creates, updates, deletes, gets or lists a security_requirement_packs resource.

Overview

Name	security_requirement_packs
Type	Resource
Id	aws.securityagent.security_requirement_packs

Fields

The following fields are returned by SELECT queries:

get_security_requirement_pack

Name	Datatype	Description
name	string	The name of the security requirement pack.
created_at	string (date-time)	The date and time the security requirement pack was created, in UTC format.
description	string	A description of the security requirement pack.
import_status	string	The status of the security requirements import workflow for this pack. (PENDING, IN_PROGRESS, FAILED, COMPLETED)
kms_key_id	string	Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN.
management_type	string	The management type of the pack. Valid values are AWS_MANAGED and CUSTOMER_MANAGED. (AWS_MANAGED, CUSTOMER_MANAGED)
pack_id	string	The unique identifier of the security requirement pack.
status	string	The status of the security requirement pack. (ENABLED, DISABLED)
updated_at	string (date-time)	The date and time the security requirement pack was last updated, in UTC format.
vendor_name	string	The vendor name for AWS managed packs, such as ISO or NIST.

list_security_requirement_packs

Name	Datatype	Description
name	string	The name of the security requirement pack.
created_at	string (date-time)	The date and time the security requirement pack was created, in UTC format.
description	string	A description of the security requirement pack.
management_type	string	The management type of the pack. (AWS_MANAGED, CUSTOMER_MANAGED)
pack_id	string	The unique identifier of the security requirement pack.
status	string	The status of the security requirement pack. (ENABLED, DISABLED)
updated_at	string (date-time)	The date and time the security requirement pack was last updated, in UTC format.
vendor_name	string	The vendor name for AWS managed packs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_security_requirement_pack	select	region		Retrieves information about a security requirement pack.
list_security_requirement_packs	select	region		Lists all security requirement packs in the caller's account.
create_security_requirement_pack	insert	region, name		Creates a customer managed security requirement pack.
update_security_requirement_pack	update	region, packId		Updates a security requirement pack. For customer managed packs, both metadata and status can be updated. For AWS managed packs, only status can be updated.
delete_security_requirement_pack	delete	region		Deletes a customer managed security requirement pack and all its associated security requirements.

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
region	string	AWS region (default: us-east-1)

SELECT examples

get_security_requirement_pack

Retrieves information about a security requirement pack.

SELECT
name,
created_at,
description,
import_status,
kms_key_id,
management_type,
pack_id,
status,
updated_at,
vendor_name
FROM aws.securityagent.security_requirement_packs
WHERE region = '{{ region }}' -- required
;

list_security_requirement_packs

Lists all security requirement packs in the caller's account.

SELECT
name,
created_at,
description,
management_type,
pack_id,
status,
updated_at,
vendor_name
FROM aws.securityagent.security_requirement_packs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_security_requirement_pack

Creates a customer managed security requirement pack.

INSERT INTO aws.securityagent.security_requirement_packs (
name,
description,
status,
kmsKeyId,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ status }}',
'{{ kmsKeyId }}',
'{{ tags }}',
'{{ region }}'
RETURNING
kms_key_id,
pack_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: security_requirement_packs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the security_requirement_packs resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: status
    value: "{{ status }}"
    valid_values: ['ENABLED', 'DISABLED']
  - name: kmsKeyId
    value: "{{ kmsKeyId }}"
    description: |
      Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN.
  - name: tags
    value: "{{ tags }}"
    description: |
      Map of tags for a resource.

UPDATE examples

update_security_requirement_pack

Updates a security requirement pack. For customer managed packs, both metadata and status can be updated. For AWS managed packs, only status can be updated.

UPDATE aws.securityagent.security_requirement_packs
SET 
packId = '{{ packId }}',
name = '{{ name }}',
description = '{{ description }}',
status = '{{ status }}'
WHERE 
region = '{{ region }}' --required
AND packId = '{{ packId }}' --required
RETURNING
name,
description,
pack_id,
status;

DELETE examples

delete_security_requirement_pack

Deletes a customer managed security requirement pack and all its associated security requirements.

DELETE FROM aws.securityagent.security_requirement_packs
WHERE region = '{{ region }}' --required
;