""" Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: MIT-0 """ from cfnlint.helpers import RESOURCE_SPECS from cfnlint.rules import CloudFormationLintRule, RuleMatch class ListSize(CloudFormationLintRule): """Check if List has a size within the limit""" id = "E3032" shortdesc = "Check if a list has between min and max number of values specified" description = "Check lists for the number of items in the list to validate they are between the minimum and maximum" source_url = "https://github.com/awslabs/cfn-python-lint/blob/main/docs/cfn-resource-specification.md#allowedpattern" tags = ["resources", "property", "list", "size"] def initialize(self, cfn): """Initialize the rule""" for resource_type_spec in RESOURCE_SPECS.get(cfn.regions[0]).get( "ResourceTypes" ): self.resource_property_types.append(resource_type_spec) for property_type_spec in RESOURCE_SPECS.get(cfn.regions[0]).get( "PropertyTypes" ): self.resource_sub_property_types.append(property_type_spec) def check_value(self, properties, path, property_name, cfn, value_specs): """Check Value""" matches = [] # Get the Min and Max for a List list_min = value_specs.get("ListMin") list_max = value_specs.get("ListMax") if list_min is not None and list_max is not None: property_sets = cfn.get_object_without_conditions(properties) for property_set in property_sets: prop = property_set.get("Object").get(property_name) if isinstance(prop, list): if not list_min <= len(prop) <= list_max: if property_set["Scenario"] is None: message = ( "{0} has to have between {1} and {2} items specified" ) matches.append( RuleMatch( path + [property_name], message.format(property_name, list_min, list_max), ) ) else: scenario_text = " and ".join( [ f'when condition "{k}" is {v}' for (k, v) in property_set["Scenario"].items() ] ) message = "{0} has to have between {1} and {2} items specified when {3}" matches.append( RuleMatch( path + [property_name], message.format( property_name, list_min, list_max, scenario_text ), ) ) return matches def check(self, cfn, properties, specs, path): """Check itself""" matches = [] for p_value, p_path in properties.items_safe(path[:]): for prop in p_value: if prop in specs: value = specs.get(prop).get("Value", {}) if value: value_type = value.get("ListValueType", "") property_type = specs.get(prop).get("Type") if property_type == "List": matches.extend( self.check_value( p_value, p_path, prop, cfn, RESOURCE_SPECS.get(cfn.regions[0]) .get("ValueTypes") .get(value_type, {}), ) ) return matches def match_resource_sub_properties(self, properties, property_type, path, cfn): """Match for sub properties""" matches = [] specs = ( RESOURCE_SPECS.get(cfn.regions[0]) .get("PropertyTypes") .get(property_type, {}) .get("Properties", {}) ) matches.extend(self.check(cfn, properties, specs, path)) return matches def match_resource_properties(self, properties, resource_type, path, cfn): """Check CloudFormation Properties""" matches = [] specs = ( RESOURCE_SPECS.get(cfn.regions[0]) .get("ResourceTypes") .get(resource_type, {}) .get("Properties", {}) ) matches.extend(self.check(cfn, properties, specs, path)) 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 |
|