require-passing-this

✅ 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 enforces passing this in a Construct.
(This rule applies only to classes that extends Construct.)

When creating AWS CDK resources, passing this to the Construct is crucial for maintaining the correct resource hierarchy.
Using other values like scope can lead to:

• Incorrect resource hierarchy in the generated CloudFormation template
• Unexpected resource naming

Options

This rule has an options with the following properties:

allowNonThisAndDisallowScope (default: false)

When true, allows non-this values for the first argument of a Construct constructor. (but the scope variable is disallowed). This is useful when you want to create a construct as a child of another construct.

Note: The recommended rule set has true specified.

---

🔧 How to use

// eslint.config.mjs
export default [
  {
    // ... some configs
    rules: {
      // Default: require `this` for all Construct instantiations
      "cdk/require-passing-this": "error",

      // Allow non-`this` values (but the `scope` variable is disallowed)
      "cdk/require-passing-this": [
        "error",
        { allowNonThisAndDisallowScope: true },
      ],
    },
  },
];

✅ Correct Example

import { Construct } from "constructs";
import { Bucket } from "aws-cdk-lib/aws-s3";

export class MyConstruct extends Construct {
  constructor(scope: Construct, id: string) {
    super(scope, id);

    // ✅ Can use this
    new Bucket(this, "SampleBucket");

    // ✅ With allowNonThisAndDisallowScope is true, can use non-this values (but the scope variable is disallowed)
    const sample = new SampleConstruct(this, "Sample");
    new OtherConstruct(sample, "Child"); // Valid when allowNonThisAndDisallowScope is true
  }
}

❌ Incorrect Example

import { Construct } from "constructs";
import { Bucket } from "aws-cdk-lib/aws-s3";

export class MyConstruct extends Construct {
  constructor(scope: Construct, id: string) {
    super(scope, id);

    // ❌ Shouldn't use scope
    new Bucket(scope, "SampleBucket"); // Invalid even when allowNonThisAndDisallowScope is true
  }
}