Class: Aws::SecurityAgent::Types::CreatePentestInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb

Overview

Input for creating a new pentest.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_space_id ⇒ String

The unique identifier of the agent space to create the pentest in.

Returns:

  • (String)


3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 3000

class CreatePentestInput < Struct.new(
  :title,
  :agent_space_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#assets ⇒ Types::Assets

The assets to include in the pentest, such as endpoints, actors, documents, and source code.

Returns:



3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 3000

class CreatePentestInput < Struct.new(
  :title,
  :agent_space_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#cicd_configuration ⇒ Types::CiCdConfiguration

The CI/CD pentesting configuration to apply to the pentest.



3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 3000

class CreatePentestInput < Struct.new(
  :title,
  :agent_space_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#clean_up_strategy ⇒ String

The strategy for cleaning up resources after pentest job completion. Valid values are BEST_EFFORT_DELETE and RETAIN_ALL.

Returns:

  • (String)


3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 3000

class CreatePentestInput < Struct.new(
  :title,
  :agent_space_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#code_remediation_strategy ⇒ String

The code remediation strategy for the pentest. Valid values are AUTOMATIC and DISABLED.

Returns:

  • (String)


3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 3000

class CreatePentestInput < Struct.new(
  :title,
  :agent_space_id,
  :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)
  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>)


3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 3000

class CreatePentestInput < Struct.new(
  :title,
  :agent_space_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_risk_types ⇒ Array<String>

The list of risk types to exclude from the pentest.

Returns:

  • (Array<String>)


3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 3000

class CreatePentestInput < Struct.new(
  :title,
  :agent_space_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#log_config ⇒ Types::CloudWatchLog

The CloudWatch Logs configuration for the pentest.



3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 3000

class CreatePentestInput < Struct.new(
  :title,
  :agent_space_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#max_task_hours ⇒ Float

The maximum number of billable task hours allowed for jobs started from this pentest. Must be a positive number. If not set, jobs run to completion with no budget cap.

Returns:

  • (Float)


3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 3000

class CreatePentestInput < Struct.new(
  :title,
  :agent_space_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#network_traffic_config ⇒ Types::NetworkTrafficConfig

The network traffic configuration for the pentest, including custom headers and traffic rules.



3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 3000

class CreatePentestInput < Struct.new(
  :title,
  :agent_space_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#report_destination ⇒ Types::ReportDestination

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



3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 3000

class CreatePentestInput < Struct.new(
  :title,
  :agent_space_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#report_filters ⇒ Types::ReportFilters

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



3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 3000

class CreatePentestInput < Struct.new(
  :title,
  :agent_space_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#service_role ⇒ String

The IAM service role to use for the pentest.

Returns:

  • (String)


3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 3000

class CreatePentestInput < Struct.new(
  :title,
  :agent_space_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#test_scope ⇒ Types::TestScope

The category of application a pentest targets.

Returns:



3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 3000

class CreatePentestInput < Struct.new(
  :title,
  :agent_space_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title of the pentest.

Returns:

  • (String)


3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 3000

class CreatePentestInput < Struct.new(
  :title,
  :agent_space_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_config ⇒ Types::VpcConfig

The VPC configuration for the pentest.

Returns:



3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
# File 'gems/aws-sdk-securityagent/lib/aws-sdk-securityagent/types.rb', line 3000

class CreatePentestInput < Struct.new(
  :title,
  :agent_space_id,
  :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)
  SENSITIVE = []
  include Aws::Structure
end