IPolicyValidationPluginBeta1

class aws_cdk.IPolicyValidationPluginBeta1(*args, **kwargs)

Bases: Protocol

Represents a validation plugin that will be executed during synthesis.

Example:

@jsii.implements(IPolicyValidationPluginBeta1)
class MyPlugin:

    def validate(self, context):
        # First read the templates using context.templatePaths...

        # ...then perform the validation, and then compose and return the report.
        # Using hard-coded values here for better clarity:
        return PolicyValidationPluginReportBeta1(
            success=False,
            violations=[PolicyViolationBeta1(
                rule_name="CKV_AWS_117",
                description="Ensure that AWS Lambda function is configured inside a VPC",
                fix="https://docs.bridgecrew.io/docs/ensure-that-aws-lambda-function-is-configured-inside-a-vpc-1",
                violating_resources=[PolicyViolatingResourceBeta1(
                    resource_logical_id="MyFunction3BAA72D1",
                    template_path="/home/johndoe/myapp/cdk.out/MyService.template.json",
                    locations=["Properties/VpcConfig"]
                )]
            )]
        )

Methods

validate(context)

The method that will be called by the CDK framework to perform validations.

This is where the plugin will evaluate the CloudFormation templates for compliance and report and violations

Parameters:

context (IPolicyValidationContextBeta1) –

Return type:

PolicyValidationPluginReportBeta1

Attributes

name: The name of the plugin that will be displayed in the validation report.

rule_ids

The list of rule IDs that the plugin will evaluate.

Used for analytics purposes.

Default:

No rule is reported

version

//semver.org/). This version is used for analytics purposes, to measure the usage of different plugins and different versions. The value of this property should be kept in sync with the actual version of the software package. If the version is not provided or is not a valid semantic version, it will be reported as 0.0.0.

Type:: The version of the plugin, following the Semantic Versioning specification (see https