LimitDescription.py

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

from cfnlint.helpers import LIMITS
from cfnlint.rules import CloudFormationLintRule, RuleMatch


class LimitDescription(CloudFormationLintRule):
    """Check if maximum Output description size limit is exceeded"""

    id = "E6012"
    shortdesc = "Output description limit not exceeded"
    description = "Check the size of Output description in the template is less than the upper limit"
    source_url = "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/outputs-section-structure.html"
    tags = ["outputs", "limits"]

    def match(self, cfn):
        matches = []
        for output_name, output_value in cfn.get_outputs_valid().items():
            description = output_value.get("Description")
            if description:
                path = ["Outputs", output_name, "Description"]
                if len(description) > LIMITS["Outputs"]["description"]:
                    message = (
                        "The length of output description ({0}) exceeds the limit ({1})"
                    )
                    matches.append(
                        RuleMatch(
                            path,
                            message.format(
                                len(description), LIMITS["Outputs"]["description"]
                            ),
                        )
                    )
        return matches