CfnPentestProps Struct
Properties for defining a CfnPentest.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_securityagent as securityagent } from 'aws-cdk-lib';
const cfnPentestProps: securityagent.CfnPentestProps = {
agentSpaceId: 'agentSpaceId',
assets: {
actors: [{
authentication: {
providerType: 'providerType',
value: 'value',
},
description: 'description',
enableEmailMfa: false,
identifier: 'identifier',
mfaForwardingAddress: 'mfaForwardingAddress',
uris: ['uris'],
}],
documents: [{
artifactId: 'artifactId',
s3Location: 's3Location',
}],
endpoints: [{
uri: 'uri',
}],
integratedRepositories: [{
integrationId: 'integrationId',
providerResourceId: 'providerResourceId',
// the properties below are optional
branch: 'branch',
}],
sourceCode: [{
s3Location: 's3Location',
}],
trustedCaCertificates: [{
source: {
artifactId: 'artifactId',
inlinePem: 'inlinePem',
s3Location: 's3Location',
},
}],
},
serviceRole: 'serviceRole',
// the properties below are optional
cleanUpStrategy: 'cleanUpStrategy',
codeRemediationStrategy: 'codeRemediationStrategy',
disableManagedSkills: ['disableManagedSkills'],
excludeRiskTypes: ['excludeRiskTypes'],
logConfig: {
logGroup: 'logGroup',
logStream: 'logStream',
},
networkTrafficConfig: {
customHeaders: [{
name: 'name',
value: 'value',
}],
rules: [{
effect: 'effect',
networkTrafficRuleType: 'networkTrafficRuleType',
pattern: 'pattern',
}],
},
title: 'title',
vpcConfig: {
securityGroupArns: ['securityGroupArns'],
subnetArns: ['subnetArns'],
vpcArn: 'vpcArn',
},
};
Properties
Identifier of agent space where the pentest should be created.
assetsIResolvable | CfnPentest.AssetsPropertyassetstyping.Union[IResolvable, AssetsProperty]assetsIResolvableAssetsIResolvableAssetsinterface{}required#Collection of assets to be tested during the pentest.
cleanUpStrategystringclean_up_strategystrcleanUpStrategyStringCleanUpStrategystringCleanUpStrategy*string#Strategy for cleaning up resources after pentest job completion.
codeRemediationStrategystringcode_remediation_strategystrcodeRemediationStrategyStringCodeRemediationStrategystringCodeRemediationStrategy*string#Strategy for remediating code vulnerabilities discovered during the pentest.
disableManagedSkillsstring[]disable_managed_skillstyping.List[str]disableManagedSkillsList<String>DisableManagedSkillsstring[]DisableManagedSkills*[]*string#A list of managed skills to disable for this pentest.
excludeRiskTypesstring[]exclude_risk_typestyping.List[str]excludeRiskTypesList<String>ExcludeRiskTypesstring[]ExcludeRiskTypes*[]*string#A list of risk types excluded from the pentest execution.
logConfigIResolvable | CfnPentest.CloudWatchLogPropertylog_configtyping.Union[IResolvable, CloudWatchLogProperty]logConfigIResolvableLogConfigIResolvableLogConfiginterface{}#CloudWatch Logs configuration for pentest output.
networkTrafficConfigIResolvable | CfnPentest.NetworkTrafficConfigPropertynetwork_traffic_configtyping.Union[IResolvable, NetworkTrafficConfigProperty]networkTrafficConfigIResolvableNetworkTrafficConfigIResolvableNetworkTrafficConfiginterface{}#Network traffic configuration for the pentest.
Service role for accessing resources.
Title of the penetration test.
vpcConfigIResolvable | CfnPentest.VpcConfigPropertyvpc_configtyping.Union[IResolvable, VpcConfigProperty]vpcConfigIResolvableVpcConfigIResolvableVpcConfiginterface{}#VPC configuration that the pentest agent accesses.