Interface CreatePentestRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreatePentestRequest.Builder,CreatePentestRequest>, SdkBuilder<CreatePentestRequest.Builder,CreatePentestRequest>, SdkPojo, SdkRequest.Builder, SecurityAgentRequest.Builder
Enclosing class:
CreatePentestRequest
@Mutable @NotThreadSafe public static interface CreatePentestRequest.Builder extends SecurityAgentRequest.Builder, SdkPojo, CopyableBuilder<CreatePentestRequest.Builder,CreatePentestRequest>

  • Method Details

    • title

      CreatePentestRequest.Builder title(String title)

      The title of the pentest.

      Parameters:
      title - The title of the pentest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agentSpaceId

      CreatePentestRequest.Builder agentSpaceId(String agentSpaceId)

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

      Parameters:
      agentSpaceId - The unique identifier of the agent space to create the pentest in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assets

      CreatePentestRequest.Builder assets(Assets assets)

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

      Parameters:
      assets - The assets to include in the pentest, such as endpoints, actors, documents, and source code.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assets

      default CreatePentestRequest.Builder assets(Consumer<Assets.Builder> assets)

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

      This is a convenience method that creates an instance of the Assets.Builder avoiding the need to create one manually via Assets.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to assets(Assets).

      Parameters:
      assets - a consumer that will call methods on Assets.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • excludeRiskTypesWithStrings

      CreatePentestRequest.Builder excludeRiskTypesWithStrings(Collection<String> excludeRiskTypes)

      The list of risk types to exclude from the pentest.

      Parameters:
      excludeRiskTypes - The list of risk types to exclude from the pentest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excludeRiskTypesWithStrings

      CreatePentestRequest.Builder excludeRiskTypesWithStrings(String... excludeRiskTypes)

      The list of risk types to exclude from the pentest.

      Parameters:
      excludeRiskTypes - The list of risk types to exclude from the pentest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excludeRiskTypes

      CreatePentestRequest.Builder excludeRiskTypes(Collection<RiskType> excludeRiskTypes)

      The list of risk types to exclude from the pentest.

      Parameters:
      excludeRiskTypes - The list of risk types to exclude from the pentest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excludeRiskTypes

      CreatePentestRequest.Builder excludeRiskTypes(RiskType... excludeRiskTypes)

      The list of risk types to exclude from the pentest.

      Parameters:
      excludeRiskTypes - The list of risk types to exclude from the pentest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceRole

      CreatePentestRequest.Builder serviceRole(String serviceRole)

      The IAM service role to use for the pentest.

      Parameters:
      serviceRole - The IAM service role to use for the pentest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logConfig

      CreatePentestRequest.Builder logConfig(CloudWatchLog logConfig)

      The CloudWatch Logs configuration for the pentest.

      Parameters:
      logConfig - The CloudWatch Logs configuration for the pentest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logConfig

      default CreatePentestRequest.Builder logConfig(Consumer<CloudWatchLog.Builder> logConfig)

      The CloudWatch Logs configuration for the pentest.

      This is a convenience method that creates an instance of the CloudWatchLog.Builder avoiding the need to create one manually via CloudWatchLog.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logConfig(CloudWatchLog).

      Parameters:
      logConfig - a consumer that will call methods on CloudWatchLog.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vpcConfig

      CreatePentestRequest.Builder vpcConfig(VpcConfig vpcConfig)

      The VPC configuration for the pentest.

      Parameters:
      vpcConfig - The VPC configuration for the pentest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      default CreatePentestRequest.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)

      The VPC configuration for the pentest.

      This is a convenience method that creates an instance of the VpcConfig.Builder avoiding the need to create one manually via VpcConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfig(VpcConfig).

      Parameters:
      vpcConfig - a consumer that will call methods on VpcConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • networkTrafficConfig

      CreatePentestRequest.Builder networkTrafficConfig(NetworkTrafficConfig networkTrafficConfig)

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

      Parameters:
      networkTrafficConfig - The network traffic configuration for the pentest, including custom headers and traffic rules.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkTrafficConfig

      default CreatePentestRequest.Builder networkTrafficConfig(Consumer<NetworkTrafficConfig.Builder> networkTrafficConfig)

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

      This is a convenience method that creates an instance of the NetworkTrafficConfig.Builder avoiding the need to create one manually via NetworkTrafficConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to networkTrafficConfig(NetworkTrafficConfig).

      Parameters:
      networkTrafficConfig - a consumer that will call methods on NetworkTrafficConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • codeRemediationStrategy

      CreatePentestRequest.Builder codeRemediationStrategy(String codeRemediationStrategy)

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

      Parameters:
      codeRemediationStrategy - The code remediation strategy for the pentest. Valid values are AUTOMATIC and DISABLED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • codeRemediationStrategy

      CreatePentestRequest.Builder codeRemediationStrategy(CodeRemediationStrategy codeRemediationStrategy)

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

      Parameters:
      codeRemediationStrategy - The code remediation strategy for the pentest. Valid values are AUTOMATIC and DISABLED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • disableManagedSkillsWithStrings

      CreatePentestRequest.Builder disableManagedSkillsWithStrings(Collection<String> disableManagedSkills)

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

      Parameters:
      disableManagedSkills - A list of managed skills to disable for this pentest. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disableManagedSkillsWithStrings

      CreatePentestRequest.Builder disableManagedSkillsWithStrings(String... disableManagedSkills)

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

      Parameters:
      disableManagedSkills - A list of managed skills to disable for this pentest. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disableManagedSkills

      CreatePentestRequest.Builder disableManagedSkills(Collection<SkillType> disableManagedSkills)

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

      Parameters:
      disableManagedSkills - A list of managed skills to disable for this pentest. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • disableManagedSkills

      CreatePentestRequest.Builder disableManagedSkills(SkillType... disableManagedSkills)

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

      Parameters:
      disableManagedSkills - A list of managed skills to disable for this pentest. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxTaskHours

      CreatePentestRequest.Builder maxTaskHours(Double maxTaskHours)

      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.

      Parameters:
      maxTaskHours - 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:
      Returns a reference to this object so that method calls can be chained together.

    • reportDestination

      CreatePentestRequest.Builder reportDestination(ReportDestination reportDestination)

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

      Parameters:
      reportDestination - The destination for publishing scan reports to an integrated document provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reportDestination

      default CreatePentestRequest.Builder reportDestination(Consumer<ReportDestination.Builder> reportDestination)

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

      This is a convenience method that creates an instance of the ReportDestination.Builder avoiding the need to create one manually via ReportDestination.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to reportDestination(ReportDestination).

      Parameters:
      reportDestination - a consumer that will call methods on ReportDestination.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • reportFilters

      CreatePentestRequest.Builder reportFilters(ReportFilters reportFilters)

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

      Parameters:
      reportFilters - The report-generation filters applied when the report is exported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reportFilters

      default CreatePentestRequest.Builder reportFilters(Consumer<ReportFilters.Builder> reportFilters)

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

      This is a convenience method that creates an instance of the ReportFilters.Builder avoiding the need to create one manually via ReportFilters.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to reportFilters(ReportFilters).

      Parameters:
      reportFilters - a consumer that will call methods on ReportFilters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreatePentestRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreatePentestRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.