CfnPentestPropsMixin
- class aws_cdk.cfn_property_mixins.aws_securityagent.CfnPentestPropsMixin(props, *, strategy=None)
Bases:
MixinResource Type definition for AWS::SecurityAgent::Pentest.
- See:
- 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", enable_email_mfa=False, identifier="identifier", mfa_forwarding_address="mfaForwardingAddress", uris=["uris"] )], documents=[securityagent.CfnPentestPropsMixin.DocumentInfoProperty( artifact_id="artifactId", s3_location="s3Location" )], endpoints=[securityagent.CfnPentestPropsMixin.EndpointProperty( uri="uri" )], integrated_repositories=[securityagent.CfnPentestPropsMixin.IntegratedRepositoryProperty( branch="branch", integration_id="integrationId", provider_resource_id="providerResourceId" )], source_code=[securityagent.CfnPentestPropsMixin.SourceCodeRepositoryProperty( s3_location="s3Location" )], trusted_ca_certificates=[securityagent.CfnPentestPropsMixin.TrustedCaCertificateProperty( source=securityagent.CfnPentestPropsMixin.CaCertificateSourceProperty( artifact_id="artifactId", inline_pem="inlinePem", s3_location="s3Location" ) )] ), clean_up_strategy="cleanUpStrategy", code_remediation_strategy="codeRemediationStrategy", disable_managed_skills=["disableManagedSkills"], 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', 'cleanUpStrategy', 'codeRemediationStrategy', 'disableManagedSkills', 'excludeRiskTypes', 'logConfig', 'networkTrafficConfig', 'serviceRole', 'title', 'vpcConfig']
Static Methods
- classmethod is_mixin(x)
Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.
ActorProperty
- class CfnPentestPropsMixin.ActorProperty(*, authentication=None, description=None, enable_email_mfa=None, identifier=None, mfa_forwarding_address=None, uris=None)
Bases:
objectAn 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.enable_email_mfa (
Union[bool,IResolvable,None]) – Whether email-based MFA is enabled for this actor.identifier (
Optional[str]) – Identifier for the actor.mfa_forwarding_address (
Optional[str]) – Server-generated email forwarding address for receiving MFA codes.uris (
Optional[Sequence[str]]) – List of URIs this actor is authorized to access.
- See:
- 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", enable_email_mfa=False, identifier="identifier", mfa_forwarding_address="mfaForwardingAddress", uris=["uris"] )
Attributes
- authentication
Authentication configuration for a pentest actor.
- description
Description of the actor.
- enable_email_mfa
Whether email-based MFA is enabled for this actor.
- identifier
Identifier for the actor.
- mfa_forwarding_address
Server-generated email forwarding address for receiving MFA codes.
- uris
List of URIs this actor is authorized to access.
AssetsProperty
- class CfnPentestPropsMixin.AssetsProperty(*, actors=None, documents=None, endpoints=None, integrated_repositories=None, source_code=None, trusted_ca_certificates=None)
Bases:
objectCollection 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.trusted_ca_certificates (
Union[IResolvable,Sequence[Union[IResolvable,TrustedCaCertificateProperty,Dict[str,Any]]],None]) – Trust anchors for validating target endpoint TLS certificates, for endpoints served by a private or internal CA, an intermediate CA, or a self-signed certificate.
- See:
- 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", enable_email_mfa=False, identifier="identifier", mfa_forwarding_address="mfaForwardingAddress", uris=["uris"] )], documents=[securityagent.CfnPentestPropsMixin.DocumentInfoProperty( artifact_id="artifactId", s3_location="s3Location" )], endpoints=[securityagent.CfnPentestPropsMixin.EndpointProperty( uri="uri" )], integrated_repositories=[securityagent.CfnPentestPropsMixin.IntegratedRepositoryProperty( branch="branch", integration_id="integrationId", provider_resource_id="providerResourceId" )], source_code=[securityagent.CfnPentestPropsMixin.SourceCodeRepositoryProperty( s3_location="s3Location" )], trusted_ca_certificates=[securityagent.CfnPentestPropsMixin.TrustedCaCertificateProperty( source=securityagent.CfnPentestPropsMixin.CaCertificateSourceProperty( artifact_id="artifactId", inline_pem="inlinePem", s3_location="s3Location" ) )] )
Attributes
- actors
List of actors used during testing.
- documents
List of documents providing additional context for the pentest.
- endpoints
List of endpoints to test.
- integrated_repositories
List of repositories connected via provider integrations.
- source_code
List of source code repositories to analyze.
- trusted_ca_certificates
Trust anchors for validating target endpoint TLS certificates, for endpoints served by a private or internal CA, an intermediate CA, or a self-signed certificate.
AuthenticationProperty
- class CfnPentestPropsMixin.AuthenticationProperty(*, provider_type=None, value=None)
Bases:
objectAuthentication 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:
- 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.
- value
Reference value for the authentication provider, such as a secret ARN or Lambda ARN.
CaCertificateSourceProperty
- class CfnPentestPropsMixin.CaCertificateSourceProperty(*, artifact_id=None, inline_pem=None, s3_location=None)
Bases:
objectSource of a trusted CA certificate.
Exactly one member must be set.
- Parameters:
artifact_id (
Optional[str]) – Artifact ID of an uploaded certificate file.inline_pem (
Optional[str]) – PEM-encoded X.509 certificate supplied inline.s3_location (
Optional[str]) – Amazon S3 location URI of a customer-staged certificate.
- See:
- 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 ca_certificate_source_property = securityagent.CfnPentestPropsMixin.CaCertificateSourceProperty( artifact_id="artifactId", inline_pem="inlinePem", s3_location="s3Location" )
Attributes
- artifact_id
Artifact ID of an uploaded certificate file.
- inline_pem
PEM-encoded X.509 certificate supplied inline.
- s3_location
Amazon S3 location URI of a customer-staged certificate.
CloudWatchLogProperty
- class CfnPentestPropsMixin.CloudWatchLogProperty(*, log_group=None, log_stream=None)
Bases:
objectCloudWatch Logs configuration for pentest output.
- Parameters:
log_group (
Optional[str]) – CloudWatch log group.log_stream (
Optional[str]) – CloudWatch log stream.
- See:
- 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.
CustomHeaderProperty
- class CfnPentestPropsMixin.CustomHeaderProperty(*, name=None, value=None)
Bases:
objectA custom header to include in outbound requests.
- Parameters:
name (
Optional[str]) – Name of the header.value (
Optional[str]) – Value of the header.
- See:
- 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.
DocumentInfoProperty
- class CfnPentestPropsMixin.DocumentInfoProperty(*, artifact_id=None, s3_location=None)
Bases:
objectA document attached to the pentest, uploaded to S3.
- Parameters:
artifact_id (
Optional[str]) – Artifact identifier.s3_location (
Optional[str]) – S3 document location.
- See:
- 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.
EndpointProperty
- class CfnPentestPropsMixin.EndpointProperty(*, uri=None)
Bases:
objectAn endpoint to be tested during the pentest.
- Parameters:
uri (
Optional[str]) – URI of the endpoint to test.- See:
- 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.
IntegratedRepositoryProperty
- class CfnPentestPropsMixin.IntegratedRepositoryProperty(*, branch=None, integration_id=None, provider_resource_id=None)
Bases:
objectA repository connected via a provider integration.
- Parameters:
branch (
Optional[str]) – An optional override for the repository branch.integration_id (
Optional[str]) – Unique identifier of the provider integration.provider_resource_id (
Optional[str]) – Identifier of the resource within the provider integration.
- See:
- 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( branch="branch", integration_id="integrationId", provider_resource_id="providerResourceId" )
Attributes
- branch
An optional override for the repository branch.
- integration_id
Unique identifier of the provider integration.
- provider_resource_id
Identifier of the resource within the provider integration.
NetworkTrafficConfigProperty
- class CfnPentestPropsMixin.NetworkTrafficConfigProperty(*, custom_headers=None, rules=None)
Bases:
objectNetwork 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:
- 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.
- rules
Ordered list of network traffic rules.
NetworkTrafficRuleProperty
- class CfnPentestPropsMixin.NetworkTrafficRuleProperty(*, effect=None, network_traffic_rule_type=None, pattern=None)
Bases:
objectNetwork 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:
- 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.
- network_traffic_rule_type
Type of pattern matching for this rule.
- pattern
URL pattern this rule applies to.
SourceCodeRepositoryProperty
- class CfnPentestPropsMixin.SourceCodeRepositoryProperty(*, s3_location=None)
Bases:
objectA source code archive stored in S3 for analysis during the pentest.
- Parameters:
s3_location (
Optional[str]) – S3 source code location.- See:
- 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
TrustedCaCertificateProperty
- class CfnPentestPropsMixin.TrustedCaCertificateProperty(*, source=None)
Bases:
objectTrust anchor used when validating a target endpoint’s TLS certificate.
- Parameters:
source (
Union[IResolvable,CaCertificateSourceProperty,Dict[str,Any],None]) – Source of a trusted CA certificate. Exactly one member must be set.- See:
- 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 trusted_ca_certificate_property = securityagent.CfnPentestPropsMixin.TrustedCaCertificateProperty( source=securityagent.CfnPentestPropsMixin.CaCertificateSourceProperty( artifact_id="artifactId", inline_pem="inlinePem", s3_location="s3Location" ) )
Attributes
- source
Source of a trusted CA certificate.
Exactly one member must be set.
VpcConfigProperty
- class CfnPentestPropsMixin.VpcConfigProperty(*, security_group_arns=None, subnet_arns=None, vpc_arn=None)
Bases:
objectVPC 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:
- 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.
- subnet_arns
List of subnets in the VPC.