""" 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 OnlyOne(CloudFormationLintRule): """Check Properties Resource Configuration""" id = "E2523" shortdesc = "Check Properties that need only one of a list of properties" description = ( "Making sure CloudFormation properties " + "that require only one property from a list. " + "One has to be specified." ) source_url = "https://github.com/aws-cloudformation/cfn-python-lint" tags = ["resources"] def __init__(self): """Init""" super().__init__() onlyonespec = cfnlint.helpers.load_resource(AdditionalSpecs, "OnlyOne.json") self.resource_types_specs = onlyonespec["ResourceTypes"] self.property_types_specs = onlyonespec["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, onlyoneprops, path, cfn): """Check itself""" matches = [] for onlyoneprop in onlyoneprops: for safe_properties, safe_path in properties.items_safe(path): property_sets = cfn.get_object_without_conditions( safe_properties, onlyoneprop ) for property_set in property_sets: count = 0 for prop in onlyoneprop: if prop in property_set["Object"]: count += 1 if count != 1: if property_set["Scenario"] is None: message = "Only one of [{0}] should be specified for {1}" matches.append( RuleMatch( path, message.format( ", ".join(map(str, onlyoneprop)), "/".join(map(str, safe_path)), ), ) ) else: scenario_text = " and ".join( [ f'when condition "{k}" is {v}' for (k, v) in property_set["Scenario"].items() ] ) message = "Only one of [{0}] should be specified {1} at {2}" matches.append( RuleMatch( path, message.format( ", ".join(map(str, onlyoneprop)), scenario_text, "/".join(map(str, safe_path)), ), ) ) return matches def match_resource_sub_properties(self, properties, property_type, path, cfn): """Match for sub properties""" matches = [] onlyoneprops = self.property_types_specs.get(property_type, {}) matches.extend(self.check(properties, onlyoneprops, path, cfn)) return matches def match_resource_properties(self, properties, resource_type, path, cfn): """Check CloudFormation Properties""" matches = [] onlyoneprops = self.resource_types_specs.get(resource_type, {}) matches.extend(self.check(properties, onlyoneprops, path, cfn)) return matches
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
__pycache__ | Folder | 0755 |
|
|
AllowedPattern.py | File | 5.76 KB | 0644 |
|
AllowedValue.py | File | 4.8 KB | 0644 |
|
AtLeastOne.py | File | 4.11 KB | 0644 |
|
AvailabilityZone.py | File | 3.41 KB | 0644 |
|
BasedOnValue.py | File | 6.33 KB | 0644 |
|
Exclusive.py | File | 3.98 KB | 0644 |
|
ImageId.py | File | 2.37 KB | 0644 |
|
Inclusive.py | File | 3.7 KB | 0644 |
|
JsonSize.py | File | 6.08 KB | 0644 |
|
ListDuplicates.py | File | 4.39 KB | 0644 |
|
ListDuplicatesAllowed.py | File | 4.76 KB | 0644 |
|
ListSize.py | File | 4.88 KB | 0644 |
|
NumberSize.py | File | 4.88 KB | 0644 |
|
OnlyOne.py | File | 3.89 KB | 0644 |
|
Password.py | File | 3.63 KB | 0644 |
|
Properties.py | File | 27.49 KB | 0644 |
|
PropertiesTemplated.py | File | 2.44 KB | 0644 |
|
Required.py | File | 4.1 KB | 0644 |
|
RequiredBasedOnValue.py | File | 831 B | 0644 |
|
StringSize.py | File | 4.52 KB | 0644 |
|
UnwantedBasedOnValue.py | File | 837 B | 0644 |
|
ValuePrimitiveType.py | File | 11.6 KB | 0644 |
|
ValueRefGetAtt.py | File | 11.96 KB | 0644 |
|
__init__.py | File | 106 B | 0644 |
|