ValuePattern.py

"""
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: MIT-0
"""

from cfnlint.jsonschema._keywords import pattern
from cfnlint.rules import CloudFormationLintRule


class ValuePattern(CloudFormationLintRule):
    """Check if parameters have a valid value"""

    id = "W2031"
    shortdesc = "Check if parameters have a valid value based on an allowed pattern"
    description = (
        "Check if parameters have a valid value in a pattern. The Parameter's allowed"
        " pattern is based on the usages in property (Ref)"
    )
    source_url = "https://github.com/aws-cloudformation/cfn-lint/blob/main/docs/cfn-schema-specification.md#pattern"
    tags = ["parameters", "resources", "property", "pattern"]

    # This rule is triggered from the equivalent rule E3031
    # the values are fed from there and we adjust the error outputs
    # appropriately

    # pylint: disable=unused-argument, arguments-renamed
    def pattern(self, validator, patrn, instance, schema):
        for err in pattern(validator, patrn, instance, schema):
            err.rule = self
            err.path_override = validator.context.path.value_path
            yield err