cis_scan_configurations

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

Overview

Name	cis_scan_configurations
Type	Resource
Id	aws.inspector2.cis_scan_configurations

Fields

The following fields are returned by SELECT queries:

list_cis_scan_configurations

Name	Datatype	Description
owner_id	string	The CIS scan configuration's owner ID. (pattern: <code>\d{12}|o-[a-z0-9]{10,32}</code>)
scan_configuration_arn	string	The CIS scan configuration's scan configuration ARN. (pattern: <code>arn:aws(-us-gov|-cn)?:inspector2:[a-z]{2}(-gov)?-[a-z]+-[0-9]{1}:[0-9]{12}:owner/(o-[a-z0-9]+|[0-9]{12})/cis-configuration/[0-9a-fA-F-]+</code>)
scan_name	string	The name of the CIS scan configuration.
schedule	object	A schedule.
security_level	string	The CIS scan configuration's security level. (LEVEL_1, LEVEL_2)
tags	object	The CIS scan configuration's tags.
targets	object	The CIS scan configuration's targets.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_cis_scan_configurations	select	region		Lists CIS scan configurations.
create_cis_scan_configuration	insert	region, scanName, securityLevel, schedule, targets		Creates a CIS scan configuration.
update_cis_scan_configuration	update	region, scanConfigurationArn		Updates a CIS scan configuration.
delete_cis_scan_configuration	delete	region		Deletes a CIS scan configuration.

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

list_cis_scan_configurations

Lists CIS scan configurations.

SELECT
owner_id,
scan_configuration_arn,
scan_name,
schedule,
security_level,
tags,
targets
FROM aws.inspector2.cis_scan_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_cis_scan_configuration

Creates a CIS scan configuration.

INSERT INTO aws.inspector2.cis_scan_configurations (
scanName,
securityLevel,
schedule,
targets,
tags,
region
)
SELECT 
'{{ scanName }}' /* required */,
'{{ securityLevel }}' /* required */,
'{{ schedule }}' /* required */,
'{{ targets }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
scan_configuration_arn
;

Manifest

# Description fields are for documentation purposes
- name: cis_scan_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the cis_scan_configurations resource.
  - name: scanName
    value: "{{ scanName }}"
  - name: securityLevel
    value: "{{ securityLevel }}"
    valid_values: ['LEVEL_1', 'LEVEL_2']
  - name: schedule
    description: |
      A schedule.
    value:
      oneTime: "{{ oneTime }}"
      daily:
        startTime:
          timeOfDay: "{{ timeOfDay }}"
          timezone: "{{ timezone }}"
      weekly:
        startTime:
          timeOfDay: "{{ timeOfDay }}"
          timezone: "{{ timezone }}"
        days:
          - "{{ days }}"
      monthly:
        startTime:
          timeOfDay: "{{ timeOfDay }}"
          timezone: "{{ timezone }}"
        day: "{{ day }}"
  - name: targets
    description: |
      Creates CIS targets.
    value:
      accountIds:
        - "{{ accountIds }}"
      targetResourceTags: "{{ targetResourceTags }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_cis_scan_configuration

Updates a CIS scan configuration.

UPDATE aws.inspector2.cis_scan_configurations
SET 
scanConfigurationArn = '{{ scanConfigurationArn }}',
scanName = '{{ scanName }}',
securityLevel = '{{ securityLevel }}',
schedule = '{{ schedule }}',
targets = '{{ targets }}'
WHERE 
region = '{{ region }}' --required
AND scanConfigurationArn = '{{ scanConfigurationArn }}' --required
RETURNING
scan_configuration_arn;

DELETE examples

delete_cis_scan_configuration

Deletes a CIS scan configuration.

DELETE FROM aws.inspector2.cis_scan_configurations
WHERE region = '{{ region }}' --required
;