Class: Aws::CodeGuruSecurity::Types::Finding

Inherits:

Struct

• Object
• Struct
• Aws::CodeGuruSecurity::Types::Finding

Defined in:

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

Overview

Information about a finding that was detected in your code.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_at ⇒ Time

  The time when the finding was created.

• #description ⇒ String

  A description of the finding.

• #detector_id ⇒ String

  The identifier for the detector that detected the finding in your code.

• #detector_name ⇒ String

  The name of the detector that identified the security vulnerability in your code.

• #detector_tags ⇒ Array<String>

  One or more tags or categorizations that are associated with a detector.

• #generator_id ⇒ String

  The identifier for the component that generated a finding such as AmazonCodeGuruSecurity.

• #id ⇒ String

  The identifier for a finding.

• #remediation ⇒ Types::Remediation

  An object that contains the details about how to remediate a finding.

• #resource ⇒ Types::Resource

  The resource where Amazon CodeGuru Security detected a finding.

• #rule_id ⇒ String

  The identifier for the rule that generated the finding.

• #severity ⇒ String

  The severity of the finding.

• #status ⇒ String

  The status of the finding.

• #title ⇒ String

  The title of the finding.

• #type ⇒ String

  The type of finding.

• #updated_at ⇒ Time

  The time when the finding was last updated.

• #vulnerability ⇒ Types::Vulnerability

  An object that describes the detected security vulnerability.

Instance Attribute Details

#created_at ⇒ Time

The time when the finding was created.

Returns:

• (Time)

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

class Finding < Struct.new(
  :created_at,
  :description,
  :detector_id,
  :detector_name,
  :detector_tags,
  :generator_id,
  :id,
  :remediation,
  :resource,
  :rule_id,
  :severity,
  :status,
  :title,
  :type,
  :updated_at,
  :vulnerability)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the finding.

Returns:

• (String)

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

class Finding < Struct.new(
  :created_at,
  :description,
  :detector_id,
  :detector_name,
  :detector_tags,
  :generator_id,
  :id,
  :remediation,
  :resource,
  :rule_id,
  :severity,
  :status,
  :title,
  :type,
  :updated_at,
  :vulnerability)
  SENSITIVE = []
  include Aws::Structure
end

#detector_id ⇒ String

The identifier for the detector that detected the finding in your code. A detector is a defined rule based on industry standards and AWS best practices.

Returns:

• (String)

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

class Finding < Struct.new(
  :created_at,
  :description,
  :detector_id,
  :detector_name,
  :detector_tags,
  :generator_id,
  :id,
  :remediation,
  :resource,
  :rule_id,
  :severity,
  :status,
  :title,
  :type,
  :updated_at,
  :vulnerability)
  SENSITIVE = []
  include Aws::Structure
end

#detector_name ⇒ String

The name of the detector that identified the security vulnerability in your code.

Returns:

• (String)

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

class Finding < Struct.new(
  :created_at,
  :description,
  :detector_id,
  :detector_name,
  :detector_tags,
  :generator_id,
  :id,
  :remediation,
  :resource,
  :rule_id,
  :severity,
  :status,
  :title,
  :type,
  :updated_at,
  :vulnerability)
  SENSITIVE = []
  include Aws::Structure
end

#detector_tags ⇒ Array<String>

One or more tags or categorizations that are associated with a detector. These tags are defined by type, programming language, or other classification such as maintainability or consistency.

Returns:

• (Array<String>)

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

class Finding < Struct.new(
  :created_at,
  :description,
  :detector_id,
  :detector_name,
  :detector_tags,
  :generator_id,
  :id,
  :remediation,
  :resource,
  :rule_id,
  :severity,
  :status,
  :title,
  :type,
  :updated_at,
  :vulnerability)
  SENSITIVE = []
  include Aws::Structure
end

#generator_id ⇒ String

The identifier for the component that generated a finding such as AmazonCodeGuruSecurity.

Returns:

• (String)

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

class Finding < Struct.new(
  :created_at,
  :description,
  :detector_id,
  :detector_name,
  :detector_tags,
  :generator_id,
  :id,
  :remediation,
  :resource,
  :rule_id,
  :severity,
  :status,
  :title,
  :type,
  :updated_at,
  :vulnerability)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The identifier for a finding.

Returns:

• (String)

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

class Finding < Struct.new(
  :created_at,
  :description,
  :detector_id,
  :detector_name,
  :detector_tags,
  :generator_id,
  :id,
  :remediation,
  :resource,
  :rule_id,
  :severity,
  :status,
  :title,
  :type,
  :updated_at,
  :vulnerability)
  SENSITIVE = []
  include Aws::Structure
end

#remediation ⇒ Types::Remediation

An object that contains the details about how to remediate a finding.

Returns:

• (Types::Remediation)

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

class Finding < Struct.new(
  :created_at,
  :description,
  :detector_id,
  :detector_name,
  :detector_tags,
  :generator_id,
  :id,
  :remediation,
  :resource,
  :rule_id,
  :severity,
  :status,
  :title,
  :type,
  :updated_at,
  :vulnerability)
  SENSITIVE = []
  include Aws::Structure
end

#resource ⇒ Types::Resource

The resource where Amazon CodeGuru Security detected a finding.

Returns:

• (Types::Resource)

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

class Finding < Struct.new(
  :created_at,
  :description,
  :detector_id,
  :detector_name,
  :detector_tags,
  :generator_id,
  :id,
  :remediation,
  :resource,
  :rule_id,
  :severity,
  :status,
  :title,
  :type,
  :updated_at,
  :vulnerability)
  SENSITIVE = []
  include Aws::Structure
end

#rule_id ⇒ String

The identifier for the rule that generated the finding.

Returns:

• (String)

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

class Finding < Struct.new(
  :created_at,
  :description,
  :detector_id,
  :detector_name,
  :detector_tags,
  :generator_id,
  :id,
  :remediation,
  :resource,
  :rule_id,
  :severity,
  :status,
  :title,
  :type,
  :updated_at,
  :vulnerability)
  SENSITIVE = []
  include Aws::Structure
end

#severity ⇒ String

The severity of the finding. Severity can be critical, high, medium, low, or informational. For information on severity levels, see Finding severity in the Amazon CodeGuru Security User Guide.

Returns:

• (String)

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

class Finding < Struct.new(
  :created_at,
  :description,
  :detector_id,
  :detector_name,
  :detector_tags,
  :generator_id,
  :id,
  :remediation,
  :resource,
  :rule_id,
  :severity,
  :status,
  :title,
  :type,
  :updated_at,
  :vulnerability)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the finding. A finding status can be open or closed.

Returns:

• (String)

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

class Finding < Struct.new(
  :created_at,
  :description,
  :detector_id,
  :detector_name,
  :detector_tags,
  :generator_id,
  :id,
  :remediation,
  :resource,
  :rule_id,
  :severity,
  :status,
  :title,
  :type,
  :updated_at,
  :vulnerability)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title of the finding.

Returns:

• (String)

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

class Finding < Struct.new(
  :created_at,
  :description,
  :detector_id,
  :detector_name,
  :detector_tags,
  :generator_id,
  :id,
  :remediation,
  :resource,
  :rule_id,
  :severity,
  :status,
  :title,
  :type,
  :updated_at,
  :vulnerability)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of finding.

Returns:

• (String)

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

class Finding < Struct.new(
  :created_at,
  :description,
  :detector_id,
  :detector_name,
  :detector_tags,
  :generator_id,
  :id,
  :remediation,
  :resource,
  :rule_id,
  :severity,
  :status,
  :title,
  :type,
  :updated_at,
  :vulnerability)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The time when the finding was last updated. Findings are updated when you remediate them or when the finding code location changes.

Returns:

• (Time)

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

class Finding < Struct.new(
  :created_at,
  :description,
  :detector_id,
  :detector_name,
  :detector_tags,
  :generator_id,
  :id,
  :remediation,
  :resource,
  :rule_id,
  :severity,
  :status,
  :title,
  :type,
  :updated_at,
  :vulnerability)
  SENSITIVE = []
  include Aws::Structure
end

#vulnerability ⇒ Types::Vulnerability

An object that describes the detected security vulnerability.

Returns:

• (Types::Vulnerability)

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

class Finding < Struct.new(
  :created_at,
  :description,
  :detector_id,
  :detector_name,
  :detector_tags,
  :generator_id,
  :id,
  :remediation,
  :resource,
  :rule_id,
  :severity,
  :status,
  :title,
  :type,
  :updated_at,
  :vulnerability)
  SENSITIVE = []
  include Aws::Structure
end