一般的な AWS CDK 問題のトラブルシューティング - AWS クラウド開発キット (AWS CDK) v2
AWS CDK を更新した後、 AWS CDK Toolkit (CLI) は AWS コンストラクトライブラリとの不一致を報告します。AWS CDK スタックをデプロイすると、NoSuchBucketエラーが表示されるAWS CDK スタックをデプロイすると、forbidden: nullメッセージが表示されますAWS CDK スタックを合成すると、メッセージが表示される --app is required either in command-line, in cdk.json or in ~/.cdk.jsonAWS CDK スタックを合成するときに、 AWS CloudFormation テンプレートに含まれるリソースが多すぎるため、エラーが発生します。Auto Scaling グループまたは VPC に 3 つ (またはそれ以上) のアベイラビリティーゾーンを指定したが、2 つしかデプロイされないcdk destroy を発行しても、S3 バケット、DynamoDB テーブル、その他のリソースが削除されない

これは AWS CDK v2 デベロッパーガイドです。旧版の CDK v1 は 2022 年 6 月 1 日にメンテナンスを開始し、2023 年 6 月 1 日にサポートを終了しました。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

一般的な AWS CDK 問題のトラブルシューティング

このトピックでは、 AWS CDK に関する以下の問題のトラブルシューティング方法について説明します。

AWS CDK を更新した後、 AWS CDK Toolkit (CLI) は AWS コンストラクトライブラリとの不一致を報告します。

AWS CDK Toolkit ( cdk コマンドを提供します) のバージョンは、メインの AWS コンストラクトライブラリモジュール のバージョンと少なくとも同じである必要がありますaws-cdk-lib。Toolkit は下位互換性があるように設計されています。最新の 2.x バージョンの Toolkit は、ライブラリの任意の 1.x または 2.x リリースで使用できます。このため、このコンポーネントをグローバルにインストールして最新の状態に保つことをお勧めします。

npm update -g aws-cdk

AWS CDK Toolkit の複数のバージョンを使用する必要がある場合は、特定のバージョンのツールキットをプロジェクトフォルダにローカルにインストールします。

TypeScript または JavaScript を使用している場合、プロジェクトディレクトリに CDK Toolkit のバージョニングされたローカルコピーが既に含まれています。

別の言語を使用している場合は、 を使用して AWS CDK Toolkit をインストールnpmし、 -gフラグを省略して目的のバージョンを指定します。例:

npm install aws-cdk@2.0

ローカルにインストールされた AWS CDK Toolkit を実行するには、 のみnpx aws-cdkではなく コマンドを使用しますcdk。例:

npx aws-cdk deploy MyStack

npx aws-cdk は AWS CDK Toolkit のローカルバージョンが存在する場合、そのローカルバージョンを実行します。プロジェクトにローカルインストールがない場合、グローバルバージョンに戻ります。cdk が常にこの方法で呼び出されるように、シェルエイリアスを設定すると便利な場合があります。

macOS/Linux
alias cdk="npx aws-cdk"
Windows
doskey cdk=npx aws-cdk $*

AWS CDK スタックをデプロイすると、NoSuchBucketエラーが表示される

AWS 環境はブートストラップされていないため、デプロイ中にリソースを保持する Amazon S3 バケットはありません。次のコマンドを使用し、ステージングバケットやその他の必要なリソースを作成できます。

cdk bootstrap aws://ACCOUNT-NUMBER/REGION

予期しない AWS 料金が発生しないように、 AWS CDK は環境を自動的にブートストラップしません。デプロイする各環境を明示的にブートストラップする必要があります。

デフォルトでは、ブートストラップリソースは、現在の AWS CDK アプリケーションのスタックで使用されるリージョンに作成されます。または、ローカル AWS プロファイルで指定されたリージョン ( によって設定aws configure) で、そのプロファイルのアカウントを使用して作成されます。コマンドラインに、次のように別のアカウントおよびリージョンを指定できます。（アプリの ディレクトリにない場合は、アカウントとリージョンを指定する必要があります）。

cdk bootstrap aws://ACCOUNT-NUMBER/REGION

詳細については、AWS 「CDK ブートストラップ」を参照してください。

AWS CDK スタックをデプロイすると、forbidden: nullメッセージが表示されます

ブートストラップリソースを必要とするスタックをデプロイしていますが、書き込み許可のない IAM ロールまたはアカウントを使用しています。（ステージングバケットは、アセットを含むスタック、または 50K を超える AWS CloudFormation テンプレートを合成するスタックをデプロイするときに使用されます）。エラーメッセージに記載されているバケットに対して s3:* アクションを実行する許可を持つアカウントまたはロールを使用します。

AWS CDK スタックを合成すると、メッセージが表示される --app is required either in command-line, in cdk.json or in ~/.cdk.json

このメッセージは通常、 を発行するときに AWS CDK プロジェクトのメインディレクトリにないことを意味しますcdk synth。cdk init コマンドによって作成されたこのディレクトリcdk.jsonの ファイルには、 AWS CDK アプリケーションを実行 (および合成) するために必要なコマンドラインが含まれています。例えば、TypeScript アプリの場合、デフォルトの cdk.json は次のようになります。

{
  "app": "npx ts-node bin/my-cdk-app.ts"
}

AWS CDK ツールキットがcdk.jsonそこで見つけてアプリを正常に実行できるように、プロジェクトのメインディレクトリでのみcdkコマンドを発行することをお勧めします。

何らかの理由でこれが実用的でない場合、 AWS CDK Toolkit は他の 2 つの場所でアプリケーションのコマンドラインを検索します。

  • ホームディレクトリの cdk.json で

  • -a オプションを使用して cdk synth コマンド自体で

例えば、次のように TypeScript アプリからスタックを合成できます。

cdk synth --app "npx ts-node my-cdk-app.ts" MyStack

AWS CDK スタックを合成するときに、 AWS CloudFormation テンプレートに含まれるリソースが多すぎるため、エラーが発生します。

AWS CDK は AWS CloudFormation テンプレートを生成してデプロイします。 AWS CloudFormation には、スタックに含めることができるリソースの数にハード制限があります。 AWS CDK を使用すると、この制限に対して予想よりも迅速に実行できます。

注記

この書き込みでは、 AWS CloudFormation リソースの制限は 500 です。現在のリソース制限については、AWS CloudFormation クォータ」を参照してください。

AWS コンストラクトライブラリの高レベルのインテントベースのコンストラクトは、ログ記録、キー管理、認可、その他の目的に必要な補助リソースを自動的にプロビジョニングします。例えば、あるリソースに別のリソースへのアクセスを許可すると、関連サービスが通信するために必要な IAM オブジェクトが生成されます。

経験上、インテントベースのコンストラクトを実際に使用すると、コンストラクトごとに 1～5 AWS CloudFormation リソースになりますが、これは異なる場合があります。サーバーレスアプリケーションの場合、API エンドポイントあたり 5～8 AWS リソースが一般的です。

より高い抽象化レベルを表すパターンを使用すると、より多くの AWS リソースをより少ないコードで定義できます。例: AWS CDK を使用して Fargate サービスを作成する の CDK コード。たとえば、 は 3 つのコンストラクトのみを定義しながら 50 個以上の AWS CloudFormation リソースを生成します。 AWSAWS

AWS CloudFormation リソース制限を超えると、 AWS CloudFormation 合成中にエラーが発生します。スタックが制限の 80% を超える場合、 AWS CDK は警告を発行します。スタックに maxResources プロパティを設定するか、maxResources を 0 に設定して検証を無効にすることにより、別の制限を適用できます。

ヒント

次のユーティリティスクリプトを使用し、合成された出力のリソースの正確な数を取得できます。（すべての AWS CDK 開発者は Node.js を必要とするため、スクリプトは JavaScript.)

// rescount.js - count the resources defined in a stack
// invoke with: node rescount.js <path-to-stack-json>
// e.g. node rescount.js cdk.out/MyStack.template.json

import * as fs from 'fs';
const path = process.argv[2];

if (path) fs.readFile(path, 'utf8', function(err, contents) {
  console.log(err ? `${err}` :
  `${Object.keys(JSON.parse(contents).Resources).length} resources defined in ${path}`);
}); else console.log("Please specify the path to the stack's output .json file");

スタックのリソース数が制限に近づいたら、再設計を検討して、スタックに含まれるリソースの数を減らします。たとえば、いくつかの Lambda 関数を組み合わせるか、スタックを複数のスタックに分割します。CDK はスタック間の参照をサポートしているため、アプリの機能をさまざまなスタックに分割できます。

注記

AWS CloudFormation の専門家は、多くの場合、リソース制限のソリューションとしてネストされたスタックの使用を提案します。 AWS CDK は、NestedStack コンストラクトを介してこのアプローチをサポートします。

Auto Scaling グループまたは VPC に 3 つ (またはそれ以上) のアベイラビリティーゾーンを指定したが、2 つしかデプロイされない

リクエストしたアベイラビリティーゾーンの数を取得するには、スタックの envプロパティでアカウントとリージョンを指定します。両方を指定しない場合、 AWS CDK はデフォルトでスタックを環境に依存しないものとして合成します。その後、 AWS CloudFormation を使用してスタックを特定のリージョンにデプロイできます。一部のリージョンには 2 つのアベイラビリティーゾーンしかないため、環境に依存しないテンプレートは 2 つ以上を使用しません。

注記

以前、リージョンは 1 つのアベイラビリティーゾーンのみで起動することがありました。環境に依存しない AWS CDK スタックをそのようなリージョンにデプロイすることはできません。ただし、この記述では、すべての AWS リージョンに少なくとも 2 つの AZs があります。

この動作を変更するには、スタックの availabilityZones (Python: availability_zones) プロパティを上書きして、使用するゾーンを明示的に指定します。

任意のリージョンにデプロイする柔軟性を維持しながら、合成時にスタックのアカウントとリージョンを指定する方法の詳細については、AWS 「CDK の環境」を参照してください。

cdk destroy を発行しても、S3 バケット、DynamoDB テーブル、その他のリソースが削除されない

デフォルトでは、ユーザーデータを含むことができるリソースには RETAIN の removalPolicy (Python: removal_policy) プロパティがあり、スタックが廃棄されたときにリソースは削除されません。代わりに、リソースはスタックから切り離された状態になります。その後、スタックが廃棄された後にリソースを手動で削除する必要があります。これを行わない限り、スタックの再デプロイは失敗します。デプロイ中に作成される新しいリソースの名前が、孤立したリソースの名前と競合するためです。

リソースの削除ポリシーを に設定するとDESTROY、スタックが破棄されると、そのリソースは削除されます。

TypeScript
import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
import * as s3 from 'aws-cdk-lib/aws-s3';

export class CdkTestStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    const bucket = new s3.Bucket(this, 'Bucket', {
      removalPolicy: cdk.RemovalPolicy.DESTROY,
    });
  }
}
JavaScript
const cdk = require('aws-cdk-lib');
const s3 = require('aws-cdk-lib/aws-s3');

class CdkTestStack extends cdk.Stack {
  constructor(scope, id, props) {
    super(scope, id, props);

    const bucket = new s3.Bucket(this, 'Bucket', {
      removalPolicy: cdk.RemovalPolicy.DESTROY
    });
  }
}

module.exports = { CdkTestStack }
Python
import aws_cdk as cdk
from constructs import Construct
import aws_cdk.aws_s3 as s3

class CdkTestStack(cdk.stack):
    def __init__(self, scope: Construct, id: str, **kwargs):
        super().__init__(scope, id, **kwargs)

        bucket = s3.Bucket(self, "Bucket",
            removal_policy=cdk.RemovalPolicy.DESTROY)
Java
software.amazon.awscdk.*;
import software.amazon.awscdk.services.s3.*;
import software.constructs;

public class CdkTestStack extends Stack {
    public CdkTestStack(final Construct scope, final String id) {
        this(scope, id, null);
    }

    public CdkTestStack(final Construct scope, final String id, final StackProps props) {
        super(scope, id, props);

        Bucket.Builder.create(this, "Bucket")
                .removalPolicy(RemovalPolicy.DESTROY).build();
    }
}
C#
using Amazon.CDK;
using Amazon.CDK.AWS.S3;

public CdkTestStack(Construct scope, string id, IStackProps props) : base(scope, id, props)
{
    new Bucket(this, "Bucket", new BucketProps {
        RemovalPolicy = RemovalPolicy.DESTROY
    });
}
注記

AWS CloudFormation は空でない Amazon S3 バケットを削除することはできません。Amazon S3 バケットの削除ポリシーを に設定しDESTROY、データが含まれている場合、バケットを削除できないため、スタックを破棄しようとすると失敗します。バケットの autoDeleteObjectsprop を に設定することで、バケット内のオブジェクトを破棄する前に AWS CDK に削除させることができますtrue。