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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-codegurusecurity/types.rb

Overview

Information about a finding that was detected in your code.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#created_atTime

The time when the finding was created.

Returns:

  • (Time)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
# File '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

#descriptionString

A description of the finding.

Returns:

  • (String)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
# File '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_idString

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)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
# File '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_nameString

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

Returns:

  • (String)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
# File '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_tagsArray<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>)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
# File '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_idString

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

Returns:

  • (String)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
# File '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

#idString

The identifier for a finding.

Returns:

  • (String)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
# File '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

#remediationTypes::Remediation

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

Returns:



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
# File '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

#resourceTypes::Resource

The resource where Amazon CodeGuru Security detected a finding.

Returns:



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
# File '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_idString

The identifier for the rule that generated the finding.

Returns:

  • (String)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
# File '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

#severityString

The severity of the finding. Severity can be critical, high, medium, low, or informational. For information on severity levels, see

Finding severity][1

in the *Amazon CodeGuru Security User Guide*.

[1]: docs.aws.amazon.com/codeguru/latest/security-ug/findings-overview.html#severity-distribution

Returns:

  • (String)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
# File '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

#statusString

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

Returns:

  • (String)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
# File '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

#titleString

The title of the finding.

Returns:

  • (String)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
# File '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

#typeString

The type of finding.

Returns:

  • (String)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
# File '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_atTime

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

Returns:

  • (Time)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
# File '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

#vulnerabilityTypes::Vulnerability

An object that describes the detected security vulnerability.



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
# File '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