securityagent/aws.sdk.kotlin.services.securityagent.model/PentestJob/Builder

Builder

class Builder

Properties

actors

var actors: List<Actor>?

The list of actors used during the pentest job.

allowedDomains

var allowedDomains: List<Endpoint>?

The list of domains allowed during the pentest job.

cleanUpStrategy

var cleanUpStrategy: CleanUpStrategy?

Strategy for cleaning up resources after pentest job completion.

codeRemediationStrategy

var codeRemediationStrategy: CodeRemediationStrategy?

The code remediation strategy for the pentest job.

createdAt

var createdAt: Instant?

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

disableManagedSkills

var disableManagedSkills: List<SkillType>?

A list of managed skills disabled for this pentest job. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.

documents

var documents: List<DocumentInfo>?

The list of documents providing context for the pentest job.

endpoints

var endpoints: List<Endpoint>?

The list of endpoints being tested in the pentest job.

errorInformation

var errorInformation: ErrorInformation?

Error information if the pentest job encountered an error.

excludePaths

var excludePaths: List<Endpoint>?

The list of paths excluded from the pentest job.

excludeRiskTypes

var excludeRiskTypes: List<RiskType>?

The list of risk types excluded from the pentest job.

executionContext

var executionContext: List<ExecutionContext>?

The execution context messages for the pentest job.

integratedRepositories

var integratedRepositories: List<IntegratedRepository>?

The list of integrated repositories associated with the pentest job.

jobType

var jobType: JobType?

The type of the pentest job. Valid values are FULL and REVALIDATION.

logConfig

var logConfig: CloudWatchLog?

The CloudWatch Logs configuration for the pentest job.

maxTaskHours

var maxTaskHours: Double?

The maximum number of billable task hours allowed for this pentest job. If the cumulative task hours reach this limit, the job is gracefully stopped.

networkTrafficConfig

var networkTrafficConfig: NetworkTrafficConfig?

The network traffic configuration for the pentest job.

overview

var overview: String?

An overview of the pentest job results.

pentestId

var pentestId: String?

The unique identifier of the pentest associated with the job.

pentestJobId

var pentestJobId: String?

The unique identifier of the pentest job.

selectedFindingIds

var selectedFindingIds: List<String>?

The list of finding identifiers selected for revalidation. Present only when jobType is REVALIDATION.

serviceRole

var serviceRole: String?

The IAM service role used for the pentest job.

sourceCode

var sourceCode: List<SourceCodeRepository>?

The list of source code repositories analyzed during the pentest job.

status

var status: JobStatus?

The current status of the pentest job.

steps

var steps: List<Step>?

The list of steps in the pentest job execution.

title

var title: String?

The title of the pentest job.

trustedCaCertificates

var trustedCaCertificates: List<TrustedCaCertificate>?

The trust anchors used to validate target endpoint TLS certificates during the pentest job.

updatedAt

var updatedAt: Instant?

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

vpcConfig

var vpcConfig: VpcConfig?

The VPC configuration for the pentest job.

Functions

errorInformation

fun errorInformation(block: ErrorInformation.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.securityagent.model.ErrorInformation inside the given block

logConfig

fun logConfig(block: CloudWatchLog.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.securityagent.model.CloudWatchLog inside the given block

networkTrafficConfig

fun networkTrafficConfig(block: NetworkTrafficConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.securityagent.model.NetworkTrafficConfig inside the given block

vpcConfig

fun vpcConfig(block: VpcConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.securityagent.model.VpcConfig inside the given block