CfnPentestPropsMixin

class aws_cdk.cfn_property_mixins.aws_securityagent.CfnPentestPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::SecurityAgent::Pentest.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityagent-pentest.html
CloudformationResource:: AWS::SecurityAgent::Pentest
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityagent as securityagent
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_pentest_props_mixin = securityagent.CfnPentestPropsMixin(securityagent.CfnPentestMixinProps(
    agent_space_id="agentSpaceId",
    assets=securityagent.CfnPentestPropsMixin.AssetsProperty(
        actors=[securityagent.CfnPentestPropsMixin.ActorProperty(
            authentication=securityagent.CfnPentestPropsMixin.AuthenticationProperty(
                provider_type="providerType",
                value="value"
            ),
            description="description",
            identifier="identifier",
            uris=["uris"]
        )],
        documents=[securityagent.CfnPentestPropsMixin.DocumentInfoProperty(
            artifact_id="artifactId",
            s3_location="s3Location"
        )],
        endpoints=[securityagent.CfnPentestPropsMixin.EndpointProperty(
            uri="uri"
        )],
        integrated_repositories=[securityagent.CfnPentestPropsMixin.IntegratedRepositoryProperty(
            integration_id="integrationId",
            provider_resource_id="providerResourceId"
        )],
        source_code=[securityagent.CfnPentestPropsMixin.SourceCodeRepositoryProperty(
            s3_location="s3Location"
        )]
    ),
    code_remediation_strategy="codeRemediationStrategy",
    exclude_risk_types=["excludeRiskTypes"],
    log_config=securityagent.CfnPentestPropsMixin.CloudWatchLogProperty(
        log_group="logGroup",
        log_stream="logStream"
    ),
    network_traffic_config=securityagent.CfnPentestPropsMixin.NetworkTrafficConfigProperty(
        custom_headers=[securityagent.CfnPentestPropsMixin.CustomHeaderProperty(
            name="name",
            value="value"
        )],
        rules=[securityagent.CfnPentestPropsMixin.NetworkTrafficRuleProperty(
            effect="effect",
            network_traffic_rule_type="networkTrafficRuleType",
            pattern="pattern"
        )]
    ),
    service_role="serviceRole",
    title="title",
    vpc_config=securityagent.CfnPentestPropsMixin.VpcConfigProperty(
        security_group_arns=["securityGroupArns"],
        subnet_arns=["subnetArns"],
        vpc_arn="vpcArn"
    )
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::SecurityAgent::Pentest.

Parameters:

props (Union[CfnPentestMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['agentSpaceId', 'assets', 'codeRemediationStrategy', 'excludeRiskTypes', 'logConfig', 'networkTrafficConfig', 'serviceRole', 'title', 'vpcConfig']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

ActorProperty

class CfnPentestPropsMixin.ActorProperty(*, authentication=None, description=None, identifier=None, uris=None)

Bases: object

An authenticated actor to be used during pentest execution.

Parameters:

authentication (Union[IResolvable, AuthenticationProperty, Dict[str, Any], None]) – Authentication configuration for a pentest actor.
description (Optional[str]) – Description of the actor.
identifier (Optional[str]) – Identifier for the actor.
uris (Optional[Sequence[str]]) – List of URIs this actor is authorized to access.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-actor.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityagent as securityagent

actor_property = securityagent.CfnPentestPropsMixin.ActorProperty(
    authentication=securityagent.CfnPentestPropsMixin.AuthenticationProperty(
        provider_type="providerType",
        value="value"
    ),
    description="description",
    identifier="identifier",
    uris=["uris"]
)

Attributes

authentication

Authentication configuration for a pentest actor.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-actor.html#cfn-securityagent-pentest-actor-authentication

description

Description of the actor.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-actor.html#cfn-securityagent-pentest-actor-description

identifier

Identifier for the actor.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-actor.html#cfn-securityagent-pentest-actor-identifier

uris

List of URIs this actor is authorized to access.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-actor.html#cfn-securityagent-pentest-actor-uris

AssetsProperty

class CfnPentestPropsMixin.AssetsProperty(*, actors=None, documents=None, endpoints=None, integrated_repositories=None, source_code=None)

Bases: object

Collection of assets to be tested during the pentest.

Parameters:

actors (Union[IResolvable, Sequence[Union[IResolvable, ActorProperty, Dict[str, Any]]], None]) – List of actors used during testing.
documents (Union[IResolvable, Sequence[Union[IResolvable, DocumentInfoProperty, Dict[str, Any]]], None]) – List of documents providing additional context for the pentest.
endpoints (Union[IResolvable, Sequence[Union[IResolvable, EndpointProperty, Dict[str, Any]]], None]) – List of endpoints to test.
integrated_repositories (Union[IResolvable, Sequence[Union[IResolvable, IntegratedRepositoryProperty, Dict[str, Any]]], None]) – List of repositories connected via provider integrations.
source_code (Union[IResolvable, Sequence[Union[IResolvable, SourceCodeRepositoryProperty, Dict[str, Any]]], None]) – List of source code repositories to analyze.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-assets.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityagent as securityagent

assets_property = securityagent.CfnPentestPropsMixin.AssetsProperty(
    actors=[securityagent.CfnPentestPropsMixin.ActorProperty(
        authentication=securityagent.CfnPentestPropsMixin.AuthenticationProperty(
            provider_type="providerType",
            value="value"
        ),
        description="description",
        identifier="identifier",
        uris=["uris"]
    )],
    documents=[securityagent.CfnPentestPropsMixin.DocumentInfoProperty(
        artifact_id="artifactId",
        s3_location="s3Location"
    )],
    endpoints=[securityagent.CfnPentestPropsMixin.EndpointProperty(
        uri="uri"
    )],
    integrated_repositories=[securityagent.CfnPentestPropsMixin.IntegratedRepositoryProperty(
        integration_id="integrationId",
        provider_resource_id="providerResourceId"
    )],
    source_code=[securityagent.CfnPentestPropsMixin.SourceCodeRepositoryProperty(
        s3_location="s3Location"
    )]
)

Attributes

actors

List of actors used during testing.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-assets.html#cfn-securityagent-pentest-assets-actors

documents

List of documents providing additional context for the pentest.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-assets.html#cfn-securityagent-pentest-assets-documents

endpoints

List of endpoints to test.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-assets.html#cfn-securityagent-pentest-assets-endpoints

integrated_repositories

List of repositories connected via provider integrations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-assets.html#cfn-securityagent-pentest-assets-integratedrepositories

source_code

List of source code repositories to analyze.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-assets.html#cfn-securityagent-pentest-assets-sourcecode

AuthenticationProperty

class CfnPentestPropsMixin.AuthenticationProperty(*, provider_type=None, value=None)

Bases: object

Authentication configuration for a pentest actor.

Parameters:

provider_type (Optional[str]) – Type of authentication provider.
value (Optional[str]) – Reference value for the authentication provider, such as a secret ARN or Lambda ARN.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-authentication.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityagent as securityagent

authentication_property = securityagent.CfnPentestPropsMixin.AuthenticationProperty(
    provider_type="providerType",
    value="value"
)

Attributes

provider_type

Type of authentication provider.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-authentication.html#cfn-securityagent-pentest-authentication-providertype

value

Reference value for the authentication provider, such as a secret ARN or Lambda ARN.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-authentication.html#cfn-securityagent-pentest-authentication-value

CloudWatchLogProperty

class CfnPentestPropsMixin.CloudWatchLogProperty(*, log_group=None, log_stream=None)

Bases: object

CloudWatch Logs configuration for pentest output.

Parameters:

log_group (Optional[str]) – CloudWatch log group.
log_stream (Optional[str]) – CloudWatch log stream.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-cloudwatchlog.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityagent as securityagent

cloud_watch_log_property = securityagent.CfnPentestPropsMixin.CloudWatchLogProperty(
    log_group="logGroup",
    log_stream="logStream"
)

Attributes

log_group

CloudWatch log group.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-cloudwatchlog.html#cfn-securityagent-pentest-cloudwatchlog-loggroup

log_stream

CloudWatch log stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-cloudwatchlog.html#cfn-securityagent-pentest-cloudwatchlog-logstream

CustomHeaderProperty

class CfnPentestPropsMixin.CustomHeaderProperty(*, name=None, value=None)

Bases: object

A custom header to include in outbound requests.

Parameters:

name (Optional[str]) – Name of the header.
value (Optional[str]) – Value of the header.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-customheader.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityagent as securityagent

custom_header_property = securityagent.CfnPentestPropsMixin.CustomHeaderProperty(
    name="name",
    value="value"
)

Attributes

name

Name of the header.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-customheader.html#cfn-securityagent-pentest-customheader-name

value

Value of the header.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-customheader.html#cfn-securityagent-pentest-customheader-value

DocumentInfoProperty

class CfnPentestPropsMixin.DocumentInfoProperty(*, artifact_id=None, s3_location=None)

Bases: object

A document stored in S3 that provides context for the pentest.

Parameters:

artifact_id (Optional[str]) – Artifact identifier.
s3_location (Optional[str]) – S3 document location.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-documentinfo.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityagent as securityagent

document_info_property = securityagent.CfnPentestPropsMixin.DocumentInfoProperty(
    artifact_id="artifactId",
    s3_location="s3Location"
)

Attributes

artifact_id

Artifact identifier.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-documentinfo.html#cfn-securityagent-pentest-documentinfo-artifactid

s3_location

S3 document location.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-documentinfo.html#cfn-securityagent-pentest-documentinfo-s3location

EndpointProperty

class CfnPentestPropsMixin.EndpointProperty(*, uri=None)

Bases: object

An endpoint to be tested during the pentest.

Parameters:: uri (Optional[str]) – URI of the endpoint to test.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-endpoint.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityagent as securityagent

endpoint_property = securityagent.CfnPentestPropsMixin.EndpointProperty(
    uri="uri"
)

Attributes

uri

URI of the endpoint to test.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-endpoint.html#cfn-securityagent-pentest-endpoint-uri

IntegratedRepositoryProperty

class CfnPentestPropsMixin.IntegratedRepositoryProperty(*, integration_id=None, provider_resource_id=None)

Bases: object

A repository connected via a provider integration.

Parameters:

integration_id (Optional[str]) – Unique identifier of the provider integration.
provider_resource_id (Optional[str]) – Identifier of the resource within the provider integration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-integratedrepository.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityagent as securityagent

integrated_repository_property = securityagent.CfnPentestPropsMixin.IntegratedRepositoryProperty(
    integration_id="integrationId",
    provider_resource_id="providerResourceId"
)

Attributes

integration_id

Unique identifier of the provider integration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-integratedrepository.html#cfn-securityagent-pentest-integratedrepository-integrationid

provider_resource_id

Identifier of the resource within the provider integration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-integratedrepository.html#cfn-securityagent-pentest-integratedrepository-providerresourceid

NetworkTrafficConfigProperty

class CfnPentestPropsMixin.NetworkTrafficConfigProperty(*, custom_headers=None, rules=None)

Bases: object

Network traffic configuration for the pentest.

Parameters:

custom_headers (Union[IResolvable, Sequence[Union[IResolvable, CustomHeaderProperty, Dict[str, Any]]], None]) – Custom headers to include in outbound requests.
rules (Union[IResolvable, Sequence[Union[IResolvable, NetworkTrafficRuleProperty, Dict[str, Any]]], None]) – Ordered list of network traffic rules.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-networktrafficconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityagent as securityagent

network_traffic_config_property = securityagent.CfnPentestPropsMixin.NetworkTrafficConfigProperty(
    custom_headers=[securityagent.CfnPentestPropsMixin.CustomHeaderProperty(
        name="name",
        value="value"
    )],
    rules=[securityagent.CfnPentestPropsMixin.NetworkTrafficRuleProperty(
        effect="effect",
        network_traffic_rule_type="networkTrafficRuleType",
        pattern="pattern"
    )]
)

Attributes

custom_headers

Custom headers to include in outbound requests.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-networktrafficconfig.html#cfn-securityagent-pentest-networktrafficconfig-customheaders

rules

Ordered list of network traffic rules.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-networktrafficconfig.html#cfn-securityagent-pentest-networktrafficconfig-rules

NetworkTrafficRuleProperty

class CfnPentestPropsMixin.NetworkTrafficRuleProperty(*, effect=None, network_traffic_rule_type=None, pattern=None)

Bases: object

Network traffic rule.

Parameters:

effect (Optional[str]) – Whether to allow or deny traffic matching this rule.
network_traffic_rule_type (Optional[str]) – Type of pattern matching for this rule.
pattern (Optional[str]) – URL pattern this rule applies to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-networktrafficrule.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityagent as securityagent

network_traffic_rule_property = securityagent.CfnPentestPropsMixin.NetworkTrafficRuleProperty(
    effect="effect",
    network_traffic_rule_type="networkTrafficRuleType",
    pattern="pattern"
)

Attributes

effect

Whether to allow or deny traffic matching this rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-networktrafficrule.html#cfn-securityagent-pentest-networktrafficrule-effect

network_traffic_rule_type

Type of pattern matching for this rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-networktrafficrule.html#cfn-securityagent-pentest-networktrafficrule-networktrafficruletype

pattern

URL pattern this rule applies to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-networktrafficrule.html#cfn-securityagent-pentest-networktrafficrule-pattern

SourceCodeRepositoryProperty

class CfnPentestPropsMixin.SourceCodeRepositoryProperty(*, s3_location=None)

Bases: object

A source code archive stored in S3 for analysis during the pentest.

Parameters:: s3_location (Optional[str]) – S3 source code location.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-sourcecoderepository.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityagent as securityagent

source_code_repository_property = securityagent.CfnPentestPropsMixin.SourceCodeRepositoryProperty(
    s3_location="s3Location"
)

Attributes

s3_location

S3 source code location.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-sourcecoderepository.html#cfn-securityagent-pentest-sourcecoderepository-s3location

VpcConfigProperty

class CfnPentestPropsMixin.VpcConfigProperty(*, security_group_arns=None, subnet_arns=None, vpc_arn=None)

Bases: object

VPC configuration that the pentest agent accesses.

Parameters:

security_group_arns (Optional[Sequence[str]]) – List of security groups in the VPC.
subnet_arns (Optional[Sequence[str]]) – List of subnets in the VPC.
vpc_arn (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-vpcconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_securityagent as securityagent

vpc_config_property = securityagent.CfnPentestPropsMixin.VpcConfigProperty(
    security_group_arns=["securityGroupArns"],
    subnet_arns=["subnetArns"],
    vpc_arn="vpcArn"
)

Attributes

security_group_arns

List of security groups in the VPC.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-vpcconfig.html#cfn-securityagent-pentest-vpcconfig-securitygrouparns

subnet_arns

List of subnets in the VPC.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityagent-pentest-vpcconfig.html#cfn-securityagent-pentest-vpcconfig-subnetarns

vpc_arn

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

Type:: see