no-variable-construct-id
✅ recommended を使用した場合、このルールが有効になります。
このルールは、Construct ID に変数を使用しないことを強制するものです。
Construct ID に変数を使用することは、以下の問題を引き起こす可能性があるため適切ではありません
(for, while, forEach, map などのループ処理は対象外です)
- 不要な重複
- パラメータ変更時のリソース再作成
- ID の一意性を重視するあまり、不要な文字列を混在させてしまう
(このルールは Construct
から派生したクラスにのみ適用されます)
🔧 使用方法
js
// eslint.config.mjs
export default [
{
// ... some configs
rules: {
"cdk/no-variable-construct-id": "error",
},
},
];
✅ 正しい例
ts
import { Construct } from "constructs";
import { Bucket } from "aws-cdk-lib/aws-s3";
export interface MyConstructProps {
environments: Record<string, string>;
}
class MyConstruct extends Construct {
constructor(scope: Construct, id: string, props: MyConstructProps) {
super(scope, id);
// ✅ 文字列リテラルは使用できます
new Bucket(this, "Bucket");
// ✅ ループ変数内では Construct ID に変数を使用できます
for (const [key, value] of Object.entries(props.environments)) {
new Bucket(this, `${key}Bucket`);
}
}
}
❌ 不正な例
ts
import { Construct } from "constructs";
import { Bucket } from "aws-cdk-lib/aws-s3";
export interface MyConstructProps {
stage: string;
}
class MyConstruct extends Construct {
constructor(scope: Construct, id: string, props: MyConstructProps) {
super(scope, id);
// ❌ Construct ID に constructor の `id` プロパティを直接指定できません
new Bucket(this, id);
// ❌ Construct ID に変数を使用できません (テンプレート文字列を使用)
new Bucket(this, `${props.stage}Bucket`);
}
}