cfn-lint の API リファレンス
cfn-lint (aws-cloudformation/cfn-lint) の公開 API 227 件 —— クラス 155、関数 33、メソッド 39。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。
リポジトリ: aws-cloudformation/cfn-lint
| 種別 | 件数 |
|---|---|
| クラス | 155 |
| 関数 | 33 |
| メソッド | 39 |
API 一覧
func
src.cfnlint.api.graph(s:str) -> str | NoneGenerate a DOT graph from a template string.
func
src.cfnlint.api.lint_all(s:str) -> list[Match]Validate a string template against all regions and rules.
func
src.cfnlint.api.lint_file(template:Path, config:ManualArgs | None=None) -> list[Match]Validate a template file using the configuration provided.
class
src.cfnlint.conditions._condition.ConditionThe generic class to represent any type of Condition
class
src.cfnlint.conditions._condition.ConditionAndRepresents the logic specific to an And Condition
class
src.cfnlint.conditions._condition.ConditionNotRepresents the logic specific to an Not Condition
class
src.cfnlint.conditions._condition.ConditionOrRepresents the logic specific to an Or Condition
class
src.cfnlint.conditions._errors.UnknownSatisfisfactionUnknown Satisfisfaction Exception
class
src.cfnlint.config.CliArgsBase Args class
class
src.cfnlint.config.CliArgs.ArgumentParserOverride Argument Parser so we can control the exit code
class
src.cfnlint.config.ConfigFileArgsConfig File arguments.
class
src.cfnlint.config.RuleConfigurationActionOverride the default Action
class
src.cfnlint.config.TemplateArgsPer Template Args
func
src.cfnlint.config.comma_separated_arg(string)Split a comma separated string
class
src.cfnlint.context._mappings.MapThis class holds a mapping
class
src.cfnlint.context._mappings.MappingsThis class holds a mapping
class
src.cfnlint.context.context.ParameterThis class holds a parameter and its attributes
class
src.cfnlint.context.context.PathA `Path` keeps track of the different Path values
method
src.cfnlint.context.context.Path.descend(**kwargs) -> 'Path'Create a new Path by appending values
class
src.cfnlint.context.context.ResourceThis class holds a resources and its type
class
src.cfnlint.decode.cfn_json.DuplicateErrorError thrown when the template contains duplicates
func
src.cfnlint.decode.cfn_json.get_beg_end_mark(start, end, indexes)Get the Start and End Mark
func
src.cfnlint.decode.cfn_json.load(filename)Load the given JSON file
func
src.cfnlint.decode.cfn_json.loads(json_string)Load the given JSON string
func
src.cfnlint.decode.cfn_json.scan_once(string, idx)Scan Once
class
src.cfnlint.decode.cfn_yaml.CfnParseErrorError thrown when the template contains Cfn Error
class
src.cfnlint.decode.cfn_yaml.NodeConstructorNode Constructors for loading different types in Yaml
func
src.cfnlint.decode.cfn_yaml.load(filename)Load the given YAML file
func
src.cfnlint.decode.cfn_yaml.loads(yaml_string, fname=None)Load the given YAML string
func
src.cfnlint.decode.cfn_yaml.multi_constructor(loader:CfnFullLoader, tag_suffix, node)Deal with !Ref style function format
func
src.cfnlint.decode.decode.decode(filename:str | None) -> DecodeDecode filename into an object.
func
src.cfnlint.decode.decode.decode_str(s:str) -> DecodeDecode the string s into an object.
class
src.cfnlint.decode.mark.MarkMark of line and column
func
src.cfnlint.decode.node.create_dict_list_class(cls)Create dynamic list class
func
src.cfnlint.decode.node.create_dict_node_class(cls)Create dynamic node class
func
src.cfnlint.decode.node.create_str_node_class(cls)Create string node class
class
src.cfnlint.decode.node.node_classNode class created based on the input class
method
src.cfnlint.decode.node.node_class.get(key, default=None)Override the default get
class
src.cfnlint.formatters.base.BaseFormatterBase Formatter class
method
src.cfnlint.formatters.base.BaseFormatter.print_matches(matches, rules, config)Output all the matches
class
src.cfnlint.formatters.formatter.FormatterGeneric Formatter
class
src.cfnlint.formatters.json.JsonFormatterJson Formatter
class
src.cfnlint.formatters.json.JsonFormatter.CustomEncoderCustom Encoding for the Match Object
class
src.cfnlint.formatters.junit.JUnitFormatterJUnit-style Reports
method
src.cfnlint.formatters.junit.JUnitFormatter.print_matches(matches, rules, config)Output all the matches
class
src.cfnlint.formatters.parseable.ParseableFormatterParseable Formatter
class
src.cfnlint.formatters.pretty.PrettyFormatterGeneric Formatter
class
src.cfnlint.formatters.quit.QuietFormatterQuiet Formatter
class
src.cfnlint.graph.GraphModels a template as a directed graph of resources
method
src.cfnlint.graph.Graph.to_dot_string() -> strExport the graph to a DOT format string
class
src.cfnlint.helpers.ToPyConversion of a string into Python friendly naming
func
src.cfnlint.helpers.bool_compare(first, second)Compare strings to boolean values
func
src.cfnlint.helpers.converter(o)Help convert date/time into strings
func
src.cfnlint.helpers.format_json_string(json_string)Format the given JSON string
func
src.cfnlint.helpers.get_hash(instance:Any) -> strReturn a hash of an object
func
src.cfnlint.helpers.get_url_content(url, caching=False)Get the contents of a spec file
func
src.cfnlint.helpers.load_plugins(directory, name='CloudFormationLintRule', modules=('cfnlint', 'cfnlint.rules', 'cfnlint.rules._rule'))Load plugins
func
src.cfnlint.helpers.onerror(os_error)Raise an error
class
src.cfnlint.jsonschema._filter.FunctionFilterA :kw:`type` property checker.
class
src.cfnlint.jsonschema._format.FormatCheckerA ``format`` property checker.
method
src.cfnlint.jsonschema._format.FormatChecker.check(instance:object, format:str) -> NoneCheck whether the instance conforms to the given format.
func
src.cfnlint.jsonschema._keywords_cfn.resolve_data_in_schema(schema:Any, root_instance:Any) -> AnyRecursively resolve all $data references in a schema.
func
src.cfnlint.jsonschema._keywords_cfn.resolve_data_reference(value:Any, root_instance:Any) -> AnyResolve $data and $lookup references in schema values.
class
src.cfnlint.jsonschema._types.TypeCheckerA :kw:`type` property checker.
method
src.cfnlint.jsonschema._types.TypeChecker.is_type(instance, type:str) -> boolCheck if the instance is of the appropriate type.
class
src.cfnlint.jsonschema.exceptions.FormatErrorValidating a format failed.
class
src.cfnlint.jsonschema.exceptions.ValidationErrorAn instance was invalid under a provided schema.
class
src.cfnlint.jsonschema.protocols.ValidatorThe protocol to which all validator classes adhere.
method
src.cfnlint.jsonschema.protocols.Validator.is_type(instance:Any, type:str) -> boolCheck if the instance is of the given (JSON Schema) type.
method
src.cfnlint.jsonschema.protocols.Validator.is_valid(instance:Any) -> boolCheck if the instance is valid under the current `schema`.
method
src.cfnlint.jsonschema.protocols.Validator.validate(instance:Any) -> NoneCheck if the instance is valid under the current `schema`.
method
src.cfnlint.jsonschema.validators.Validator.is_type(instance:Any, type:str) -> boolCheck if the instance is of the given (JSON Schema) type.
method
src.cfnlint.jsonschema.validators.Validator.is_valid(instance:Any) -> boolCheck if the instance is valid under the current `schema`.
method
src.cfnlint.jsonschema.validators.Validator.validate(instance:Any) -> NoneCheck if the instance is valid under the current `schema`.
func
src.cfnlint.maintenance.update_iam_policies()update iam policies file
func
src.cfnlint.maintenance.update_resource_specs(force:bool=False) -> intUpdate provider schemas from the enhanced schemas repository.
class
src.cfnlint.match.MatchRepresents a match found by a CloudFormationLintRule.
class
src.cfnlint.rules._rule.CloudFormationLintRuleCloudFormation linter rules
method
src.cfnlint.rules._rule.CloudFormationLintRule.configure(configs=None, experimental=False)Set the configuration
method
src.cfnlint.rules._rule.CloudFormationLintRule.initialize(cfn:Template)Initialize the rule
method
src.cfnlint.rules._rule.CloudFormationLintRule.matchall(filename:str, cfn:Template)Match the entire file
method
src.cfnlint.rules._rule.CloudFormationLintRule.severity()Severity level
method
src.cfnlint.rules._rule.CloudFormationLintRule.verbose()Verbose output
class
src.cfnlint.rules._rule.RuleMatchRepresents a rule match found by a CloudFormationLintRule.
func
src.cfnlint.rules._rule.decorator(match_function)The Actual Decorator
func
src.cfnlint.rules._rule.matching(match_type:Any)Does Logging for match functions
func
src.cfnlint.rules._rule.wrapper(self, filename:str, cfn:Template, *args, **kwargs)Wrapper
class
src.cfnlint.rules._rules.RulesCollectionCollection of rules
method
src.cfnlint.rules._rules.RulesCollection.extend(more)Extend rules
method
src.cfnlint.rules._rules.RulesCollection.register(rule:CloudFormationLintRule)Register rules
method
src.cfnlint.rules._rules.RulesCollection.run(filename:str | None, cfn:Template, config=None)Run rules
method
src.cfnlint.rules._rules.RulesCollection.run_check(check, filename, rule_id, *args)Run a check
class
src.cfnlint.rules.conditions.And.AndCheck And Condition Function Logic
class
src.cfnlint.rules.conditions.Condition.ConditionCheck And Condition Function Logic
class
src.cfnlint.rules.conditions.Configuration.ConfigurationCheck if Conditions are configured correctly
class
src.cfnlint.rules.conditions.Equals.EqualsCheck Equals Condition Function Logic
class
src.cfnlint.rules.conditions.Exists.ExistsCheck if used Conditions are defined
class
src.cfnlint.rules.conditions.Not.NotCheck Not Condition Function Logic
class
src.cfnlint.rules.conditions.Or.OrCheck Or Condition Function Logic
class
src.cfnlint.rules.conditions.Used.UsedCheck if Conditions are configured correctly
func
src.cfnlint.rules.custom.make_rule(line, lineNumber)Object Maker Function
class
src.cfnlint.rules.errors.parse.ParseErrorParse Lint Rule
class
src.cfnlint.rules.errors.rule.RuleErrorRule processing Error
class
src.cfnlint.rules.errors.transform.TransformErrorTransform Lint Rule
class
src.cfnlint.rules.functions.Base64.Base64Check if Base64 values are correct
class
src.cfnlint.rules.functions.Cidr.CidrCheck if Cidr values are correct
class
src.cfnlint.rules.functions.FindInMap.FindInMapCheck if FindInMap values are correct
class
src.cfnlint.rules.functions.GetAtt.GetAttCheck if GetAtt values are correct
class
src.cfnlint.rules.functions.GetAz.GetAzCheck if GetAz values are correct
class
src.cfnlint.rules.functions.GetStackOutput.GetStackOutputCheck if GetStackOutput values are correct
class
src.cfnlint.rules.functions.If.IfCheck if Condition exists
class
src.cfnlint.rules.functions.ImportValue.ImportValueCheck if ImportValue values are correct
class
src.cfnlint.rules.functions.Join.JoinCheck if Join values are correct
class
src.cfnlint.rules.functions.Length.LengthCheck if Length values are correct
class
src.cfnlint.rules.functions.Select.SelectCheck if Select values are correct
class
src.cfnlint.rules.functions.Split.SplitCheck if Split values are correct
class
src.cfnlint.rules.functions.Sub.SubCheck if Sub values are correct
class
src.cfnlint.rules.functions.SubParametersUsed.SubParametersUsedCheck if Sub Parameters are used
class
src.cfnlint.rules.functions.SubUnneeded.SubUnneededCheck if Sub is using a variable
class
src.cfnlint.rules.functions.ToJsonString.ToJsonStringCheck if ToJsonString values are correct
class
src.cfnlint.rules.jsonschema.Base.BaseJsonSchemaThe base JSON schema package
class
src.cfnlint.rules.jsonschema.JsonSchema.JsonSchemaCheck Base Template Settings
method
src.cfnlint.rules.jsonschema.JsonSchema.JsonSchema.match(cfn:Template) -> RuleMatchesCheck CloudFormation Parameters
class
src.cfnlint.rules.jsonschema.MaxProperties.MaxPropertiesCheck maxProperties are correct
class
src.cfnlint.rules.jsonschema.PropertyNames.PropertyNamesCheck maxLength values are correct
class
src.cfnlint.rules.mappings.ApproachingMaxLength.ApproachingMaxLengthCheck maximum Mapping name size limit
class
src.cfnlint.rules.mappings.ApproachingMaxProperties.ApproachingMaxPropertiesCheck maximum Mapping limit
class
src.cfnlint.rules.mappings.Configuration.ConfigurationCheck if Mappings are configured correctly
class
src.cfnlint.rules.mappings.MaxLength.PropertyNamesCheck for string length in Mappings
class
src.cfnlint.rules.mappings.MaxProperties.MaxPropertiesCheck if maximum Mappings limit is exceeded
class
src.cfnlint.rules.mappings.Used.UsedCheck if Mappings are used anywhere in the template
class
src.cfnlint.rules.outputs.ApproachingMaxLength.ApproachingMaxLengthCheck maximum Output name size limit
class
src.cfnlint.rules.outputs.ApproachingMaxProperties.ApproachingLimitNumberCheck maximum Output limit
class
src.cfnlint.rules.outputs.Configuration.ConfigurationCheck Base Outputs Configuration
class
src.cfnlint.rules.outputs.Export.ExportCheck if Output Export values
class
src.cfnlint.rules.outputs.ImportValue.ImportValueCheck if a Output is done of another output
class
src.cfnlint.rules.outputs.MaxLength.PropertyNamesCheck for string length in Outputs
class
src.cfnlint.rules.outputs.MaxProperties.MaxPropertiesCheck if maximum Output limit is exceeded
class
src.cfnlint.rules.outputs.Pattern.PatternCheck if Outputs strings are less than the max length
class
src.cfnlint.rules.outputs.Required.RequiredCheck if Outputs have required properties
class
src.cfnlint.rules.outputs.Type.TypeCheck if Outputs have the correct type
class
src.cfnlint.rules.outputs.Value.ValueCheck if Outputs have string values
class
src.cfnlint.rules.parameters.ApproachingMaxLength.ApproachingMaxLengthCheck maximum Parameter name size limit
class
src.cfnlint.rules.parameters.ApproachingMaxProperties.LimitNumberCheck maximum Parameter limit
class
src.cfnlint.rules.parameters.Configuration.ConfigurationCheck if Parameters are configured correctly
class
src.cfnlint.rules.parameters.Default.DefaultCheck if Parameters are configured correctly
class
src.cfnlint.rules.parameters.Enum.EnumCheck if parameters have a valid value
class
src.cfnlint.rules.parameters.MaxProperties.LimitNumberCheck if maximum Parameter limit is exceeded
class
src.cfnlint.rules.parameters.NumberRange.NumberRangeCheck if a Number has a length within the limit
class
src.cfnlint.rules.parameters.Types.TypesCheck if Parameters are typed
class
src.cfnlint.rules.parameters.UnsupportedParameterType.UnsupportedParameterTypeCheck if Parameters use unsupported types
class
src.cfnlint.rules.parameters.Used.UsedCheck if Parameters are used
class
src.cfnlint.rules.parameters.ValuePattern.ValuePatternCheck if parameters have a valid value
class
src.cfnlint.rules.resources.ApproachingMaxLength.ApproachingMaxLengthCheck maximum Resource name size limit
class
src.cfnlint.rules.resources.ApproachingMaxProperties.ApproachingMaxPropertiesCheck maximum Resource limit
class
src.cfnlint.rules.resources.CfnInit.CfnInitCheck CloudFormation Init items
class
src.cfnlint.rules.resources.CircularDependency.CircularDependencyCheck if Resources have a circular dependency
class
src.cfnlint.rules.resources.Configuration.ConfigurationCheck Base Resource Configuration
class
src.cfnlint.rules.resources.DeletionPolicy.DeletionPolicyCheck Base Resource Configuration
class
src.cfnlint.rules.resources.DependsOn.DependsOnCheck Base Resource Configuration
class
src.cfnlint.rules.resources.DependsOnObsolete.DependsOnObsoleteCheck unneeded DepensOn Resource Configuration
class
src.cfnlint.rules.resources.MaxProperties.MaxPropertiesCheck if maximum Resource limit is exceeded
class
src.cfnlint.rules.resources.Metadata.MetadataCheck Base Resource Configuration
class
src.cfnlint.rules.resources.Modules.ModulesCheck that Modules do not contain invalid data
class
src.cfnlint.rules.resources.ResourceType.ResourceTypeCheck Base Resource Configuration
class
src.cfnlint.rules.resources.UpdateReplacePolicy.UpdateReplacePolicyCheck Base Resource Configuration
class
src.cfnlint.rules.resources.cloudfront.Aliases.AliasesCheck if CloudFront Aliases are valid domain names
class
src.cfnlint.rules.resources.dynamodb.AttributeMismatch.AttributeMismatchCheck DynamoDB Attributes
method
src.cfnlint.rules.resources.dynamodb.AttributeMismatch.AttributeMismatch.check(properties, path, cfn)Check itself
class
src.cfnlint.rules.resources.iam.IdentityPolicy.IdentityPolicyCheck IAM identity Policies
class
src.cfnlint.rules.resources.iam.Permissions.PermissionsCheck IAM Permission configuration
class
src.cfnlint.rules.resources.iam.Policy.PolicyCheck IAM policies
class
src.cfnlint.rules.resources.iam.PolicyVersion.PolicyVersionCheck if IAM Policy Version is correct
class
src.cfnlint.rules.resources.iam.RefWithPath.RefWithPathCheck if IAM Policy Version is correct
method
src.cfnlint.rules.resources.iam.RefWithPath.RefWithPath.check_ref(value, parameters, resources, path)Check Ref
class
src.cfnlint.rules.resources.iam.ResourceEcrPolicy.ResourceEcrPolicyCheck ECR repository policies
class
src.cfnlint.rules.resources.iam.ResourcePolicy.ResourcePolicyCheck IAM resource Policies
class
src.cfnlint.rules.resources.iam.RoleArnPattern.RoleArnPatternCheck role arn pattern
class
src.cfnlint.rules.resources.iam.TrustPolicy.TrustPolicyCheck IAM trust Policies
class
src.cfnlint.rules.resources.lmbd.SnapStart.SnapStartCheck if Lambda SnapStart is properly configured
class
src.cfnlint.rules.resources.properties.AnyOf.AnyOfCheck Properties Resource Configuration
class
src.cfnlint.rules.resources.properties.ArrayLength.ArrayLengthCheck if List has a size within the limit
class
src.cfnlint.rules.resources.properties.AvailabilityZone.AvailabilityZoneCheck Availibility Zone parameter checks
class
src.cfnlint.rules.resources.properties.DependentExcluded.DependentExcludedCheck Required Resource Configuration
class
src.cfnlint.rules.resources.properties.DependentRequired.DependentRequiredCheck Required Resource Configuration
class
src.cfnlint.rules.resources.properties.Enum.EnumCheck if properties have a valid value
class
src.cfnlint.rules.resources.properties.MaxUniqueItems.MaxUniqueItemsCheck if a list has too many unique values
class
src.cfnlint.rules.resources.properties.NumberRange.NumberRangeCheck if a Number has a length within the limit
class
src.cfnlint.rules.resources.properties.OneOf.OneOfCheck Properties Resource Configuration
method
src.cfnlint.rules.resources.properties.Password.Password.match(cfn:Template) -> RuleMatchesCheck CloudFormation Password Parameters
class
src.cfnlint.rules.resources.properties.Pattern.PatternCheck if properties have a valid value
class
src.cfnlint.rules.resources.properties.PrefixItems.PrefixItemsCheck Required Resource Configuration
class
src.cfnlint.rules.resources.properties.Properties.PropertiesCheck Base Resource Configuration
class
src.cfnlint.rules.resources.properties.PropertiesTemplated.PropertiesTemplatedCheck Base Resource Configuration
class
src.cfnlint.rules.resources.properties.ReadOnly.ReadOnlyCheck Base Resource Configuration
class
src.cfnlint.rules.resources.properties.Required.RequiredCheck Required Resource Configuration
class
src.cfnlint.rules.resources.properties.RequiredXor.RequiredXorCheck Required Resource Configuration
class
src.cfnlint.rules.resources.properties.Type.TypeCheck if Resource PrimitiveTypes are correct
class
src.cfnlint.rules.resources.properties.UniqueItems.UniqueItemsCheck if duplicates exist in a List
class
src.cfnlint.rules.resources.properties.UniqueItemsAllowed.UniqueItemsAllowedCheck if duplicates exist in a List
class
src.cfnlint.rules.resources.route53.RecordSet.RecordSetCheck Route53 Recordset Configuration
class
src.cfnlint.rules.resources.route53.RecordSetAlias.RecordSetAliasCheck Route53 Recordset Configuration
class
src.cfnlint.rules.resources.updatepolicy.Configuration.ConfigurationCheck Update Policy Configuration
class
src.cfnlint.rules.templates.ApproachingLimitDescription.ApproachingLimitDescriptionCheck Template Description Size
class
src.cfnlint.rules.templates.ApproachingLimitSize.LimitSizeCheck Template Size
class
src.cfnlint.rules.templates.Description.DescriptionCheck Template Description is only a String
class
src.cfnlint.rules.templates.LimitDescription.LimitDescriptionCheck Template Description Size
class
src.cfnlint.rules.templates.LimitSize.LimitSizeCheck Template Size
class
src.cfnlint.rules.transforms.Configuration.ConfigurationCheck if Parameters are configured correctly
class
src.cfnlint.schema._getatts.GetAttsClass for helping with GetAtt logic
method
src.cfnlint.schema._schema.Schema.get_atts() -> AttributeDictGet the valid GetAtts for this schema.
method
src.cfnlint.schema._schema.Schema.type_name() -> strReturn the type name of the schema
class
src.cfnlint.schema.resolver._exceptions.RefResolutionErrorA ref could not be resolved.
method
src.cfnlint.schema.resolver._resolver.RefResolver.from_schema(schema, **kwargs) -> 'RefResolver'Construct a resolver from a JSON schema object.
method
src.cfnlint.schema.resolver._resolver.RefResolver.push_scope(scope)Enter a given sub-scope.
method
src.cfnlint.schema.resolver._resolver.RefResolver.resolve(ref)Resolve the given reference.
method
src.cfnlint.schema.resolver._resolver.RefResolver.resolve_cfn_pointer(pointer:str) -> dict[str, Any]Resolve the given cfn pointer.
method
src.cfnlint.schema.resolver._resolver.RefResolver.resolve_from_url(url)Resolve the given URL.
func
src.cfnlint.schema.resolver._utils.id_of(schema:Any) -> strReturn the ID of a schema for recent JSON Schema drafts.
class
src.cfnlint.template.template.TemplateClass representing a CloudFormation template.
method
src.cfnlint.template.template.Template.build_graph() -> NoneGenerates a DOT representation of the template
method
src.cfnlint.template.template.Template.get_modules() -> dict[str, dict[str, Any]]Get the modules in the template.
method
src.cfnlint.template.template.Template.get_parameters_valid() -> dict[str, dict[str, Any]]Get the valid parameters in the template.
method
src.cfnlint.template.template.Template.get_resources(resource_type:list[str] | str=[]) -> dict[str, dict[str, Any]]Get the resources in the template.
method
src.cfnlint.template.template.Template.transform() -> list[Match]Transform the template.
func
src.cfnlint.template.transforms._sam_globals.merge_globals(template:dict[str, Any]) -> dict[str, Any]Merge Globals properties into SAM resources.
method
src.cfnlint.template.transforms.transform.Transform.transform(cfn:Any) -> list[Match]Transform logic
この情報について
掲載しているシグネチャは aws-cloudformation/cfn-lint の公開ソースコードを
Python の ast モジュールで静的解析し、引数名・デフォルト値・
型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。
詳しくは仕組みの解説をご覧ください。