@critiq/rules 0.1.0 → 0.3.0

package/rules/cfn/cfn.maintainability.checks-for-legacy-instance-type-generations.rule.yaml

@@ -0,0 +1,49 @@
+apiVersion: critiq.dev/v1alpha1
+kind: Rule
+metadata:
+  id: cfn.maintainability.checks-for-legacy-instance-type-generations
+  title: Checks for legacy instance type generations
+  summary: Checks for legacy instance type generations
+  rationale: cfn-lint reports I3100 when Checks for legacy instance type generations.
+  aliases:
+    - CFLIN-I3100
+  tags:
+    - cfn
+    - cfn-lint
+    - cloudformation
+    - i3100
+    - rules-catalog
+  stability: stable
+  appliesTo: file
+  detection:
+    kind: pattern
+scope:
+  languages:
+    - all
+  paths:
+    include:
+      - "**/*.yaml"
+      - "**/*.yml"
+      - "**/*.json"
+    exclude:
+      - "**/node_modules/**"
+match:
+  fact:
+    kind: cfn.lint.finding
+    bind: finding
+    where:
+      - path: ruleId
+        equals: I3100
+emit:
+  finding:
+    category: maintainability.configuration
+    severity: low
+    confidence: 0.8
+    tags:
+      - cfn
+      - cloudformation
+  message:
+    title: Checks for legacy instance type generations
+    summary: "${captures.finding.text} matches cfn-lint I3100."
+  remediation:
+    summary: Resolve the cfn-lint I3100 finding in this CloudFormation template.

package/rules/cfn/cfn.maintainability.findinmap-keys-exist-in-the-map.rule.yaml

@@ -0,0 +1,49 @@
+apiVersion: critiq.dev/v1alpha1
+kind: Rule
+metadata:
+  id: cfn.maintainability.findinmap-keys-exist-in-the-map
+  title: Findinmap keys exist in the map
+  summary: Findinmap keys exist in the map
+  rationale: cfn-lint reports W1011 when Findinmap keys exist in the map.
+  aliases:
+    - CFLIN-W1011
+  tags:
+    - cfn
+    - cfn-lint
+    - cloudformation
+    - w1011
+    - rules-catalog
+  stability: stable
+  appliesTo: file
+  detection:
+    kind: pattern
+scope:
+  languages:
+    - all
+  paths:
+    include:
+      - "**/*.yaml"
+      - "**/*.yml"
+      - "**/*.json"
+    exclude:
+      - "**/node_modules/**"
+match:
+  fact:
+    kind: cfn.lint.finding
+    bind: finding
+    where:
+      - path: ruleId
+        equals: W1011
+emit:
+  finding:
+    category: maintainability.configuration
+    severity: medium
+    confidence: 0.85
+    tags:
+      - cfn
+      - cloudformation
+  message:
+    title: Findinmap keys exist in the map
+    summary: "${captures.finding.text} matches cfn-lint W1011."
+  remediation:
+    summary: Resolve the cfn-lint W1011 finding in this CloudFormation template.

package/rules/cfn/cfn.maintainability.fn-equals-will-always-return-true-or-false.rule.yaml

@@ -0,0 +1,49 @@
+apiVersion: critiq.dev/v1alpha1
+kind: Rule
+metadata:
+  id: cfn.maintainability.fn-equals-will-always-return-true-or-false
+  title: "Fn::equals will always return true or false"
+  summary: "Fn::equals will always return true or false"
+  rationale: "cfn-lint reports W8003 when Fn::equals will always return true or false."
+  aliases:
+    - CFLIN-W8003
+  tags:
+    - cfn
+    - cfn-lint
+    - cloudformation
+    - w8003
+    - rules-catalog
+  stability: stable
+  appliesTo: file
+  detection:
+    kind: pattern
+scope:
+  languages:
+    - all
+  paths:
+    include:
+      - "**/*.yaml"
+      - "**/*.yml"
+      - "**/*.json"
+    exclude:
+      - "**/node_modules/**"
+match:
+  fact:
+    kind: cfn.lint.finding
+    bind: finding
+    where:
+      - path: ruleId
+        equals: W8003
+emit:
+  finding:
+    category: maintainability.configuration
+    severity: medium
+    confidence: 0.85
+    tags:
+      - cfn
+      - cloudformation
+  message:
+    title: "Fn::equals will always return true or false"
+    summary: "${captures.finding.text} matches cfn-lint W8003."
+  remediation:
+    summary: Resolve the cfn-lint W8003 finding in this CloudFormation template.

package/rules/cfn/cfn.maintainability.mapping-attribute-limit.rule.yaml

@@ -0,0 +1,49 @@
+apiVersion: critiq.dev/v1alpha1
+kind: Rule
+metadata:
+  id: cfn.maintainability.mapping-attribute-limit
+  title: Mapping attribute limit
+  summary: Mapping attribute limit
+  rationale: cfn-lint reports I7012 when Mapping attribute limit.
+  aliases:
+    - CFLIN-I7012
+  tags:
+    - cfn
+    - cfn-lint
+    - cloudformation
+    - i7012
+    - rules-catalog
+  stability: stable
+  appliesTo: file
+  detection:
+    kind: pattern
+scope:
+  languages:
+    - all
+  paths:
+    include:
+      - "**/*.yaml"
+      - "**/*.yml"
+      - "**/*.json"
+    exclude:
+      - "**/node_modules/**"
+match:
+  fact:
+    kind: cfn.lint.finding
+    bind: finding
+    where:
+      - path: ruleId
+        equals: I7012
+emit:
+  finding:
+    category: maintainability.configuration
+    severity: low
+    confidence: 0.8
+    tags:
+      - cfn
+      - cloudformation
+  message:
+    title: Mapping attribute limit
+    summary: "${captures.finding.text} matches cfn-lint I7012."
+  remediation:
+    summary: Resolve the cfn-lint I7012 finding in this CloudFormation template.

package/rules/cfn/cfn.maintainability.mapping-limit.rule.yaml

@@ -0,0 +1,49 @@
+apiVersion: critiq.dev/v1alpha1
+kind: Rule
+metadata:
+  id: cfn.maintainability.mapping-limit
+  title: Mapping limit
+  summary: Mapping limit
+  rationale: cfn-lint reports I7010 when Mapping limit.
+  aliases:
+    - CFLIN-I7010
+  tags:
+    - cfn
+    - cfn-lint
+    - cloudformation
+    - i7010
+    - rules-catalog
+  stability: stable
+  appliesTo: file
+  detection:
+    kind: pattern
+scope:
+  languages:
+    - all
+  paths:
+    include:
+      - "**/*.yaml"
+      - "**/*.yml"
+      - "**/*.json"
+    exclude:
+      - "**/node_modules/**"
+match:
+  fact:
+    kind: cfn.lint.finding
+    bind: finding
+    where:
+      - path: ruleId
+        equals: I7010
+emit:
+  finding:
+    category: maintainability.configuration
+    severity: low
+    confidence: 0.8
+    tags:
+      - cfn
+      - cloudformation
+  message:
+    title: Mapping limit
+    summary: "${captures.finding.text} matches cfn-lint I7010."
+  remediation:
+    summary: Resolve the cfn-lint I7010 finding in this CloudFormation template.

package/rules/cfn/cfn.maintainability.mapping-name-limit.rule.yaml

@@ -0,0 +1,49 @@
+apiVersion: critiq.dev/v1alpha1
+kind: Rule
+metadata:
+  id: cfn.maintainability.mapping-name-limit
+  title: Mapping name limit
+  summary: Mapping name limit
+  rationale: cfn-lint reports I7011 when Mapping name limit.
+  aliases:
+    - CFLIN-I7011
+  tags:
+    - cfn
+    - cfn-lint
+    - cloudformation
+    - i7011
+    - rules-catalog
+  stability: stable
+  appliesTo: file
+  detection:
+    kind: pattern
+scope:
+  languages:
+    - all
+  paths:
+    include:
+      - "**/*.yaml"
+      - "**/*.yml"
+      - "**/*.json"
+    exclude:
+      - "**/node_modules/**"
+match:
+  fact:
+    kind: cfn.lint.finding
+    bind: finding
+    where:
+      - path: ruleId
+        equals: I7011
+emit:
+  finding:
+    category: maintainability.configuration
+    severity: low
+    confidence: 0.8
+    tags:
+      - cfn
+      - cloudformation
+  message:
+    title: Mapping name limit
+    summary: "${captures.finding.text} matches cfn-lint I7011."
+  remediation:
+    summary: Resolve the cfn-lint I7011 finding in this CloudFormation template.

package/rules/cfn/cfn.maintainability.metadata-interface-parameters-exist.rule.yaml

@@ -0,0 +1,49 @@
+apiVersion: critiq.dev/v1alpha1
+kind: Rule
+metadata:
+  id: cfn.maintainability.metadata-interface-parameters-exist
+  title: Metadata interface parameters exist
+  summary: Metadata interface parameters exist
+  rationale: cfn-lint reports W4001 when Metadata interface parameters exist.
+  aliases:
+    - CFLIN-W4001
+  tags:
+    - cfn
+    - cfn-lint
+    - cloudformation
+    - w4001
+    - rules-catalog
+  stability: stable
+  appliesTo: file
+  detection:
+    kind: pattern
+scope:
+  languages:
+    - all
+  paths:
+    include:
+      - "**/*.yaml"
+      - "**/*.yml"
+      - "**/*.json"
+    exclude:
+      - "**/node_modules/**"
+match:
+  fact:
+    kind: cfn.lint.finding
+    bind: finding
+    where:
+      - path: ruleId
+        equals: W4001
+emit:
+  finding:
+    category: maintainability.configuration
+    severity: medium
+    confidence: 0.85
+    tags:
+      - cfn
+      - cloudformation
+  message:
+    title: Metadata interface parameters exist
+    summary: "${captures.finding.text} matches cfn-lint W4001."
+  remediation:
+    summary: Resolve the cfn-lint W4001 finding in this CloudFormation template.

package/rules/cfn/cfn.maintainability.output-description-limit.rule.yaml

@@ -0,0 +1,49 @@
+apiVersion: critiq.dev/v1alpha1
+kind: Rule
+metadata:
+  id: cfn.maintainability.output-description-limit
+  title: Output description limit
+  summary: Output description limit
+  rationale: cfn-lint reports I6012 when Output description limit.
+  aliases:
+    - CFLIN-I6012
+  tags:
+    - cfn
+    - cfn-lint
+    - cloudformation
+    - i6012
+    - rules-catalog
+  stability: stable
+  appliesTo: file
+  detection:
+    kind: pattern
+scope:
+  languages:
+    - all
+  paths:
+    include:
+      - "**/*.yaml"
+      - "**/*.yml"
+      - "**/*.json"
+    exclude:
+      - "**/node_modules/**"
+match:
+  fact:
+    kind: cfn.lint.finding
+    bind: finding
+    where:
+      - path: ruleId
+        equals: I6012
+emit:
+  finding:
+    category: maintainability.configuration
+    severity: low
+    confidence: 0.8
+    tags:
+      - cfn
+      - cloudformation
+  message:
+    title: Output description limit
+    summary: "${captures.finding.text} matches cfn-lint I6012."
+  remediation:
+    summary: Resolve the cfn-lint I6012 finding in this CloudFormation template.

package/rules/cfn/cfn.maintainability.output-limit.rule.yaml

@@ -0,0 +1,49 @@
+apiVersion: critiq.dev/v1alpha1
+kind: Rule
+metadata:
+  id: cfn.maintainability.output-limit
+  title: Output limit
+  summary: Output limit
+  rationale: cfn-lint reports I6010 when Output limit.
+  aliases:
+    - CFLIN-I6010
+  tags:
+    - cfn
+    - cfn-lint
+    - cloudformation
+    - i6010
+    - rules-catalog
+  stability: stable
+  appliesTo: file
+  detection:
+    kind: pattern
+scope:
+  languages:
+    - all
+  paths:
+    include:
+      - "**/*.yaml"
+      - "**/*.yml"
+      - "**/*.json"
+    exclude:
+      - "**/node_modules/**"
+match:
+  fact:
+    kind: cfn.lint.finding
+    bind: finding
+    where:
+      - path: ruleId
+        equals: I6010
+emit:
+  finding:
+    category: maintainability.configuration
+    severity: low
+    confidence: 0.8
+    tags:
+      - cfn
+      - cloudformation
+  message:
+    title: Output limit
+    summary: "${captures.finding.text} matches cfn-lint I6010."
+  remediation:
+    summary: Resolve the cfn-lint I6010 finding in this CloudFormation template.

package/rules/cfn/cfn.maintainability.output-name-limit.rule.yaml

@@ -0,0 +1,49 @@
+apiVersion: critiq.dev/v1alpha1
+kind: Rule
+metadata:
+  id: cfn.maintainability.output-name-limit
+  title: Output name limit
+  summary: Output name limit
+  rationale: cfn-lint reports I6011 when Output name limit.
+  aliases:
+    - CFLIN-I6011
+  tags:
+    - cfn
+    - cfn-lint
+    - cloudformation
+    - i6011
+    - rules-catalog
+  stability: stable
+  appliesTo: file
+  detection:
+    kind: pattern
+scope:
+  languages:
+    - all
+  paths:
+    include:
+      - "**/*.yaml"
+      - "**/*.yml"
+      - "**/*.json"
+    exclude:
+      - "**/node_modules/**"
+match:
+  fact:
+    kind: cfn.lint.finding
+    bind: finding
+    where:
+      - path: ruleId
+        equals: I6011
+emit:
+  finding:
+    category: maintainability.configuration
+    severity: low
+    confidence: 0.8
+    tags:
+      - cfn
+      - cloudformation
+  message:
+    title: Output name limit
+    summary: "${captures.finding.text} matches cfn-lint I6011."
+  remediation:
+    summary: Resolve the cfn-lint I6011 finding in this CloudFormation template.

package/rules/cfn/cfn.maintainability.parameter-limit.rule.yaml

@@ -0,0 +1,49 @@
+apiVersion: critiq.dev/v1alpha1
+kind: Rule
+metadata:
+  id: cfn.maintainability.parameter-limit
+  title: Parameter limit
+  summary: Parameter limit
+  rationale: cfn-lint reports I2010 when Parameter limit.
+  aliases:
+    - CFLIN-I2010
+  tags:
+    - cfn
+    - cfn-lint
+    - cloudformation
+    - i2010
+    - rules-catalog
+  stability: stable
+  appliesTo: file
+  detection:
+    kind: pattern
+scope:
+  languages:
+    - all
+  paths:
+    include:
+      - "**/*.yaml"
+      - "**/*.yml"
+      - "**/*.json"
+    exclude:
+      - "**/node_modules/**"
+match:
+  fact:
+    kind: cfn.lint.finding
+    bind: finding
+    where:
+      - path: ruleId
+        equals: I2010
+emit:
+  finding:
+    category: maintainability.configuration
+    severity: low
+    confidence: 0.8
+    tags:
+      - cfn
+      - cloudformation
+  message:
+    title: Parameter limit
+    summary: "${captures.finding.text} matches cfn-lint I2010."
+  remediation:
+    summary: Resolve the cfn-lint I2010 finding in this CloudFormation template.

package/rules/cfn/cfn.maintainability.parameter-memory-size-attributes-should-have-max-and-min.rule.yaml

@@ -0,0 +1,49 @@
+apiVersion: critiq.dev/v1alpha1
+kind: Rule
+metadata:
+  id: cfn.maintainability.parameter-memory-size-attributes-should-have-max-and-min
+  title: Parameter memory size attributes should have max and min
+  summary: Parameter memory size attributes should have max and min
+  rationale: cfn-lint reports W2510 when Parameter memory size attributes should have max and min.
+  aliases:
+    - CFLIN-W2510
+  tags:
+    - cfn
+    - cfn-lint
+    - cloudformation
+    - w2510
+    - rules-catalog
+  stability: stable
+  appliesTo: file
+  detection:
+    kind: pattern
+scope:
+  languages:
+    - all
+  paths:
+    include:
+      - "**/*.yaml"
+      - "**/*.yml"
+      - "**/*.json"
+    exclude:
+      - "**/node_modules/**"
+match:
+  fact:
+    kind: cfn.lint.finding
+    bind: finding
+    where:
+      - path: ruleId
+        equals: W2510
+emit:
+  finding:
+    category: maintainability.configuration
+    severity: medium
+    confidence: 0.85
+    tags:
+      - cfn
+      - cloudformation
+  message:
+    title: Parameter memory size attributes should have max and min
+    summary: "${captures.finding.text} matches cfn-lint W2510."
+  remediation:
+    summary: Resolve the cfn-lint W2510 finding in this CloudFormation template.

package/rules/cfn/cfn.maintainability.parameter-name-limit.rule.yaml

@@ -0,0 +1,49 @@
+apiVersion: critiq.dev/v1alpha1
+kind: Rule
+metadata:
+  id: cfn.maintainability.parameter-name-limit
+  title: Parameter name limit
+  summary: Parameter name limit
+  rationale: cfn-lint reports I2011 when Parameter name limit.
+  aliases:
+    - CFLIN-I2011
+  tags:
+    - cfn
+    - cfn-lint
+    - cloudformation
+    - i2011
+    - rules-catalog
+  stability: stable
+  appliesTo: file
+  detection:
+    kind: pattern
+scope:
+  languages:
+    - all
+  paths:
+    include:
+      - "**/*.yaml"
+      - "**/*.yml"
+      - "**/*.json"
+    exclude:
+      - "**/node_modules/**"
+match:
+  fact:
+    kind: cfn.lint.finding
+    bind: finding
+    where:
+      - path: ruleId
+        equals: I2011
+emit:
+  finding:
+    category: maintainability.configuration
+    severity: low
+    confidence: 0.8
+    tags:
+      - cfn
+      - cloudformation
+  message:
+    title: Parameter name limit
+    summary: "${captures.finding.text} matches cfn-lint I2011."
+  remediation:
+    summary: Resolve the cfn-lint I2011 finding in this CloudFormation template.

package/rules/cfn/cfn.maintainability.parameter-value-limit.rule.yaml

@@ -0,0 +1,49 @@
+apiVersion: critiq.dev/v1alpha1
+kind: Rule
+metadata:
+  id: cfn.maintainability.parameter-value-limit
+  title: Parameter value limit
+  summary: Parameter value limit
+  rationale: cfn-lint reports I2012 when Parameter value limit.
+  aliases:
+    - CFLIN-I2012
+  tags:
+    - cfn
+    - cfn-lint
+    - cloudformation
+    - i2012
+    - rules-catalog
+  stability: stable
+  appliesTo: file
+  detection:
+    kind: pattern
+scope:
+  languages:
+    - all
+  paths:
+    include:
+      - "**/*.yaml"
+      - "**/*.yml"
+      - "**/*.json"
+    exclude:
+      - "**/node_modules/**"
+match:
+  fact:
+    kind: cfn.lint.finding
+    bind: finding
+    where:
+      - path: ruleId
+        equals: I2012
+emit:
+  finding:
+    category: maintainability.configuration
+    severity: low
+    confidence: 0.8
+    tags:
+      - cfn
+      - cloudformation
+  message:
+    title: Parameter value limit
+    summary: "${captures.finding.text} matches cfn-lint I2012."
+  remediation:
+    summary: Resolve the cfn-lint I2012 finding in this CloudFormation template.