AWS CLI Command Reference

[ aws . inspector2 ]

create-code-security-scan-configuration

Description

Creates a scan configuration for code security scanning.

See also: AWS API Documentation

Synopsis

  create-code-security-scan-configuration
--configuration <value>
--level <value>
--name <value>
[--scope-settings <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--configuration (structure)

The configuration settings for the code security scan.

continuousIntegrationScanConfiguration -> (structure)

Configuration settings for continuous integration scans that run automatically when code changes are made.

supportedEvents -> (list)

The repository events that trigger continuous integration scans, such as pull requests or commits.

(string)

periodicScanConfiguration -> (structure)

Configuration settings for periodic scans that run on a scheduled basis.

frequency -> (string)

The frequency at which periodic scans are performed (such as weekly or monthly).

If you don’t provide the frequencyExpression Amazon Inspector chooses day for the scan to run. If you provide the frequencyExpression , the schedule must match the specified frequency .

frequencyExpression -> (string)

The schedule expression for periodic scans, in cron format.

ruleSetCategories -> (list)

The categories of security rules to be applied during the scan.

(string)

Shorthand Syntax:

continuousIntegrationScanConfiguration={supportedEvents=[string,string]},periodicScanConfiguration={frequency=string,frequencyExpression=string},ruleSetCategories=string,string

JSON Syntax:

{
  "continuousIntegrationScanConfiguration": {
    "supportedEvents": ["PULL_REQUEST"|"PUSH", ...]
  },
  "periodicScanConfiguration": {
    "frequency": "WEEKLY"|"MONTHLY"|"NEVER",
    "frequencyExpression": "string"
  },
  "ruleSetCategories": ["SAST"|"IAC"|"SCA", ...]
}

--level (string)

The security level for the scan configuration.

Possible values:

  • ORGANIZATION
  • ACCOUNT

--name (string)

The name of the scan configuration.

--scope-settings (structure)

The scope settings that define which repositories will be scanned. Include this parameter to create a default scan configuration. Otherwise Amazon Inspector creates a general scan configuration.

A default scan configuration automatically applies to all existing and future projects imported into Amazon Inspector. Use the BatchAssociateCodeSecurityScanConfiguration operation to associate a general scan configuration with projects.

projectSelectionScope -> (string)

The scope of projects to be selected for scanning within the integrated repositories. Setting the value to ALL applies the scope settings to all existing and future projects imported into Amazon Inspector.

Shorthand Syntax:

projectSelectionScope=string

JSON Syntax:

{
  "projectSelectionScope": "ALL"
}

--tags (map)

The tags to apply to the scan configuration.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

scanConfigurationArn -> (string)

The Amazon Resource Name (ARN) of the created scan configuration.
© Copyright 2025, Amazon Web Services. Created using Sphinx.