no-mutable-property-of-props-interface

✅ Using recommended in an ESLint configuration enables this rule.

🔧 Some problems reported by this rule are automatically fixable by the --fix ESLint command line option

This rule disallows mutable properties in Props interfaces for CDK Constructs or Stacks. (It prohibits defining properties in an interface whose name ends with "Props" without the readonly modifier.)

Specifying mutable properties in Props interfaces is not recommended as it can lead to unintended side effects.

---

🔧 How to use

// eslint.config.mjs
export default defineConfig([
  {
    // ... some configs
    rules: {
      "cdk/no-mutable-property-of-props-interface": "error",
    },
  },
]);

✅ Correct Example

import { IBucket } from "aws-cdk-lib/aws-s3";

interface MyConstructProps {
  // ✅ readonly properties are allowed
  readonly bucket: IBucket;
}

import { IBucket } from "aws-cdk-lib/aws-s3";

// ✅ This rule does not apply to interfaces not ending with "Props"
interface MyInterface {
  bucket: IBucket;
}

❌ Incorrect Example

import { IBucket } from "aws-cdk-lib/aws-s3";

interface MyConstructProps {
  // ❌ Properties in "Props" interfaces should be readonly
  bucket: IBucket;
}

View on Playground