CfnCodeSecurityScanConfigurationPropsMixin

class aws_cdk.mixins_preview.aws_inspectorv2.mixins.CfnCodeSecurityScanConfigurationPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a scan configuration for code security scanning.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-codesecurityscanconfiguration.html

CloudformationResource:

AWS::InspectorV2::CodeSecurityScanConfiguration

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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_inspectorv2 import mixins as inspectorv2_mixins

cfn_code_security_scan_configuration_props_mixin = inspectorv2_mixins.CfnCodeSecurityScanConfigurationPropsMixin(inspectorv2_mixins.CfnCodeSecurityScanConfigurationMixinProps(
    configuration=inspectorv2_mixins.CfnCodeSecurityScanConfigurationPropsMixin.CodeSecurityScanConfigurationProperty(
        continuous_integration_scan_configuration=inspectorv2_mixins.CfnCodeSecurityScanConfigurationPropsMixin.ContinuousIntegrationScanConfigurationProperty(
            supported_events=["supportedEvents"]
        ),
        periodic_scan_configuration=inspectorv2_mixins.CfnCodeSecurityScanConfigurationPropsMixin.PeriodicScanConfigurationProperty(
            frequency="frequency",
            frequency_expression="frequencyExpression"
        ),
        rule_set_categories=["ruleSetCategories"]
    ),
    level="level",
    name="name",
    scope_settings=inspectorv2_mixins.CfnCodeSecurityScanConfigurationPropsMixin.ScopeSettingsProperty(
        project_selection_scope="projectSelectionScope"
    ),
    tags={
        "tags_key": "tags"
    }
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::InspectorV2::CodeSecurityScanConfiguration.

Parameters:

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['configuration', 'level', 'name', 'scopeSettings', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) 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.

Stability:

experimental

CodeSecurityScanConfigurationProperty

class CfnCodeSecurityScanConfigurationPropsMixin.CodeSecurityScanConfigurationProperty(*, continuous_integration_scan_configuration=None, periodic_scan_configuration=None, rule_set_categories=None)

Bases: object

Contains the configuration settings for code security scans.

Parameters:
  • continuous_integration_scan_configuration (Union[IResolvable, ContinuousIntegrationScanConfigurationProperty, Dict[str, Any], None]) – Configuration settings for continuous integration scans that run automatically when code changes are made.

  • periodic_scan_configuration (Union[IResolvable, PeriodicScanConfigurationProperty, Dict[str, Any], None]) – Configuration settings for periodic scans that run on a scheduled basis.

  • rule_set_categories (Optional[Sequence[str]]) – The categories of security rules to be applied during the scan.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-codesecurityscanconfiguration.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.mixins_preview.aws_inspectorv2 import mixins as inspectorv2_mixins

code_security_scan_configuration_property = inspectorv2_mixins.CfnCodeSecurityScanConfigurationPropsMixin.CodeSecurityScanConfigurationProperty(
    continuous_integration_scan_configuration=inspectorv2_mixins.CfnCodeSecurityScanConfigurationPropsMixin.ContinuousIntegrationScanConfigurationProperty(
        supported_events=["supportedEvents"]
    ),
    periodic_scan_configuration=inspectorv2_mixins.CfnCodeSecurityScanConfigurationPropsMixin.PeriodicScanConfigurationProperty(
        frequency="frequency",
        frequency_expression="frequencyExpression"
    ),
    rule_set_categories=["ruleSetCategories"]
)

Attributes

continuous_integration_scan_configuration

Configuration settings for continuous integration scans that run automatically when code changes are made.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-codesecurityscanconfiguration.html#cfn-inspectorv2-codesecurityscanconfiguration-codesecurityscanconfiguration-continuousintegrationscanconfiguration

periodic_scan_configuration

Configuration settings for periodic scans that run on a scheduled basis.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-codesecurityscanconfiguration.html#cfn-inspectorv2-codesecurityscanconfiguration-codesecurityscanconfiguration-periodicscanconfiguration

rule_set_categories

The categories of security rules to be applied during the scan.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-codesecurityscanconfiguration.html#cfn-inspectorv2-codesecurityscanconfiguration-codesecurityscanconfiguration-rulesetcategories

ContinuousIntegrationScanConfigurationProperty

class CfnCodeSecurityScanConfigurationPropsMixin.ContinuousIntegrationScanConfigurationProperty(*, supported_events=None)

Bases: object

Configuration settings for continuous integration scans that run automatically when code changes are made.

Parameters:

supported_events (Optional[Sequence[str]]) – The repository events that trigger continuous integration scans, such as pull requests or commits.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-continuousintegrationscanconfiguration.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.mixins_preview.aws_inspectorv2 import mixins as inspectorv2_mixins

continuous_integration_scan_configuration_property = inspectorv2_mixins.CfnCodeSecurityScanConfigurationPropsMixin.ContinuousIntegrationScanConfigurationProperty(
    supported_events=["supportedEvents"]
)

Attributes

supported_events

The repository events that trigger continuous integration scans, such as pull requests or commits.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-continuousintegrationscanconfiguration.html#cfn-inspectorv2-codesecurityscanconfiguration-continuousintegrationscanconfiguration-supportedevents

PeriodicScanConfigurationProperty

class CfnCodeSecurityScanConfigurationPropsMixin.PeriodicScanConfigurationProperty(*, frequency=None, frequency_expression=None)

Bases: object

Configuration settings for periodic scans that run on a scheduled basis.

Parameters:
  • frequency (Optional[str]) – The frequency at which periodic scans are performed (such as weekly or monthly). If you don’t provide the frequencyExpression Amazon Inspector chooses day for the scan to run. If you provide the frequencyExpression , the schedule must match the specified frequency .

  • frequency_expression (Optional[str]) – The schedule expression for periodic scans, in cron format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-periodicscanconfiguration.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.mixins_preview.aws_inspectorv2 import mixins as inspectorv2_mixins

periodic_scan_configuration_property = inspectorv2_mixins.CfnCodeSecurityScanConfigurationPropsMixin.PeriodicScanConfigurationProperty(
    frequency="frequency",
    frequency_expression="frequencyExpression"
)

Attributes

frequency

The frequency at which periodic scans are performed (such as weekly or monthly).

If you don’t provide the frequencyExpression Amazon Inspector chooses day for the scan to run. If you provide the frequencyExpression , the schedule must match the specified frequency .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-periodicscanconfiguration.html#cfn-inspectorv2-codesecurityscanconfiguration-periodicscanconfiguration-frequency

frequency_expression

The schedule expression for periodic scans, in cron format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-periodicscanconfiguration.html#cfn-inspectorv2-codesecurityscanconfiguration-periodicscanconfiguration-frequencyexpression

ScopeSettingsProperty

class CfnCodeSecurityScanConfigurationPropsMixin.ScopeSettingsProperty(*, project_selection_scope=None)

Bases: object

The scope settings that define which repositories will be scanned.

If the ScopeSetting parameter is ALL the scan configuration applies to all existing and future projects imported into Amazon Inspector .

Parameters:

project_selection_scope (Optional[str]) – The scope of projects to be selected for scanning within the integrated repositories.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-scopesettings.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.mixins_preview.aws_inspectorv2 import mixins as inspectorv2_mixins

scope_settings_property = inspectorv2_mixins.CfnCodeSecurityScanConfigurationPropsMixin.ScopeSettingsProperty(
    project_selection_scope="projectSelectionScope"
)

Attributes

project_selection_scope

The scope of projects to be selected for scanning within the integrated repositories.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-inspectorv2-codesecurityscanconfiguration-scopesettings.html#cfn-inspectorv2-codesecurityscanconfiguration-scopesettings-projectselectionscope