Package software.amazon.awscdk.services.securityagent

Interface CfnPentestProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPentestProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-24T20:29:37.172Z")
@Stability(Stable)
public interface CfnPentestProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPentest.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.securityagent.*;
 CfnPentestProps cfnPentestProps = CfnPentestProps.builder()
         .agentSpaceId("agentSpaceId")
         .assets(AssetsProperty.builder()
                 .actors(List.of(ActorProperty.builder()
                         .authentication(AuthenticationProperty.builder()
                                 .providerType("providerType")
                                 .value("value")
                                 .build())
                         .description("description")
                         .identifier("identifier")
                         .uris(List.of("uris"))
                         .build()))
                 .documents(List.of(DocumentInfoProperty.builder()
                         .artifactId("artifactId")
                         .s3Location("s3Location")
                         .build()))
                 .endpoints(List.of(EndpointProperty.builder()
                         .uri("uri")
                         .build()))
                 .integratedRepositories(List.of(IntegratedRepositoryProperty.builder()
                         .integrationId("integrationId")
                         .providerResourceId("providerResourceId")
                         .build()))
                 .sourceCode(List.of(SourceCodeRepositoryProperty.builder()
                         .s3Location("s3Location")
                         .build()))
                 .build())
         .serviceRole("serviceRole")
         // the properties below are optional
         .codeRemediationStrategy("codeRemediationStrategy")
         .excludeRiskTypes(List.of("excludeRiskTypes"))
         .logConfig(CloudWatchLogProperty.builder()
                 .logGroup("logGroup")
                 .logStream("logStream")
                 .build())
         .networkTrafficConfig(NetworkTrafficConfigProperty.builder()
                 .customHeaders(List.of(CustomHeaderProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .rules(List.of(NetworkTrafficRuleProperty.builder()
                         .effect("effect")
                         .networkTrafficRuleType("networkTrafficRuleType")
                         .pattern("pattern")
                         .build()))
                 .build())
         .title("title")
         .vpcConfig(VpcConfigProperty.builder()
                 .securityGroupArns(List.of("securityGroupArns"))
                 .subnetArns(List.of("subnetArns"))
                 .vpcArn("vpcArn")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPentestProps.Builder	A builder for CfnPentestProps
static final class	CfnPentestProps.Jsii$Proxy	An implementation for CfnPentestProps

Method Summary

Modifier and Type	Method	Description
static CfnPentestProps.Builder	builder()
String	getAgentSpaceId()	Identifier of agent space where the pentest should be created.
Object	getAssets()	Collection of assets to be tested during the pentest.
default String	getCodeRemediationStrategy()	Strategy for remediating code vulnerabilities discovered during the pentest.
default List<String>	getExcludeRiskTypes()	A list of risk types excluded from the pentest execution.
default Object	getLogConfig()	CloudWatch Logs configuration for pentest output.
default Object	getNetworkTrafficConfig()	Network traffic configuration for the pentest.
String	getServiceRole()	Service role for accessing resources.
default String	getTitle()	Title of the penetration test.
default Object	getVpcConfig()	VPC configuration that the pentest agent accesses.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAgentSpaceId

@Stability(Stable)
@NotNull
String getAgentSpaceId()

Identifier of agent space where the pentest should be created.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-agentspaceid

getAssets

@Stability(Stable)
@NotNull
Object getAssets()

Collection of assets to be tested during the pentest.

Returns union: either IResolvable or CfnPentest.AssetsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-assets

getServiceRole

@Stability(Stable)
@NotNull
String getServiceRole()

Service role for accessing resources.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-servicerole

getCodeRemediationStrategy

@Stability(Stable)
@Nullable
default String getCodeRemediationStrategy()

Strategy for remediating code vulnerabilities discovered during the pentest.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-coderemediationstrategy

getExcludeRiskTypes

@Stability(Stable)
@Nullable
default List<String> getExcludeRiskTypes()

A list of risk types excluded from the pentest execution.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-excluderisktypes

getLogConfig

@Stability(Stable)
@Nullable
default Object getLogConfig()

CloudWatch Logs configuration for pentest output.

Returns union: either IResolvable or CfnPentest.CloudWatchLogProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-logconfig

getNetworkTrafficConfig

@Stability(Stable)
@Nullable
default Object getNetworkTrafficConfig()

Network traffic configuration for the pentest.

Returns union: either IResolvable or CfnPentest.NetworkTrafficConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-networktrafficconfig

getTitle

@Stability(Stable)
@Nullable
default String getTitle()

Title of the penetration test.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-title

getVpcConfig

@Stability(Stable)
@Nullable
default Object getVpcConfig()

VPC configuration that the pentest agent accesses.

Returns union: either IResolvable or CfnPentest.VpcConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html#cfn-securityagent-pentest-vpcconfig

builder

@Stability(Stable)
static CfnPentestProps.Builder builder()

Returns:

a CfnPentestProps.Builder of CfnPentestProps