Class: Aws::CodeGuruSecurity::Types::CreateScanRequest

Inherits:

Struct

• Object
• Struct
• Aws::CodeGuruSecurity::Types::CreateScanRequest

Defined in:

gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #analysis_type ⇒ String

  The type of analysis you want CodeGuru Security to perform in the scan, either Security or All.

• #client_token ⇒ String

  The idempotency token for the request.

• #resource_id ⇒ Types::ResourceId

  The identifier for an input resource used to create a scan.

• #scan_name ⇒ String

  The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource.

• #scan_type ⇒ String

  The type of scan, either Standard or Express.

• #tags ⇒ Hash<String,String>

  An array of key-value pairs used to tag a scan.

Instance Attribute Details

#analysis_type ⇒ String

The type of analysis you want CodeGuru Security to perform in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings. Defaults to Security type if missing.

Returns:

• (String)

# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/types.rb', line 264

class CreateScanRequest < Struct.new(
  :analysis_type,
  :client_token,
  :resource_id,
  :scan_name,
  :scan_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/types.rb', line 264

class CreateScanRequest < Struct.new(
  :analysis_type,
  :client_token,
  :resource_id,
  :scan_name,
  :scan_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#resource_id ⇒ Types::ResourceId

The identifier for an input resource used to create a scan.

Returns:

• (Types::ResourceId)

# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/types.rb', line 264

class CreateScanRequest < Struct.new(
  :analysis_type,
  :client_token,
  :resource_id,
  :scan_name,
  :scan_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#scan_name ⇒ String

The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a STANDARD scan type. If not specified, it will be auto generated.

Returns:

• (String)

# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/types.rb', line 264

class CreateScanRequest < Struct.new(
  :analysis_type,
  :client_token,
  :resource_id,
  :scan_name,
  :scan_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#scan_type ⇒ String

The type of scan, either Standard or Express. Defaults to Standard type if missing.

Express scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. Standard scans have standard resource limits and use the full set of detectors to analyze your code.

Returns:

• (String)

# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/types.rb', line 264

class CreateScanRequest < Struct.new(
  :analysis_type,
  :client_token,
  :resource_id,
  :scan_name,
  :scan_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:

• A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.

• An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/types.rb', line 264

class CreateScanRequest < Struct.new(
  :analysis_type,
  :client_token,
  :resource_id,
  :scan_name,
  :scan_type,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end