CfnPentest

class aws_cdk.aws_securityagent.CfnPentest(scope, id, *, agent_space_id, assets, service_role, code_remediation_strategy=None, exclude_risk_types=None, log_config=None, network_traffic_config=None, title=None, vpc_config=None)

Bases: CfnResource

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

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 import aws_securityagent as securityagent

cfn_pentest = securityagent.CfnPentest(self, "MyCfnPentest",
    agent_space_id="agentSpaceId",
    assets=securityagent.CfnPentest.AssetsProperty(
        actors=[securityagent.CfnPentest.ActorProperty(
            authentication=securityagent.CfnPentest.AuthenticationProperty(
                provider_type="providerType",
                value="value"
            ),
            description="description",
            identifier="identifier",
            uris=["uris"]
        )],
        documents=[securityagent.CfnPentest.DocumentInfoProperty(
            artifact_id="artifactId",
            s3_location="s3Location"
        )],
        endpoints=[securityagent.CfnPentest.EndpointProperty(
            uri="uri"
        )],
        integrated_repositories=[securityagent.CfnPentest.IntegratedRepositoryProperty(
            integration_id="integrationId",
            provider_resource_id="providerResourceId"
        )],
        source_code=[securityagent.CfnPentest.SourceCodeRepositoryProperty(
            s3_location="s3Location"
        )]
    ),
    service_role="serviceRole",

    # the properties below are optional
    code_remediation_strategy="codeRemediationStrategy",
    exclude_risk_types=["excludeRiskTypes"],
    log_config=securityagent.CfnPentest.CloudWatchLogProperty(
        log_group="logGroup",
        log_stream="logStream"
    ),
    network_traffic_config=securityagent.CfnPentest.NetworkTrafficConfigProperty(
        custom_headers=[securityagent.CfnPentest.CustomHeaderProperty(
            name="name",
            value="value"
        )],
        rules=[securityagent.CfnPentest.NetworkTrafficRuleProperty(
            effect="effect",
            network_traffic_rule_type="networkTrafficRuleType",
            pattern="pattern"
        )]
    ),
    title="title",
    vpc_config=securityagent.CfnPentest.VpcConfigProperty(
        security_group_arns=["securityGroupArns"],
        subnet_arns=["subnetArns"],
        vpc_arn="vpcArn"
    )
)

Create a new AWS::SecurityAgent::Pentest.

Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • agent_space_id (str) – Identifier of agent space where the pentest should be created.

  • assets (Union[IResolvable, AssetsProperty, Dict[str, Any]]) – Collection of assets to be tested during the pentest.

  • service_role (str) – Service role for accessing resources.

  • code_remediation_strategy (Optional[str]) – Strategy for remediating code vulnerabilities discovered during the pentest.

  • exclude_risk_types (Optional[Sequence[str]]) – A list of risk types excluded from the pentest execution.

  • log_config (Union[IResolvable, CloudWatchLogProperty, Dict[str, Any], None]) – CloudWatch Logs configuration for pentest output.

  • network_traffic_config (Union[IResolvable, NetworkTrafficConfigProperty, Dict[str, Any], None]) – Network traffic configuration for the pentest.

  • title (Optional[str]) – Title of the penetration test.

  • vpc_config (Union[IResolvable, VpcConfigProperty, Dict[str, Any], None]) – VPC configuration that the pentest agent accesses.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource)

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

cfn_property_name(cdk_property_name)
Parameters:

cdk_property_name (str)

Return type:

Optional[str]

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

mixins (IMixin)

Return type:

IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::SecurityAgent::Pentest'
agent_space_id

Identifier of agent space where the pentest should be created.

assets

Collection of assets to be tested during the pentest.

attr_created_at

Timestamp when the pentest was created.

CloudformationAttribute:

CreatedAt

attr_pentest_id

Unique identifier of the pentest.

CloudformationAttribute:

PentestId

attr_updated_at

Timestamp when the pentest was last updated.

CloudformationAttribute:

UpdatedAt

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

code_remediation_strategy

Strategy for remediating code vulnerabilities discovered during the pentest.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

env
exclude_risk_types

A list of risk types excluded from the pentest execution.

log_config

CloudWatch Logs configuration for pentest output.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

network_traffic_config

Network traffic configuration for the pentest.

node

The tree node.

pentest_ref

A reference to a Pentest resource.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

service_role

Service role for accessing resources.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

title

Title of the penetration test.

vpc_config

VPC configuration that the pentest agent accesses.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_pentest(x)

Checks whether the given object is a CfnPentest.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

ActorProperty

class CfnPentest.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 import aws_securityagent as securityagent

actor_property = securityagent.CfnPentest.ActorProperty(
    authentication=securityagent.CfnPentest.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 CfnPentest.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:
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 import aws_securityagent as securityagent

assets_property = securityagent.CfnPentest.AssetsProperty(
    actors=[securityagent.CfnPentest.ActorProperty(
        authentication=securityagent.CfnPentest.AuthenticationProperty(
            provider_type="providerType",
            value="value"
        ),
        description="description",
        identifier="identifier",
        uris=["uris"]
    )],
    documents=[securityagent.CfnPentest.DocumentInfoProperty(
        artifact_id="artifactId",
        s3_location="s3Location"
    )],
    endpoints=[securityagent.CfnPentest.EndpointProperty(
        uri="uri"
    )],
    integrated_repositories=[securityagent.CfnPentest.IntegratedRepositoryProperty(
        integration_id="integrationId",
        provider_resource_id="providerResourceId"
    )],
    source_code=[securityagent.CfnPentest.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 CfnPentest.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 import aws_securityagent as securityagent

authentication_property = securityagent.CfnPentest.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 CfnPentest.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 import aws_securityagent as securityagent

cloud_watch_log_property = securityagent.CfnPentest.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 CfnPentest.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 import aws_securityagent as securityagent

custom_header_property = securityagent.CfnPentest.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 CfnPentest.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 import aws_securityagent as securityagent

document_info_property = securityagent.CfnPentest.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 CfnPentest.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 import aws_securityagent as securityagent

endpoint_property = securityagent.CfnPentest.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 CfnPentest.IntegratedRepositoryProperty(*, integration_id, provider_resource_id)

Bases: object

A repository connected via a provider integration.

Parameters:

  • integration_id (str) – Unique identifier of the provider integration.

  • provider_resource_id (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 import aws_securityagent as securityagent

integrated_repository_property = securityagent.CfnPentest.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 CfnPentest.NetworkTrafficConfigProperty(*, custom_headers=None, rules=None)

Bases: object

Network traffic configuration for the pentest.

Parameters:
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 import aws_securityagent as securityagent

network_traffic_config_property = securityagent.CfnPentest.NetworkTrafficConfigProperty(
    custom_headers=[securityagent.CfnPentest.CustomHeaderProperty(
        name="name",
        value="value"
    )],
    rules=[securityagent.CfnPentest.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 CfnPentest.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 import aws_securityagent as securityagent

network_traffic_rule_property = securityagent.CfnPentest.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 CfnPentest.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 import aws_securityagent as securityagent

source_code_repository_property = securityagent.CfnPentest.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 CfnPentest.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 import aws_securityagent as securityagent

vpc_config_property = securityagent.CfnPentest.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