Class: Aws::SecurityAgent::Types::PentestJob

Inherits:

Struct

Object
Struct
Aws::SecurityAgent::Types::PentestJob

show all

Defined in:: gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb

Overview

Represents a pentest job, which is an execution instance of a pentest. A pentest job progresses through preflight, static analysis, pentest, and finalizing steps.

Constant Summary collapse

SENSITIVE =

[:trusted_ca_certificates]

Instance Attribute Summary collapse

#actors ⇒ Array<Types::Actor>
The list of actors used during the pentest job.
#allowed_domains ⇒ Array<Types::Endpoint>
The list of domains allowed during the pentest job.
#cicd_configuration ⇒ Types::CiCdConfiguration
The configuration that enables a pentest to run as part of a CI/CD pipeline, scoped to the code changes in each pipeline run.
#clean_up_strategy ⇒ String
Strategy for cleaning up resources after pentest job completion.
#code_remediation_strategy ⇒ String
The code remediation strategy for the pentest job.
#created_at ⇒ Time
The date and time the pentest job was created, in UTC format.
#disable_managed_skills ⇒ Array<String>
A list of managed skills disabled for this pentest job.
#documents ⇒ Array<Types::DocumentInfo>
The list of documents providing context for the pentest job.
#endpoints ⇒ Array<Types::Endpoint>
The list of endpoints being tested in the pentest job.
#error_information ⇒ Types::ErrorInformation
Error information if the pentest job encountered an error.
#exclude_paths ⇒ Array<Types::Endpoint>
The list of paths excluded from the pentest job.
#exclude_risk_types ⇒ Array<String>
The list of risk types excluded from the pentest job.
#execution_context ⇒ Array<Types::ExecutionContext>
The execution context messages for the pentest job.
#integrated_repositories ⇒ Array<Types::IntegratedRepository>
The list of integrated repositories associated with the pentest job.
#job_type ⇒ String
The type of the pentest job.
#log_config ⇒ Types::CloudWatchLog
The CloudWatch Logs configuration for the pentest job.
#max_task_hours ⇒ Float
The maximum number of billable task hours allowed for this pentest job.
#network_traffic_config ⇒ Types::NetworkTrafficConfig
The network traffic configuration for the pentest job.
#overview ⇒ String
An overview of the pentest job results.
#pentest_id ⇒ String
The unique identifier of the pentest associated with the job.
#pentest_job_id ⇒ String
The unique identifier of the pentest job.
#report_destination ⇒ Types::ReportDestination
The destination for publishing scan reports to an integrated document provider.
#report_url ⇒ String
The URL to view this pentest job's findings report in the console.
#scope_changes ⇒ Array<Types::ScopeChange>
The code changes that defined the scope of this CI/CD pentest job.
#scope_result ⇒ Types::ScopeResult
The scoping outcome for this CI/CD pentest job.
#selected_finding_ids ⇒ Array<String>
The list of finding identifiers selected for revalidation.
#service_role ⇒ String
The IAM service role used for the pentest job.
#source_code ⇒ Array<Types::SourceCodeRepository>
The list of source code repositories analyzed during the pentest job.
#status ⇒ String
The current status of the pentest job.
#steps ⇒ Array<Types::Step>
The list of steps in the pentest job execution.
#test_scope ⇒ Types::TestScope
The category of application a pentest targets.
#title ⇒ String
The title of the pentest job.
#trusted_ca_certificates ⇒ Array<Types::TrustedCaCertificate>
The trust anchors used to validate target endpoint TLS certificates during the pentest job.
#updated_at ⇒ Time
The date and time the pentest job was last updated, in UTC format.
#vpc_config ⇒ Types::VpcConfig
The VPC configuration for the pentest job.

Instance Attribute Details

#actors ⇒ `Array<Types::Actor>`

The list of actors used during the pentest job.

Returns:

(Array<Types::Actor>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#allowed_domains ⇒ `Array<Types::Endpoint>`

The list of domains allowed during the pentest job.

Returns:

(Array<Types::Endpoint>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#cicd_configuration ⇒ `Types::CiCdConfiguration`

The configuration that enables a pentest to run as part of a CI/CD pipeline, scoped to the code changes in each pipeline run.

Returns:

(Types::CiCdConfiguration)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#clean_up_strategy ⇒ `String`

Strategy for cleaning up resources after pentest job completion.

Returns:

(String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#code_remediation_strategy ⇒ `String`

The code remediation strategy for the pentest job.

Returns:

(String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#created_at ⇒ `Time`

The date and time the pentest job was created, in UTC format.

Returns:

(Time)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#disable_managed_skills ⇒ `Array<String>`

A list of managed skills disabled for this pentest job. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.

Returns:

(Array<String>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#documents ⇒ `Array<Types::DocumentInfo>`

The list of documents providing context for the pentest job.

Returns:

(Array<Types::DocumentInfo>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#endpoints ⇒ `Array<Types::Endpoint>`

The list of endpoints being tested in the pentest job.

Returns:

(Array<Types::Endpoint>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#error_information ⇒ `Types::ErrorInformation`

Error information if the pentest job encountered an error.

Returns:

(Types::ErrorInformation)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#exclude_paths ⇒ `Array<Types::Endpoint>`

The list of paths excluded from the pentest job.

Returns:

(Array<Types::Endpoint>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#exclude_risk_types ⇒ `Array<String>`

The list of risk types excluded from the pentest job.

Returns:

(Array<String>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#execution_context ⇒ `Array<Types::ExecutionContext>`

The execution context messages for the pentest job.

Returns:

(Array<Types::ExecutionContext>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#integrated_repositories ⇒ `Array<Types::IntegratedRepository>`

The list of integrated repositories associated with the pentest job.

Returns:

(Array<Types::IntegratedRepository>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#job_type ⇒ `String`

The type of the pentest job. Valid values are FULL, REVALIDATION, and CICD.

Returns:

(String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#log_config ⇒ `Types::CloudWatchLog`

The CloudWatch Logs configuration for the pentest job.

Returns:

(Types::CloudWatchLog)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#max_task_hours ⇒ `Float`

The maximum number of billable task hours allowed for this pentest job. If the cumulative task hours reach this limit, the job is gracefully stopped.

Returns:

(Float)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#network_traffic_config ⇒ `Types::NetworkTrafficConfig`

The network traffic configuration for the pentest job.

Returns:

(Types::NetworkTrafficConfig)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#overview ⇒ `String`

An overview of the pentest job results.

Returns:

(String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#pentest_id ⇒ `String`

The unique identifier of the pentest associated with the job.

Returns:

(String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#pentest_job_id ⇒ `String`

The unique identifier of the pentest job.

Returns:

(String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#report_destination ⇒ `Types::ReportDestination`

The destination for publishing scan reports to an integrated document provider.

Returns:

(Types::ReportDestination)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#report_url ⇒ `String`

The URL to view this pentest job's findings report in the console.

Returns:

(String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#scope_changes ⇒ `Array<Types::ScopeChange>`

The code changes that defined the scope of this CI/CD pentest job. Present only for jobs of type CICD.

Returns:

(Array<Types::ScopeChange>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#scope_result ⇒ `Types::ScopeResult`

The scoping outcome for this CI/CD pentest job. Present only for jobs of type CICD.

Returns:

(Types::ScopeResult)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#selected_finding_ids ⇒ `Array<String>`

The list of finding identifiers selected for revalidation. Present only when jobType is REVALIDATION.

Returns:

(Array<String>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#service_role ⇒ `String`

The IAM service role used for the pentest job.

Returns:

(String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#source_code ⇒ `Array<Types::SourceCodeRepository>`

The list of source code repositories analyzed during the pentest job.

Returns:

(Array<Types::SourceCodeRepository>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#status ⇒ `String`

The current status of the pentest job.

Returns:

(String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#steps ⇒ `Array<Types::Step>`

The list of steps in the pentest job execution.

Returns:

(Array<Types::Step>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#test_scope ⇒ `Types::TestScope`

The category of application a pentest targets.

Returns:

(Types::TestScope)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#title ⇒ `String`

The title of the pentest job.

Returns:

(String)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#trusted_ca_certificates ⇒ `Array<Types::TrustedCaCertificate>`

The trust anchors used to validate target endpoint TLS certificates during the pentest job.

Returns:

(Array<Types::TrustedCaCertificate>)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#updated_at ⇒ `Time`

The date and time the pentest job was last updated, in UTC format.

Returns:

(Time)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

#vpc_config ⇒ `Types::VpcConfig`

The VPC configuration for the pentest job.

Returns:

(Types::VpcConfig)

# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 7219

class PentestJob < Struct.new(
  :pentest_job_id,
  :pentest_id,
  :title,
  :overview,
  :status,
  :endpoints,
  :actors,
  :documents,
  :source_code,
  :exclude_paths,
  :allowed_domains,
  :exclude_risk_types,
  :steps,
  :execution_context,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :error_information,
  :integrated_repositories,
  :trusted_ca_certificates,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :job_type,
  :selected_finding_ids,
  :report_destination,
  :report_url,
  :scope_result,
  :scope_changes,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = [:trusted_ca_certificates]
  include Aws::Structure
end

Class: Aws::SecurityAgent::Types::PentestJob

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#actors ⇒ Array<Types::Actor>

#allowed_domains ⇒ Array<Types::Endpoint>

#cicd_configuration ⇒ Types::CiCdConfiguration

#clean_up_strategy ⇒ String

#code_remediation_strategy ⇒ String

#created_at ⇒ Time

#disable_managed_skills ⇒ Array<String>

#documents ⇒ Array<Types::DocumentInfo>

#endpoints ⇒ Array<Types::Endpoint>

#error_information ⇒ Types::ErrorInformation

#exclude_paths ⇒ Array<Types::Endpoint>

#exclude_risk_types ⇒ Array<String>

#execution_context ⇒ Array<Types::ExecutionContext>

#integrated_repositories ⇒ Array<Types::IntegratedRepository>

#job_type ⇒ String

#log_config ⇒ Types::CloudWatchLog

#max_task_hours ⇒ Float

#network_traffic_config ⇒ Types::NetworkTrafficConfig

#overview ⇒ String

#pentest_id ⇒ String

#pentest_job_id ⇒ String

#report_destination ⇒ Types::ReportDestination

#report_url ⇒ String

#scope_changes ⇒ Array<Types::ScopeChange>

#scope_result ⇒ Types::ScopeResult

#selected_finding_ids ⇒ Array<String>

#service_role ⇒ String

#source_code ⇒ Array<Types::SourceCodeRepository>

#status ⇒ String

#steps ⇒ Array<Types::Step>

#test_scope ⇒ Types::TestScope

#title ⇒ String

#trusted_ca_certificates ⇒ Array<Types::TrustedCaCertificate>

#updated_at ⇒ Time

#vpc_config ⇒ Types::VpcConfig

#actors ⇒ `Array<Types::Actor>`

#allowed_domains ⇒ `Array<Types::Endpoint>`

#cicd_configuration ⇒ `Types::CiCdConfiguration`

#clean_up_strategy ⇒ `String`

#code_remediation_strategy ⇒ `String`

#created_at ⇒ `Time`

#disable_managed_skills ⇒ `Array<String>`

#documents ⇒ `Array<Types::DocumentInfo>`

#endpoints ⇒ `Array<Types::Endpoint>`

#error_information ⇒ `Types::ErrorInformation`

#exclude_paths ⇒ `Array<Types::Endpoint>`

#exclude_risk_types ⇒ `Array<String>`

#execution_context ⇒ `Array<Types::ExecutionContext>`

#integrated_repositories ⇒ `Array<Types::IntegratedRepository>`

#job_type ⇒ `String`

#log_config ⇒ `Types::CloudWatchLog`

#max_task_hours ⇒ `Float`

#network_traffic_config ⇒ `Types::NetworkTrafficConfig`

#overview ⇒ `String`

#pentest_id ⇒ `String`

#pentest_job_id ⇒ `String`

#report_destination ⇒ `Types::ReportDestination`

#report_url ⇒ `String`

#scope_changes ⇒ `Array<Types::ScopeChange>`

#scope_result ⇒ `Types::ScopeResult`

#selected_finding_ids ⇒ `Array<String>`

#service_role ⇒ `String`

#source_code ⇒ `Array<Types::SourceCodeRepository>`

#status ⇒ `String`

#steps ⇒ `Array<Types::Step>`

#test_scope ⇒ `Types::TestScope`

#title ⇒ `String`

#trusted_ca_certificates ⇒ `Array<Types::TrustedCaCertificate>`

#updated_at ⇒ `Time`

#vpc_config ⇒ `Types::VpcConfig`