""" Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: MIT-0 """ import cfnlint.helpers from cfnlint.data import AdditionalSpecs from cfnlint.rules import CloudFormationLintRule, RuleMatch class Inclusive(CloudFormationLintRule): """Check Properties Resource Configuration""" id = "E2521" shortdesc = "Check Properties that are required together" description = "Make sure CloudFormation resource properties are included together when required" source_url = "https://github.com/aws-cloudformation/cfn-python-lint" tags = ["resources"] def __init__(self): """Init""" super().__init__() inclusivespec = cfnlint.helpers.load_resource(AdditionalSpecs, "Inclusive.json") self.resource_types_specs = inclusivespec["ResourceTypes"] self.property_types_specs = inclusivespec["PropertyTypes"] for resource_type_spec in self.resource_types_specs: self.resource_property_types.append(resource_type_spec) for property_type_spec in self.property_types_specs: self.resource_sub_property_types.append(property_type_spec) def check(self, properties, inclusions, path, cfn): """Check itself""" matches = [] if not properties: return matches property_sets = cfn.get_object_without_conditions(properties) for property_set in property_sets: obj = property_set["Object"].clean() for prop in obj: if prop in inclusions: for incl_property in inclusions[prop]: if incl_property not in obj: if property_set["Scenario"] is None: matches.append( RuleMatch( path, f'Property {incl_property} should exist with {prop} for {"/".join(map(str, path))}', ) ) else: scenario_text = " and ".join( [ f'when condition "{k}" is {v}' for (k, v) in property_set["Scenario"].items() ] ) message = ( "Property {0} should exist with {1} {2} for {3}" ) matches.append( RuleMatch( path, message.format( incl_property, prop, scenario_text, "/".join(map(str, path)), ), ) ) return matches def match_resource_sub_properties(self, properties, property_type, path, cfn): """Match for sub properties""" matches = [] inclusions = self.property_types_specs.get(property_type, {}) matches.extend(self.check(properties, inclusions, path, cfn)) return matches def match_resource_properties(self, properties, resource_type, path, cfn): """Check CloudFormation Properties""" matches = [] inclusions = self.resource_types_specs.get(resource_type, {}) matches.extend(self.check(properties, inclusions, path, cfn)) return matches