Package software.amazon.awscdk.services.securityagent

Class CfnPentest

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.securityagent.CfnPentest
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IPentestRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.129.0 (build eaca441)", date="2026-05-13T16:55:17.694Z") @Stability(Stable) public class CfnPentest extends CfnResource implements IInspectable, IPentestRef
Resource Type definition for AWS::SecurityAgent::Pentest.

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.*;
 CfnPentest cfnPentest = CfnPentest.Builder.create(this, "MyCfnPentest")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPentest

      protected CfnPentest(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPentest

      protected CfnPentest(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPentest

      @Stability(Stable) public CfnPentest(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPentestProps props)
      Create a new AWS::SecurityAgent::Pentest.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnPentest

      @Stability(Stable) @NotNull public static Boolean isCfnPentest(@NotNull Object x)
      Checks whether the given object is a CfnPentest.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      Timestamp when the pentest was created.

    • getAttrPentestId

      @Stability(Stable) @NotNull public String getAttrPentestId()
      Unique identifier of the pentest.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      Timestamp when the pentest was last updated.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getPentestRef

      @Stability(Stable) @NotNull public PentestReference getPentestRef()
      A reference to a Pentest resource.
      Specified by:
      getPentestRef in interface IPentestRef

    • getAgentSpaceId

      @Stability(Stable) @NotNull public String getAgentSpaceId()
      Identifier of agent space where the pentest should be created.

    • setAgentSpaceId

      @Stability(Stable) public void setAgentSpaceId(@NotNull String value)
      Identifier of agent space where the pentest should be created.

    • getAssets

      @Stability(Stable) @NotNull public Object getAssets()
      Collection of assets to be tested during the pentest.

      Returns union: either IResolvable or CfnPentest.AssetsProperty

    • setAssets

      @Stability(Stable) public void setAssets(@NotNull IResolvable value)
      Collection of assets to be tested during the pentest.

    • setAssets

      @Stability(Stable) public void setAssets(@NotNull CfnPentest.AssetsProperty value)
      Collection of assets to be tested during the pentest.

    • getServiceRole

      @Stability(Stable) @NotNull public String getServiceRole()
      Service role for accessing resources.

    • setServiceRole

      @Stability(Stable) public void setServiceRole(@NotNull String value)
      Service role for accessing resources.

    • getCodeRemediationStrategy

      @Stability(Stable) @Nullable public String getCodeRemediationStrategy()
      Strategy for remediating code vulnerabilities discovered during the pentest.

    • setCodeRemediationStrategy

      @Stability(Stable) public void setCodeRemediationStrategy(@Nullable String value)
      Strategy for remediating code vulnerabilities discovered during the pentest.

    • getExcludeRiskTypes

      @Stability(Stable) @Nullable public List<String> getExcludeRiskTypes()
      A list of risk types excluded from the pentest execution.

    • setExcludeRiskTypes

      @Stability(Stable) public void setExcludeRiskTypes(@Nullable List<String> value)
      A list of risk types excluded from the pentest execution.

    • getLogConfig

      @Stability(Stable) @Nullable public Object getLogConfig()
      CloudWatch Logs configuration for pentest output.

      Returns union: either IResolvable or CfnPentest.CloudWatchLogProperty

    • setLogConfig

      @Stability(Stable) public void setLogConfig(@Nullable IResolvable value)
      CloudWatch Logs configuration for pentest output.

    • setLogConfig

      @Stability(Stable) public void setLogConfig(@Nullable CfnPentest.CloudWatchLogProperty value)
      CloudWatch Logs configuration for pentest output.

    • getNetworkTrafficConfig

      @Stability(Stable) @Nullable public Object getNetworkTrafficConfig()
      Network traffic configuration for the pentest.

      Returns union: either IResolvable or CfnPentest.NetworkTrafficConfigProperty

    • setNetworkTrafficConfig

      @Stability(Stable) public void setNetworkTrafficConfig(@Nullable IResolvable value)
      Network traffic configuration for the pentest.

    • setNetworkTrafficConfig

      @Stability(Stable) public void setNetworkTrafficConfig(@Nullable CfnPentest.NetworkTrafficConfigProperty value)
      Network traffic configuration for the pentest.

    • getTitle

      @Stability(Stable) @Nullable public String getTitle()
      Title of the penetration test.

    • setTitle

      @Stability(Stable) public void setTitle(@Nullable String value)
      Title of the penetration test.

    • getVpcConfig

      @Stability(Stable) @Nullable public Object getVpcConfig()
      VPC configuration that the pentest agent accesses.

      Returns union: either IResolvable or CfnPentest.VpcConfigProperty

    • setVpcConfig

      @Stability(Stable) public void setVpcConfig(@Nullable IResolvable value)
      VPC configuration that the pentest agent accesses.

    • setVpcConfig

      @Stability(Stable) public void setVpcConfig(@Nullable CfnPentest.VpcConfigProperty value)
      VPC configuration that the pentest agent accesses.