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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #actors ⇒ Array<Types::Actor>

  List of actors that interact with the system.

• #allowed_domains ⇒ Array<Types::Endpoint>

  List of allowed domains for network access.

• #code_remediation_strategy ⇒ String

  Strategy for code remediation on findings.

• #created_at ⇒ Time

  Timestamp when the pentest job was created.

• #documents ⇒ Array<Types::DocumentInfo>

  List of documents providing context for testing.

• #endpoints ⇒ Array<Types::Endpoint>

  List of web application endpoints to test.

• #error_information ⇒ Types::ErrorInformation

  Error information regarding the pentest job.

• #exclude_paths ⇒ Array<Types::Endpoint>

  List of URL paths to exclude from testing.

• #exclude_risk_types ⇒ Array<String>

  A list of risk types excluded from the pentest job.

• #execution_context ⇒ Array<Types::ExecutionContext>

  A list of execution context messages associated with the pentest job.

• #integrated_repositories ⇒ Array<Types::IntegratedRepository>

  List of integrated code repositories.

• #log_config ⇒ Types::CloudWatchLog

  CloudWatch log group and stream prefix where pentest job logs are stored.

• #network_traffic_config ⇒ Types::NetworkTrafficConfig

  Configuration for network traffic filtering.

• #overview ⇒ String

  Overview or description of the pentest job.

• #pentest_id ⇒ String

  Identifier of the parent pentest.

• #pentest_job_id ⇒ String

  Unique identifier of the pentest job.

• #service_role ⇒ String

  Service role ARN for accessing customer resources.

• #source_code ⇒ Array<Types::SourceCodeRepository>

  List of source code repositories for static analysis.

• #status ⇒ String

  Current status of the pentest job.

• #steps ⇒ Array<Types::Step>

  List of execution steps for the pentest job.

• #title ⇒ String

  Title or name of the pentest.

• #updated_at ⇒ Time

  Timestamp when the pentest job was last updated.

• #vpc_config ⇒ Types::VpcConfig

  VPC configuration that the Security Agent accesses.

Instance Attribute Details

#actors ⇒ Array<Types::Actor>

List of actors that interact with the system

Returns:

• (Array<Types::Actor>)

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

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>

List of allowed domains for network access

Returns:

• (Array<Types::Endpoint>)

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

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

Strategy for code remediation on findings

Returns:

• (String)

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

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

Timestamp when the pentest job was created

Returns:

• (Time)

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

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>

List of documents providing context for testing

Returns:

• (Array<Types::DocumentInfo>)

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

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>

List of web application endpoints to test

Returns:

• (Array<Types::Endpoint>)

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

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 regarding the pentest job

Returns:

• (Types::ErrorInformation)

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

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>

List of URL paths to exclude from testing

Returns:

• (Array<Types::Endpoint>)

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

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>

A list of risk types excluded from the pentest job

Returns:

• (Array<String>)

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

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>

A list of execution context messages associated with the pentest job

Returns:

• (Array<Types::ExecutionContext>)

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

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>

List of integrated code repositories

Returns:

• (Array<Types::IntegratedRepository>)

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

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

CloudWatch log group and stream prefix where pentest job logs are stored

Returns:

• (Types::CloudWatchLog)

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

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

Configuration for network traffic filtering

Returns:

• (Types::NetworkTrafficConfig)

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

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

Overview or description of the pentest job

Returns:

• (String)

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

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

Identifier of the parent pentest

Returns:

• (String)

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

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

Unique identifier of the pentest job

Returns:

• (String)

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

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

Service role ARN for accessing customer resources

Returns:

• (String)

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

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>

List of source code repositories for static analysis

Returns:

• (Array<Types::SourceCodeRepository>)

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

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

Current status of the pentest job

Returns:

• (String)

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

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>

List of execution steps for the pentest job

Returns:

• (Array<Types::Step>)

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

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

Title or name of the pentest

Returns:

• (String)

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

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

Timestamp when the pentest job was last updated

Returns:

• (Time)

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

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

VPC configuration that the Security Agent accesses

Returns:

• (Types::VpcConfig)

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

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