code_security_scan_configurations

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

Overview

Name	code_security_scan_configurations
Type	Resource
Id	aws.inspector2.code_security_scan_configurations

Fields

The following fields are returned by SELECT queries:

get_code_security_scan_configuration

Name	Datatype	Description
name	string	The name of the scan configuration. (pattern: <code>[a-zA-Z0-9-_$:.]*</code>)
configuration	object	Contains the configuration settings for code security scans.
created_at	string (date-time)	The timestamp when the scan configuration was created.
last_updated_at	string (date-time)	The timestamp when the scan configuration was last updated.
level	string	The security level for the scan configuration. (ORGANIZATION, ACCOUNT)
scan_configuration_arn	string	arn:aws:inspector2:::owner//codesecurity-configuration/ (pattern: <code>arn:(aws[a-zA-Z-]*)?:inspector2:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:owner/(\d{12}|o-[a-z0-9]{10,32})/codesecurity-configuration/[a-f0-9-]{36}</code>)
scope_settings	object	Defines the scope of repositories to be included in code security scans.
tags	object	The tags associated with the scan configuration.

list_code_security_scan_configurations

Name	Datatype	Description
configurations	array	A list of code security scan configuration summaries.
next_token	string	A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_code_security_scan_configuration	select	region		Retrieves information about a code security scan configuration.
list_code_security_scan_configurations	select	region	nextToken, maxResults	Lists all code security scan configurations in your account.
create_code_security_scan_configuration	insert	region, name, level, configuration		Creates a scan configuration for code security scanning.
update_code_security_scan_configuration	update	region, scanConfigurationArn, configuration		Updates an existing code security scan configuration.
delete_code_security_scan_configuration	delete	region		Deletes a code security 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)
maxResults	integer	The maximum number of results to return in a single call.
nextToken	string	A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

SELECT examples

get_code_security_scan_configuration

Retrieves information about a code security scan configuration.

SELECT
name,
configuration,
created_at,
last_updated_at,
level,
scan_configuration_arn,
scope_settings,
tags
FROM aws.inspector2.code_security_scan_configurations
WHERE region = '{{ region }}' -- required
;

list_code_security_scan_configurations

Lists all code security scan configurations in your account.

SELECT
configurations,
next_token
FROM aws.inspector2.code_security_scan_configurations
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_code_security_scan_configuration

Creates a scan configuration for code security scanning.

INSERT INTO aws.inspector2.code_security_scan_configurations (
name,
level,
configuration,
scopeSettings,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ level }}' /* required */,
'{{ configuration }}' /* required */,
'{{ scopeSettings }}',
'{{ tags }}',
'{{ region }}'
RETURNING
scan_configuration_arn
;

Manifest

# Description fields are for documentation purposes
- name: code_security_scan_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the code_security_scan_configurations resource.
  - name: name
    value: "{{ name }}"
  - name: level
    value: "{{ level }}"
    valid_values: ['ORGANIZATION', 'ACCOUNT']
  - name: configuration
    description: |
      Contains the configuration settings for code security scans.
    value:
      periodicScanConfiguration:
        frequency: "{{ frequency }}"
        frequencyExpression: "{{ frequencyExpression }}"
      continuousIntegrationScanConfiguration:
        supportedEvents:
          - "{{ supportedEvents }}"
      ruleSetCategories:
        - "{{ ruleSetCategories }}"
  - name: scopeSettings
    description: |
      Defines the scope of repositories to be included in code security scans.
    value:
      projectSelectionScope: "{{ projectSelectionScope }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_code_security_scan_configuration

Updates an existing code security scan configuration.

UPDATE aws.inspector2.code_security_scan_configurations
SET 
scanConfigurationArn = '{{ scanConfigurationArn }}',
configuration = '{{ configuration }}'
WHERE 
region = '{{ region }}' --required
AND scanConfigurationArn = '{{ scanConfigurationArn }}' --required
AND configuration = '{{ configuration }}' --required
RETURNING
scan_configuration_arn;

DELETE examples

delete_code_security_scan_configuration

Deletes a code security scan configuration.

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