code_security_scan_configurations

Creates, updates, deletes or gets a code_security_scan_configuration resource or lists code_security_scan_configurations in a region

Overview

Name	code_security_scan_configurations
Type	Resource
Description	Inspector CodeSecurityScanConfiguration resource schema
Id	awscc.inspectorv2.code_security_scan_configurations

Fields

get (all properties)

Name	Datatype	Description
name	string	Code Security Scan Configuration name
level	string	Configuration Level
▶configuration	object	Code Security Scan Configuration
▶scope_settings	object	Scope Settings
arn	string	Code Security Scan Configuration ARN
tags	object
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	Code Security Scan Configuration ARN
region	string	AWS region.

For more information, see AWS::InspectorV2::CodeSecurityScanConfiguration.

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual code_security_scan_configuration.

SELECT
  region,
  name,
  level,
  configuration,
  scope_settings,
  arn,
  tags
FROM awscc.inspectorv2.code_security_scan_configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all code_security_scan_configurations in a region.

SELECT
  region,
  arn
FROM awscc.inspectorv2.code_security_scan_configurations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.inspectorv2.code_security_scan_configurations (
  Name,
  Level,
  Configuration,
  ScopeSettings,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ level }}',
  '{{ configuration }}',
  '{{ scope_settings }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.inspectorv2.code_security_scan_configurations (
  Name,
  Level,
  Configuration,
  ScopeSettings,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ level }}',
  '{{ configuration }}',
  '{{ scope_settings }}',
  '{{ 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: code_security_scan_configuration
  props:
    - name: name
      value: '{{ name }}'
    - name: level
      value: '{{ level }}'
    - name: configuration
      value:
        name: '{{ name }}'
        level: null
        configuration: null
        scope_settings:
          project_selection_scope: '{{ project_selection_scope }}'
        tags: {}
    - name: scope_settings
      value: null
    - name: tags
      value: null

UPDATE example

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

/*+ update */
UPDATE awscc.inspectorv2.code_security_scan_configurations
SET PatchDocument = string('{{ {
    "Configuration": configuration
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

inspector2:CreateCodeSecurityScanConfiguration,
inspector2:GetCodeSecurityScanConfiguration,
inspector2:TagResource

Read

inspector2:GetCodeSecurityScanConfiguration,
inspector2:ListTagsForResource

Update

inspector2:UpdateCodeSecurityScanConfiguration,
inspector2:GetCodeSecurityScanConfiguration,
inspector2:TagResource,
inspector2:UntagResource,
inspector2:ListTagsForResource

Delete

inspector2:DeleteCodeSecurityScanConfiguration,
inspector2:GetCodeSecurityScanConfiguration

List

inspector2:ListCodeSecurityScanConfigurations