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

Inherits:

Struct

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

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

• #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.

• #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.

• #log_config ⇒ Types::CloudWatchLog

  The CloudWatch Logs configuration for the 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.

• #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.

• #title ⇒ String

  The title of 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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 4091

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,
  :code_remediation_strategy,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end