Interface PentestJob.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PentestJob.Builder,PentestJob>, SdkBuilder<PentestJob.Builder,PentestJob>, SdkPojo

Enclosing class:

PentestJob

@Mutable
@NotThreadSafe
public static interface PentestJob.Builder
extends SdkPojo, CopyableBuilder<PentestJob.Builder,PentestJob>

Method Summary

Modifier and Type	Method	Description
PentestJob.Builder	actors(Collection<Actor> actors)	List of actors that interact with the system
PentestJob.Builder	actors(Consumer<Actor.Builder>... actors)	List of actors that interact with the system
PentestJob.Builder	actors(Actor... actors)	List of actors that interact with the system
PentestJob.Builder	allowedDomains(Collection<Endpoint> allowedDomains)	List of allowed domains for network access
PentestJob.Builder	allowedDomains(Consumer<Endpoint.Builder>... allowedDomains)	List of allowed domains for network access
PentestJob.Builder	allowedDomains(Endpoint... allowedDomains)	List of allowed domains for network access
PentestJob.Builder	codeRemediationStrategy(String codeRemediationStrategy)	Strategy for code remediation on findings
PentestJob.Builder	codeRemediationStrategy(CodeRemediationStrategy codeRemediationStrategy)	Strategy for code remediation on findings
PentestJob.Builder	createdAt(Instant createdAt)	Timestamp when the pentest job was created
PentestJob.Builder	documents(Collection<DocumentInfo> documents)	List of documents providing context for testing
PentestJob.Builder	documents(Consumer<DocumentInfo.Builder>... documents)	List of documents providing context for testing
PentestJob.Builder	documents(DocumentInfo... documents)	List of documents providing context for testing
PentestJob.Builder	endpoints(Collection<Endpoint> endpoints)	List of web application endpoints to test
PentestJob.Builder	endpoints(Consumer<Endpoint.Builder>... endpoints)	List of web application endpoints to test
PentestJob.Builder	endpoints(Endpoint... endpoints)	List of web application endpoints to test
default PentestJob.Builder	errorInformation(Consumer<ErrorInformation.Builder> errorInformation)	Error information regarding the pentest job
PentestJob.Builder	errorInformation(ErrorInformation errorInformation)	Error information regarding the pentest job
PentestJob.Builder	excludePaths(Collection<Endpoint> excludePaths)	List of URL paths to exclude from testing
PentestJob.Builder	excludePaths(Consumer<Endpoint.Builder>... excludePaths)	List of URL paths to exclude from testing
PentestJob.Builder	excludePaths(Endpoint... excludePaths)	List of URL paths to exclude from testing
PentestJob.Builder	excludeRiskTypes(Collection<RiskType> excludeRiskTypes)	A list of risk types excluded from the pentest job
PentestJob.Builder	excludeRiskTypes(RiskType... excludeRiskTypes)	A list of risk types excluded from the pentest job
PentestJob.Builder	excludeRiskTypesWithStrings(String... excludeRiskTypes)	A list of risk types excluded from the pentest job
PentestJob.Builder	excludeRiskTypesWithStrings(Collection<String> excludeRiskTypes)	A list of risk types excluded from the pentest job
PentestJob.Builder	executionContext(Collection<ExecutionContext> executionContext)	A list of execution context messages associated with the pentest job
PentestJob.Builder	executionContext(Consumer<ExecutionContext.Builder>... executionContext)	A list of execution context messages associated with the pentest job
PentestJob.Builder	executionContext(ExecutionContext... executionContext)	A list of execution context messages associated with the pentest job
PentestJob.Builder	integratedRepositories(Collection<IntegratedRepository> integratedRepositories)	List of integrated code repositories
PentestJob.Builder	integratedRepositories(Consumer<IntegratedRepository.Builder>... integratedRepositories)	List of integrated code repositories
PentestJob.Builder	integratedRepositories(IntegratedRepository... integratedRepositories)	List of integrated code repositories
default PentestJob.Builder	logConfig(Consumer<CloudWatchLog.Builder> logConfig)	CloudWatch log group and stream prefix where pentest job logs are stored
PentestJob.Builder	logConfig(CloudWatchLog logConfig)	CloudWatch log group and stream prefix where pentest job logs are stored
default PentestJob.Builder	networkTrafficConfig(Consumer<NetworkTrafficConfig.Builder> networkTrafficConfig)	Configuration for network traffic filtering
PentestJob.Builder	networkTrafficConfig(NetworkTrafficConfig networkTrafficConfig)	Configuration for network traffic filtering
PentestJob.Builder	overview(String overview)	Overview or description of the pentest job
PentestJob.Builder	pentestId(String pentestId)	Identifier of the parent pentest
PentestJob.Builder	pentestJobId(String pentestJobId)	Unique identifier of the pentest job
PentestJob.Builder	serviceRole(String serviceRole)	Service role ARN for accessing customer resources
PentestJob.Builder	sourceCode(Collection<SourceCodeRepository> sourceCode)	List of source code repositories for static analysis
PentestJob.Builder	sourceCode(Consumer<SourceCodeRepository.Builder>... sourceCode)	List of source code repositories for static analysis
PentestJob.Builder	sourceCode(SourceCodeRepository... sourceCode)	List of source code repositories for static analysis
PentestJob.Builder	status(String status)	Current status of the pentest job
PentestJob.Builder	status(JobStatus status)	Current status of the pentest job
PentestJob.Builder	steps(Collection<Step> steps)	List of execution steps for the pentest job
PentestJob.Builder	steps(Consumer<Step.Builder>... steps)	List of execution steps for the pentest job
PentestJob.Builder	steps(Step... steps)	List of execution steps for the pentest job
PentestJob.Builder	title(String title)	Title or name of the pentest
PentestJob.Builder	updatedAt(Instant updatedAt)	Timestamp when the pentest job was last updated
default PentestJob.Builder	vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)	VPC configuration that the Security Agent accesses
PentestJob.Builder	vpcConfig(VpcConfig vpcConfig)	VPC configuration that the Security Agent accesses

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

pentestJobId

PentestJob.Builder pentestJobId(String pentestJobId)

Unique identifier of the pentest job

Parameters:

pentestJobId - Unique identifier of the pentest job

Returns:

Returns a reference to this object so that method calls can be chained together.

pentestId

PentestJob.Builder pentestId(String pentestId)

Identifier of the parent pentest

Parameters:

pentestId - Identifier of the parent pentest

Returns:

Returns a reference to this object so that method calls can be chained together.

title

PentestJob.Builder title(String title)

Title or name of the pentest

Parameters:

title - Title or name of the pentest

Returns:

Returns a reference to this object so that method calls can be chained together.

overview

PentestJob.Builder overview(String overview)

Overview or description of the pentest job

Parameters:

overview - Overview or description of the pentest job

Returns:

Returns a reference to this object so that method calls can be chained together.

status

PentestJob.Builder status(String status)

Current status of the pentest job

Parameters:

status - Current status of the pentest job

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• JobStatus
• JobStatus

status

PentestJob.Builder status(JobStatus status)

Current status of the pentest job

Parameters:

status - Current status of the pentest job

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• JobStatus
• JobStatus

endpoints

PentestJob.Builder endpoints(Collection<Endpoint> endpoints)

List of web application endpoints to test

Parameters:

endpoints - List of web application endpoints to test

Returns:

Returns a reference to this object so that method calls can be chained together.

endpoints

PentestJob.Builder endpoints(Endpoint... endpoints)

List of web application endpoints to test

Parameters:

endpoints - List of web application endpoints to test

Returns:

Returns a reference to this object so that method calls can be chained together.

endpoints

PentestJob.Builder endpoints(Consumer<Endpoint.Builder>... endpoints)

List of web application endpoints to test

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

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

Parameters:

endpoints - a consumer that will call methods on Endpoint.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• endpoints(java.util.Collection<Endpoint>)

actors

PentestJob.Builder actors(Collection<Actor> actors)

List of actors that interact with the system

Parameters:

actors - List of actors that interact with the system

Returns:

Returns a reference to this object so that method calls can be chained together.

actors

PentestJob.Builder actors(Actor... actors)

List of actors that interact with the system

Parameters:

actors - List of actors that interact with the system

Returns:

Returns a reference to this object so that method calls can be chained together.

actors

PentestJob.Builder actors(Consumer<Actor.Builder>... actors)

List of actors that interact with the system

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

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

Parameters:

actors - a consumer that will call methods on Actor.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• actors(java.util.Collection<Actor>)

documents

PentestJob.Builder documents(Collection<DocumentInfo> documents)

List of documents providing context for testing

Parameters:

documents - List of documents providing context for testing

Returns:

Returns a reference to this object so that method calls can be chained together.

documents

PentestJob.Builder documents(DocumentInfo... documents)

List of documents providing context for testing

Parameters:

documents - List of documents providing context for testing

Returns:

Returns a reference to this object so that method calls can be chained together.

documents

PentestJob.Builder documents(Consumer<DocumentInfo.Builder>... documents)

List of documents providing context for testing

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

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

Parameters:

documents - a consumer that will call methods on DocumentInfo.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• documents(java.util.Collection<DocumentInfo>)

sourceCode

PentestJob.Builder sourceCode(Collection<SourceCodeRepository> sourceCode)

List of source code repositories for static analysis

Parameters:

sourceCode - List of source code repositories for static analysis

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceCode

PentestJob.Builder sourceCode(SourceCodeRepository... sourceCode)

List of source code repositories for static analysis

Parameters:

sourceCode - List of source code repositories for static analysis

Returns:

Returns a reference to this object so that method calls can be chained together.

sourceCode

PentestJob.Builder sourceCode(Consumer<SourceCodeRepository.Builder>... sourceCode)

List of source code repositories for static analysis

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

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

Parameters:

sourceCode - a consumer that will call methods on SourceCodeRepository.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• sourceCode(java.util.Collection<SourceCodeRepository>)

excludePaths

PentestJob.Builder excludePaths(Collection<Endpoint> excludePaths)

List of URL paths to exclude from testing

Parameters:

excludePaths - List of URL paths to exclude from testing

Returns:

Returns a reference to this object so that method calls can be chained together.

excludePaths

PentestJob.Builder excludePaths(Endpoint... excludePaths)

List of URL paths to exclude from testing

Parameters:

excludePaths - List of URL paths to exclude from testing

Returns:

Returns a reference to this object so that method calls can be chained together.

excludePaths

PentestJob.Builder excludePaths(Consumer<Endpoint.Builder>... excludePaths)

List of URL paths to exclude from testing

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

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

Parameters:

excludePaths - a consumer that will call methods on Endpoint.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• excludePaths(java.util.Collection<Endpoint>)

allowedDomains

PentestJob.Builder allowedDomains(Collection<Endpoint> allowedDomains)

List of allowed domains for network access

Parameters:

allowedDomains - List of allowed domains for network access

Returns:

Returns a reference to this object so that method calls can be chained together.

allowedDomains

PentestJob.Builder allowedDomains(Endpoint... allowedDomains)

List of allowed domains for network access

Parameters:

allowedDomains - List of allowed domains for network access

Returns:

Returns a reference to this object so that method calls can be chained together.

allowedDomains

PentestJob.Builder allowedDomains(Consumer<Endpoint.Builder>... allowedDomains)

List of allowed domains for network access

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

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

Parameters:

allowedDomains - a consumer that will call methods on Endpoint.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• allowedDomains(java.util.Collection<Endpoint>)

excludeRiskTypesWithStrings

PentestJob.Builder excludeRiskTypesWithStrings(Collection<String> excludeRiskTypes)

A list of risk types excluded from the pentest job

Parameters:

excludeRiskTypes - A list of risk types excluded from the pentest job

Returns:

Returns a reference to this object so that method calls can be chained together.

excludeRiskTypesWithStrings

PentestJob.Builder excludeRiskTypesWithStrings(String... excludeRiskTypes)

A list of risk types excluded from the pentest job

Parameters:

excludeRiskTypes - A list of risk types excluded from the pentest job

Returns:

Returns a reference to this object so that method calls can be chained together.

excludeRiskTypes

PentestJob.Builder excludeRiskTypes(Collection<RiskType> excludeRiskTypes)

A list of risk types excluded from the pentest job

Parameters:

excludeRiskTypes - A list of risk types excluded from the pentest job

Returns:

Returns a reference to this object so that method calls can be chained together.

excludeRiskTypes

PentestJob.Builder excludeRiskTypes(RiskType... excludeRiskTypes)

A list of risk types excluded from the pentest job

Parameters:

excludeRiskTypes - A list of risk types excluded from the pentest job

Returns:

Returns a reference to this object so that method calls can be chained together.

steps

PentestJob.Builder steps(Collection<Step> steps)

List of execution steps for the pentest job

Parameters:

steps - List of execution steps for the pentest job

Returns:

Returns a reference to this object so that method calls can be chained together.

steps

PentestJob.Builder steps(Step... steps)

List of execution steps for the pentest job

Parameters:

steps - List of execution steps for the pentest job

Returns:

Returns a reference to this object so that method calls can be chained together.

steps

PentestJob.Builder steps(Consumer<Step.Builder>... steps)

List of execution steps for the pentest job

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

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

Parameters:

steps - a consumer that will call methods on Step.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• steps(java.util.Collection<Step>)

executionContext

PentestJob.Builder executionContext(Collection<ExecutionContext> executionContext)

A list of execution context messages associated with the pentest job

Parameters:

executionContext - A list of execution context messages associated with the pentest job

Returns:

Returns a reference to this object so that method calls can be chained together.

executionContext

PentestJob.Builder executionContext(ExecutionContext... executionContext)

A list of execution context messages associated with the pentest job

Parameters:

executionContext - A list of execution context messages associated with the pentest job

Returns:

Returns a reference to this object so that method calls can be chained together.

executionContext

PentestJob.Builder executionContext(Consumer<ExecutionContext.Builder>... executionContext)

A list of execution context messages associated with the pentest job

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

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

Parameters:

executionContext - a consumer that will call methods on ExecutionContext.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• executionContext(java.util.Collection<ExecutionContext>)

serviceRole

PentestJob.Builder serviceRole(String serviceRole)

Service role ARN for accessing customer resources

Parameters:

serviceRole - Service role ARN for accessing customer resources

Returns:

Returns a reference to this object so that method calls can be chained together.

logConfig

PentestJob.Builder logConfig(CloudWatchLog logConfig)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

logConfig

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

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

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:

• logConfig(CloudWatchLog)

vpcConfig

PentestJob.Builder vpcConfig(VpcConfig vpcConfig)

VPC configuration that the Security Agent accesses

Parameters:

vpcConfig - VPC configuration that the Security Agent accesses

Returns:

Returns a reference to this object so that method calls can be chained together.

vpcConfig

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

VPC configuration that the Security Agent accesses

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:

• vpcConfig(VpcConfig)

networkTrafficConfig

PentestJob.Builder networkTrafficConfig(NetworkTrafficConfig networkTrafficConfig)

Configuration for network traffic filtering

Parameters:

networkTrafficConfig - Configuration for network traffic filtering

Returns:

Returns a reference to this object so that method calls can be chained together.

networkTrafficConfig

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

Configuration for network traffic filtering

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:

• networkTrafficConfig(NetworkTrafficConfig)

errorInformation

PentestJob.Builder errorInformation(ErrorInformation errorInformation)

Error information regarding the pentest job

Parameters:

errorInformation - Error information regarding the pentest job

Returns:

Returns a reference to this object so that method calls can be chained together.

errorInformation

default PentestJob.Builder errorInformation(Consumer<ErrorInformation.Builder> errorInformation)

Error information regarding the pentest job

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

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

Parameters:

errorInformation - a consumer that will call methods on ErrorInformation.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• errorInformation(ErrorInformation)

integratedRepositories

PentestJob.Builder integratedRepositories(Collection<IntegratedRepository> integratedRepositories)

List of integrated code repositories

Parameters:

integratedRepositories - List of integrated code repositories

Returns:

Returns a reference to this object so that method calls can be chained together.

integratedRepositories

PentestJob.Builder integratedRepositories(IntegratedRepository... integratedRepositories)

List of integrated code repositories

Parameters:

integratedRepositories - List of integrated code repositories

Returns:

Returns a reference to this object so that method calls can be chained together.

integratedRepositories

PentestJob.Builder integratedRepositories(Consumer<IntegratedRepository.Builder>... integratedRepositories)

List of integrated code repositories

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

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

Parameters:

integratedRepositories - a consumer that will call methods on IntegratedRepository.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• integratedRepositories(java.util.Collection<IntegratedRepository>)

codeRemediationStrategy

PentestJob.Builder codeRemediationStrategy(String codeRemediationStrategy)

Strategy for code remediation on findings

Parameters:

codeRemediationStrategy - Strategy for code remediation on findings

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• CodeRemediationStrategy
• CodeRemediationStrategy

codeRemediationStrategy

PentestJob.Builder codeRemediationStrategy(CodeRemediationStrategy codeRemediationStrategy)

Strategy for code remediation on findings

Parameters:

codeRemediationStrategy - Strategy for code remediation on findings

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• CodeRemediationStrategy
• CodeRemediationStrategy

createdAt

PentestJob.Builder createdAt(Instant createdAt)

Timestamp when the pentest job was created

Parameters:

createdAt - Timestamp when the pentest job was created

Returns:

Returns a reference to this object so that method calls can be chained together.

updatedAt

PentestJob.Builder updatedAt(Instant updatedAt)

Timestamp when the pentest job was last updated

Parameters:

updatedAt - Timestamp when the pentest job was last updated

Returns:

Returns a reference to this object so that method calls can be chained together.