AWS CDK におけるプロパティ一括適用 TIPS 集

// Aspects は IAspect インターフェースを実装することで実現する
export class BucketVersioningUpdater implements cdk.IAspect {
  public visit(node: IConstruct): void {
    // Aspects によって渡された Construct の内部のリソース全てに visit メソッドが適用されるので、CfnBucket リソースの場合にのみ実行されるよう条件分岐をする
    if (node instanceof CfnBucket) {
      // バケットのバージョニング設定が無効の場合は有効に上書きする
      if (
        !node.versioningConfiguration ||
        (!cdk.Tokenization.isResolvable(node.versioningConfiguration) &&
          node.versioningConfiguration.status !== 'Enabled')
      ) {
        node.addPropertyOverride('VersioningConfiguration', {
          Status: 'Enabled',
        });
      }
    }
  }
}

const app = new cdk.App();
const stack = new CdkSampleStack(app, 'CdkSampleStack');

// CdkSampleStack 内の全てのリソースに対して BucketVersioningUpdater を適用
cdk.Aspects.of(stack).add(new BucketVersioningUpdater());

const app = new cdk.App();
const stack = new CdkSampleStack(app, 'CdkSampleStack');

// priority = 1000
cdk.Aspects.of(stack).add(new AspectForValidation(), { priority: cdk.AspectPriority.READONLY });
// priority = 200
cdk.Aspects.of(stack).add(new AspectForOverride(), { priority: cdk.AspectPriority.MUTATING });
// priority = 500
cdk.Aspects.of(stack).add(new AspectForOther1(), { priority: cdk.AspectPriority.DEFAULT });
// priority = 600
cdk.Aspects.of(stack).add(new AspectForOther2(), { priority: 600 });

export class MyBucketPropsInjector implements IPropertyInjector {
  public readonly constructUniqueId: string;

  constructor() {
    // Bucket コンストラクトが公開する PROPERTY_INJECTION_ID を指定
    this.constructUniqueId = Bucket.PROPERTY_INJECTION_ID;
  }

  // 任意のプロパティを上書きした新しい props を返す
  public inject(originalProps: BucketProps, _context: InjectionContext): BucketProps {
    return {
      blockPublicAccess: BlockPublicAccess.BLOCK_ALL,
      ...originalProps,
    };
  }
}

const app = new App();

// App に指定する場合
PropertyInjectors.of(app).add(new MyBucketPropsInjector());

// 特定のスタックに指定する場合
new Stack(app, 'MyStack', {
  propertyInjectors: [new MyBucketPropsInjector()],
});

export class SpecialBucketInjector implements IPropertyInjector {
  public readonly constructUniqueId: string;

  // スキップするか判断するためのフラグ
  private _skip: boolean;

  constructor() {
    this._skip = false;
    this.constructUniqueId = Bucket.PROPERTY_INJECTION_ID;
  }

  public inject(originalProps: BucketProps, context: InjectionContext): BucketProps {
    // スキップフラグが true の場合は、元のプロパティをそのまま返す
    if (this._skip) {
      return originalProps;
    }

    let accessLogBucket = originalProps?.serverAccessLogsBucket;
    if (!accessLogBucket) {
      // Construct 生成のタイミングで新しく PropertyInjectors が実行されるため、
      // ここでスキップフラグを true にしておく
      this._skip = true;

      // スキップフラグが true なのでこのインスタンスではプロパティの上書きが行われない
      // つまり、この Bucket に対しては `serverAccessLogsBucket` が上書きされない
      accessLogBucket = new Bucket(context.scope, 'my-access-log', {
        blockPublicAccess: BlockPublicAccess.BLOCK_ALL,
      });

      // スキップフラグを false に戻す
      this._skip = false;
    }

    return {
      serverAccessLogsBucket: accessLogBucket,
      ...originalProps,
    };
  }
}

const app = new App();

new CdkSampleStack(app, 'CdkSampleStack');

// ここで PropertyInjectors を適用しても、CdkSampleStack の生成後なので書き換え処理は実行されない
PropertyInjectors.of(app).add(new MyBucketPropsInjector());

const app = new App();

// スタックの生成より先に PropertyInjectors を適用する
PropertyInjectors.of(app).add(new MyBucketPropsInjector());
new CdkSampleStack(app, 'CdkSampleStack');

// もしくは スタックの props に指定する
new CdkSampleStack(app, 'CdkSampleStack', {
  propertyInjectors: [new MyBucketPropsInjector()],
});

const app = new App();

// すべてのリソースの RemovalPolicy を DESTROY に設定
RemovalPolicies.of(app).destroy();

// すべてのリソースの RemovalPolicy を RETAIN に設定
RemovalPolicies.of(app).retain();

const app = new App();

// RemovalPolicy がまだ設定されていないリソースに対して DESTROY に設定
MissingRemovalPolicies.of(app).destroy();