Interface StartPentestJobRequest.Builder

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

  • Method Details

    • agentSpaceId

      StartPentestJobRequest.Builder agentSpaceId(String agentSpaceId)

      The unique identifier of the agent space.

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

    • pentestId

      StartPentestJobRequest.Builder pentestId(String pentestId)

      The unique identifier of the pentest to start a job for.

      Parameters:
      pentestId - The unique identifier of the pentest to start a job for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobType

      StartPentestJobRequest.Builder jobType(String jobType)

      The type of pentest job to start. Valid values are FULL, REVALIDATION, and CICD. When set to REVALIDATION, the selectedFindingIds parameter is required. When set to CICD, the scopeChanges parameter defines the code changes to test.

      Parameters:
      jobType - The type of pentest job to start. Valid values are FULL, REVALIDATION, and CICD. When set to REVALIDATION, the selectedFindingIds parameter is required. When set to CICD, the scopeChanges parameter defines the code changes to test.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobType

      StartPentestJobRequest.Builder jobType(JobType jobType)

      The type of pentest job to start. Valid values are FULL, REVALIDATION, and CICD. When set to REVALIDATION, the selectedFindingIds parameter is required. When set to CICD, the scopeChanges parameter defines the code changes to test.

      Parameters:
      jobType - The type of pentest job to start. Valid values are FULL, REVALIDATION, and CICD. When set to REVALIDATION, the selectedFindingIds parameter is required. When set to CICD, the scopeChanges parameter defines the code changes to test.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • selectedFindingIds

      StartPentestJobRequest.Builder selectedFindingIds(Collection<String> selectedFindingIds)

      The list of finding identifiers to revalidate. Required when jobType is REVALIDATION. Each finding must belong to the same agent space and pentest.

      Parameters:
      selectedFindingIds - The list of finding identifiers to revalidate. Required when jobType is REVALIDATION. Each finding must belong to the same agent space and pentest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • selectedFindingIds

      StartPentestJobRequest.Builder selectedFindingIds(String... selectedFindingIds)

      The list of finding identifiers to revalidate. Required when jobType is REVALIDATION. Each finding must belong to the same agent space and pentest.

      Parameters:
      selectedFindingIds - The list of finding identifiers to revalidate. Required when jobType is REVALIDATION. Each finding must belong to the same agent space and pentest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopeChanges

      StartPentestJobRequest.Builder scopeChanges(Collection<ScopeChange> scopeChanges)

      The code changes that define the scope of a CI/CD pentest job. Provide this when starting a job with jobType CICD to test only the changes in the current pipeline run.

      Parameters:
      scopeChanges - The code changes that define the scope of a CI/CD pentest job. Provide this when starting a job with jobType CICD to test only the changes in the current pipeline run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopeChanges

      StartPentestJobRequest.Builder scopeChanges(ScopeChange... scopeChanges)

      The code changes that define the scope of a CI/CD pentest job. Provide this when starting a job with jobType CICD to test only the changes in the current pipeline run.

      Parameters:
      scopeChanges - The code changes that define the scope of a CI/CD pentest job. Provide this when starting a job with jobType CICD to test only the changes in the current pipeline run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopeChanges

      StartPentestJobRequest.Builder scopeChanges(Consumer<ScopeChange.Builder>... scopeChanges)

      The code changes that define the scope of a CI/CD pentest job. Provide this when starting a job with jobType CICD to test only the changes in the current pipeline run.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scopeChanges(List<ScopeChange>).

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

    • overrideConfiguration

      StartPentestJobRequest.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

      StartPentestJobRequest.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.