Class: Aws::SecurityAgent::Types::Pentest

Inherits:

Struct

• Object
• Struct
• Aws::SecurityAgent::Types::Pentest

Defined in:

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

Overview

Represents a pentest configuration that defines the parameters for security testing, including target assets, risk type exclusions, and infrastructure settings.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #agent_space_id ⇒ String

  The unique identifier of the agent space that contains the pentest.

• #assets ⇒ Types::Assets

  The assets included in the pentest.

• #cicd_configuration ⇒ Types::CiCdConfiguration

  The CI/CD pentesting configuration for this pentest.

• #clean_up_strategy ⇒ String

  Strategy for cleaning up resources after pentest job completion.

• #code_remediation_strategy ⇒ String

  The code remediation strategy for the pentest.

• #created_at ⇒ Time

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

• #disable_managed_skills ⇒ Array<String>

  A list of managed skills to disable for this pentest.

• #exclude_risk_types ⇒ Array<String>

  The list of risk types excluded from the pentest.

• #log_config ⇒ Types::CloudWatchLog

  The CloudWatch Logs configuration for the pentest.

• #max_task_hours ⇒ Float

  The maximum number of billable task hours allowed for jobs started from this pentest.

• #network_traffic_config ⇒ Types::NetworkTrafficConfig

  The network traffic configuration for the pentest.

• #pentest_id ⇒ String

  The unique identifier of the pentest.

• #report_destination ⇒ Types::ReportDestination

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

• #report_filters ⇒ Types::ReportFilters

  The report-generation filters applied when the report is exported.

• #service_role ⇒ String

  The IAM service role used for the pentest.

• #test_scope ⇒ Types::TestScope

  The category of application a pentest targets.

• #title ⇒ String

  The title of the pentest.

• #updated_at ⇒ Time

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

• #vpc_config ⇒ Types::VpcConfig

  The VPC configuration for the pentest.

Instance Attribute Details

#agent_space_id ⇒ String

The unique identifier of the agent space that contains the pentest.

Returns:

• (String)

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

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#assets ⇒ Types::Assets

The assets included in the pentest.

Returns:

• (Types::Assets)

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

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#cicd_configuration ⇒ Types::CiCdConfiguration

The CI/CD pentesting configuration for this pentest. Present when the pentest is set up to run from a CI/CD pipeline.

Returns:

• (Types::CiCdConfiguration)

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

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 7038

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#code_remediation_strategy ⇒ String

The code remediation strategy for the pentest.

Returns:

• (String)

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

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

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

Returns:

• (Time)

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

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#disable_managed_skills ⇒ Array<String>

A list of managed skills to disable for this pentest. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.

Returns:

• (Array<String>)

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

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_risk_types ⇒ Array<String>

The list of risk types excluded from the pentest.

Returns:

• (Array<String>)

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

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#log_config ⇒ Types::CloudWatchLog

The CloudWatch Logs configuration for the pentest.

Returns:

• (Types::CloudWatchLog)

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

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#max_task_hours ⇒ Float

The maximum number of billable task hours allowed for jobs started from this pentest. If a job reaches the configured limit, it is gracefully stopped. If not set, jobs run to completion with no budget cap.

Returns:

• (Float)

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

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#network_traffic_config ⇒ Types::NetworkTrafficConfig

The network traffic configuration for the pentest.

Returns:

• (Types::NetworkTrafficConfig)

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

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#pentest_id ⇒ String

The unique identifier of the pentest.

Returns:

• (String)

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

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 7038

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#report_filters ⇒ Types::ReportFilters

The report-generation filters applied when the report is exported.

Returns:

• (Types::ReportFilters)

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

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#service_role ⇒ String

The IAM service role used for the pentest.

Returns:

• (String)

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

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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 7038

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title of the pentest.

Returns:

• (String)

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

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

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

Returns:

• (Time)

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

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_config ⇒ Types::VpcConfig

The VPC configuration for the pentest.

Returns:

• (Types::VpcConfig)

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

class Pentest < Struct.new(
  :pentest_id,
  :agent_space_id,
  :title,
  :assets,
  :exclude_risk_types,
  :service_role,
  :log_config,
  :vpc_config,
  :network_traffic_config,
  :code_remediation_strategy,
  :clean_up_strategy,
  :disable_managed_skills,
  :max_task_hours,
  :report_destination,
  :report_filters,
  :cicd_configuration,
  :test_scope,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end