Cookie の設定を選択する

当社は、当社のサイトおよびサービスを提供するために必要な必須 Cookie および類似のツールを使用しています。当社は、パフォーマンス Cookie を使用して匿名の統計情報を収集することで、お客様が当社のサイトをどのように利用しているかを把握し、改善に役立てています。必須 Cookie は無効化できませんが、[カスタマイズ] または [拒否] をクリックしてパフォーマンス Cookie を拒否することはできます。

お客様が同意した場合、AWS および承認された第三者は、Cookie を使用して便利なサイト機能を提供したり、お客様の選択を記憶したり、関連する広告を含む関連コンテンツを表示したりします。すべての必須ではない Cookie を受け入れるか拒否するには、[受け入れる] または [拒否] をクリックしてください。より詳細な選択を行うには、[カスタマイズ] をクリックしてください。

設定
お問い合わせ
フィードバック
AWS Documentation
今すぐ無料サインアップ »

「AWS CDK デプロイ」アクション YAML

PDF
フォーカスモード
「AWS CDK デプロイ」アクション YAML - Amazon CodeCatalyst
CDKDeployIdentifierDependsOnComputeTypeFleetTimeoutInputsSourcesArtifacts - inputOutputsArtifacts - outputNameFilesEnvironmentNameConnectionsNameRoleConfigurationStackNameRegionTagsContextCdkCliVersionCdkRootPathCfnOutputVariablesCloudAssemblyRootPath

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

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

[AWS CDK デプロイ] アクションの YAML 定義を次に示します。このアクションの使用方法については、「ワークフローを使用した AWS CDK アプリケーションのデプロイ」を参照してください。

このアクション定義は、より広範なワークフロー定義ファイル内のセクションとして存在します。ファイルの詳細については、「ワークフロー YAML 定義」を参照してください。

注記

後続の YAML プロパティのほとんどには、対応する UI 要素がビジュアルエディタにあります。UI 要素を検索するには、[Ctrl+F] を使用します。要素は、関連付けられた YAML プロパティとともに一覧表示されます。

# The workflow definition starts here.
# See 最上位プロパティ for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.   
  CDKDeploy_nn: 
    Identifier: aws/cdk-deploy@v2
    DependsOn:
      - CDKBootstrap
    Compute:  
      Type: EC2 | Lambda
      Fleet: fleet-name
    Timeout: timeout-minutes
    Inputs:
      # Specify a source or an artifact, but not both.
      Sources:
        - source-name-1
      Artifacts:
        - artifact-name
    Outputs:
      Artifacts:
        - Name: cdk_artifact
          Files: 
            - "cdk.out/**/*"
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Configuration:
      StackName: my-cdk-stack
      Region: us-west-2
      Tags: '{"key1": "value1", "key2": "value2"}'
      Context: '{"key1": "value1", "key2": "value2"}'
      CdkCliVersion: version
      CdkRootPath: directory-containing-cdk.json-file
      CfnOutputVariables: '["CnfOutputKey1","CfnOutputKey2","CfnOutputKey3"]'
      CloudAssemblyRootPath: path-to-cdk.out

CDKDeploy

(必須)

アクションの名前を指定します。すべてのアクション名は、ワークフロー内で一意である必要があります。アクション名で使用できるのは、英数字 (a～z、A～Z、0～9)、ハイフン (-)、アンダースコア (_) のみです。スペースは使用できません。引用符を使用して、アクション名の特殊文字とスペースを有効にすることはできません。

デフォルト: CDKDeploy_nn。

対応する UI: [設定] タブ/[アクション名]

Identifier

(CDKDeploy/Identifier)

(必須)

アクションを識別します。バージョンを変更したい場合でない限り、このプロパティを変更しないでください。詳細については、「使用するアクションバージョンの指定」を参照してください。

注記

aws/cdk-deploy@v2 を指定すると、Node.js 18 などの新しいツールを含む 2024 年 3 月の画像でアクションが実行されます。aws/cdk-deploy@v1 を指定すると、Node.js 16 などの古いツールを含む 2022 年 11 月のイメージでアクションが実行されます。

デフォルト: aws/cdk-deploy@v2。

対応する UI: ワークフロー図/CDKDeploy_nn/aws/cdk-deploy@v2 ラベル

DependsOn

(CDKDeploy/DependsOn)

(オプション)

このアクションを実行するために正常に実行する必要があるアクション、アクショングループを指定します。次のような [AWS CDK ブートストラップ] アクションを DependsOn プロパティで指定することをお勧めします。

CDKDeploy:
  Identifier: aws/cdk-deploy@v2
  DependsOn:
    - CDKBootstrap
注記

[ブートストラップ] は、AWS CDK アプリケーションをデプロイするための必須の前提条件です。ワークフローに [AWS CDK ブートストラップ]アクションを含めない場合は、[AWS CDK デプロイアクション] を実行する前に、AWS CDK ブートストラップスタックをデプロイする別の方法を見つける必要があります。詳細については、「ワークフローを使用した AWS CDK アプリケーションのデプロイ」の AWS CDK 「デプロイ」アクションの追加 を参照してください。

「DependsOn」機能の詳細については、「アクションの順序付け」を参照してください。

対応する UI: [入力] タブ/[依存 - オプション]

Compute

(CDKDeploy/Compute)

(オプション)

ワークフローアクションの実行に使用されるコンピューティングエンジンです。コンピューティングはワークフローレベルまたはアクションレベルで指定できますが、両方を指定することはできません。ワークフローレベルで指定すると、コンピューティング設定はワークフローで定義されたすべてのアクションに適用されます。ワークフローレベルでは、同じインスタンスで複数のアクションを実行することもできます。詳細については、「アクション間でのコンピューティングの共有する」を参照してください。

対応する UI: なし

Type

(CDKDeploy/Compute/Type)

(Compute が含まれている場合は必須)

コンピューティングエンジンのタイプです。次のいずれかの値を使用できます。

  • EC2 (ビジュアルエディタ) または EC2 (YAML エディタ)

    アクション実行時の柔軟性を目的として最適化されています。

  • Lambda (ビジュアルエディタ) または Lambda (YAML エディタ)

    アクションの起動速度を最適化しました。

コンピューティングタイプの詳細については、「コンピューティングタイプ」を参照してください。

対応する UI: [設定] タブ/[高度な設定 - オプション]/[コンピューティングタイプ]

Fleet

(CDKDeploy/Compute/Fleet)

(オプション)

ワークフローまたはワークフローアクションを実行するマシンまたはフリートを指定します。オンデマンドフリートでは、アクションが開始すると、ワークフローは必要なリソースをプロビジョニングし、アクションが完了するとマシンは破棄されます。オンデマンドフリートの例: Linux.x86-64.Large、Linux.x86-64.XLarge。オンデマンドフリートの詳細については、「オンデマンドフリートのプロパティ」を参照してください。

プロビジョニングされたフリートでは、ワークフローアクションを実行するように専用マシンのセットを設定します。これらのマシンはアイドル状態のままで、アクションをすぐに処理できます。プロビジョニングされたフリートの詳細については、「プロビジョニングされたフリートのプロパティ」を参照してください。

Fleet を省略した場合、デフォルトは Linux.x86-64.Large です。

対応する UI: [設定] タブ/[高度な設定 - オプション]/[コンピューティングフリート]

Timeout

(CDKDeploy/Timeout)

(必須)

CodeCatalyst がアクションを終了するまでにアクションを実行できる時間を分単位 (YAML エディタ) または時間分単位 (ビジュアルエディタ) で指定します。最小値は 5 分で、最大値は CodeCatalyst のワークフローのクォータ で記述されています。デフォルトのタイムアウトは、最大タイムアウトと同じです。

対応する UI: [設定] タブ/[タイムアウト - オプション]

Inputs

(CDKDeploy/Inputs)

(オプション)

Inputs セクションでは、ワークフローの実行中に CDKDeploy に必要なデータを定義します。

注記

[AWS CDK デプロイ] アクションごとに 1 つの入力 (ソースまたはアーティファクト) のみが許可されます。

対応する UI: [入力] タブ

Sources

(CDKDeploy/Inputs/Sources)

(デプロイする AWS CDK アプリケーションがソースリポジトリに保存されている場合は必須)

AWS CDK アプリがソースリポジトリに保存されている場合は、そのソースリポジトリのラベルを指定します。[AWS CDK デプロイ] アクションは、デプロイプロセスを開始する前に、このリポジトリ内のアプリケーションを合成します。現在サポートされているラベルは、WorkflowSource のみです。

AWS CDK アプリがソースリポジトリに含まれていない場合、別のアクションによって生成されたアーティファクトに存在する必要があります。

sources の詳細については、「ワークフローへのソースリポジトリの接続」を参照してください。

対応する UI: 入力タブ/ソース - オプション

Artifacts - input

(CDKDeploy/Inputs/Artifacts)

(デプロイする AWS CDK アプリケーションが前のアクションの [出力アーティファクト] に保存されている場合は必須)

前のアクションによって生成されたアーティファクトに AWS CDK アプリが含まれている場合は、ここでそのアーティファクトを指定します。[AWS CDK デプロイ] アクションは、デプロイプロセスを開始する前に、指定されたアーティファクト内のアプリケーションを CloudFormation テンプレートに合成します。AWS CDK アプリがアーティファクトに含まれていない場合は、ソースリポジトリに存在する必要があります。

アーティファクトの詳細 (例を含む) については、「アクション間でのアーティファクトとファイルの共有」を参照してください。

対応する UI: 入力タブ/アーティファクト - オプション

Outputs

(CDKDeploy/Outputs)

(オプション)

ワークフローの実行中にアクションによって出力されるデータを定義します。

対応する UI: [出力] タブ

Artifacts - output

(CDKDeploy/Outputs/Artifacts

(オプション)

アクションによって生成されたアーティファクトを指定します。これらのアーティファクトは、他のアクションの入力として参照できます。

アーティファクトの詳細 (例を含む) については、「アクション間でのアーティファクトとファイルの共有」を参照してください。

対応する UI: [出力] タブ/[アーティファクト]

Name

(CDKDeploy/Outputs/Artifacts/Name)

(Artifacts - output が含まれている場合は必須)

実行時に [AWS CDK デプロイ] アクションによって合成される AWS CloudFormation テンプレートを含むアーティファクトの名前を指定します。デフォルト値は cdk_artifact です。アーティファクトを指定しない場合、アクションはテンプレートを合成しますが、アーティファクトには保存されません。テストまたはトラブルシューティングの目的で、合成されたテンプレートをアーティファクトに保存して、その記録を保持することを検討してください。

対応する UI: [出力] タブ/[アーティファクト]/[アーティファクトを追加]/[ビルドアーティファクト名]

Files

(CDKDeploy/Outputs/Artifacts/Files)

(Artifacts - output が含まれている場合は必須)

アーティファクトに含めるファイルを指定します。AWS CDK アプリの合成 AWS CloudFormation テンプレートを含めるには、"cdk.out/**/*" を指定する必要があります。

注記

cdk.out は、合成されたファイルが保存されるデフォルトのディレクトリです。cdk.json ファイルで cdk.out 以外の出力ディレクトリを指定した場合は、cdk.out の代わりに、ここでそのディレクトリを指定します。

対応する UI: [出力] タブ/[アーティファクト]/[アーティファクトを追加]/[ビルドで生成されるファイル]

Environment

(CDKDeploy/Environment)

(必須)

アクションで使用する CodeCatalyst 環境を指定します。アクションは、選択した環境で指定された AWS アカウント および任意の Amazon VPC に接続します。このアクションは、 環境で指定されたデフォルトの IAM ロールを使用して AWS アカウント に接続し、[Amazon VPC 接続] で指定された IAM ロールを使用して Amazon VPC に接続します。

注記

デフォルトの IAM ロールにアクションに必要なアクセス許可がない場合は、別のロールを使用するようにアクションを設定できます。詳細については、「アクションの IAM ロールの変更」を参照してください。

環境タグ付けの詳細については、「AWS アカウント と VPCsへのデプロイ」と「環境を作成する」を参照してください。

対応する UI: [設定] タブ/[環境]

Name

(CDKDeploy/Environment/Name)

(Environment が含まれている場合は必須)

アクションに関連付ける既存の環境の名前を指定します。

対応する UI: [設定] タブ/[環境]

Connections

(CDKDeploy/Environment/Connections)

(新しいバージョンのアクションでは任意。古いバージョンでは必須)

アクションに関連付けるアカウント接続を指定します。Environment で最大 1 つのアカウント接続を指定できます。

アカウント接続を指定しない場合:

  • このアクションは、CodeCatalyst コンソールの 環境で指定された AWS アカウント 接続とデフォルトの IAM ロールを使用します。アカウント接続とデフォルトの IAM ロールを環境に追加する方法については、「環境を作成する」を参照してください。

  • デフォルトの IAM ロールには、 アクションに必要なポリシーとアクセス許可が含まれている必要があります。これらのポリシーとアクセス許可を確認するには、アクションの YAML 定義ドキュメントの [ロール] プロパティの説明を参照してください。

アカウント接続の詳細については、「接続された AWS リソースへのアクセスを許可する AWS アカウント」を参照してください。アカウント接続を環境に追加する方法については、「環境を作成する」を参照してください。

対応する UI: アクションのバージョンに応じて、次のいずれか。

  • (新しいバージョン) [設定] タブ/[環境]/[my-environment の内容]/3 つのドットメニュー/[ロールを切り替える]

  • (旧バージョン) [設定] タブ/「環境/アカウント/ロール」/[AWS アカウント接続]

Name

(CDKDeploy/Environment/Connections/Name)

(Connections が含まれている場合は必須)

アカウント接続の名前を指定します。

対応する UI: アクションのバージョンに応じて、次のいずれか。

  • (新しいバージョン) [設定] タブ/[環境]/[my-environment の内容]/3 つのドットメニュー/[ロールを切り替える]

  • (旧バージョン) [設定] タブ/「環境/アカウント/ロール」/[AWS アカウント接続]

Role

(CDKDeploy/Environment/Connections/Role)

(Connections が含まれている場合は必須)

アカウント接続の名前を指定します。

[AWS CDK デプロイ] アクションが AWS CDK アプリケーションスタックへのアクセス AWS とデプロイに使用する IAM ロールの名前を指定します。ロールを CodeCatalyst スペース に追加し、ロールに次のポリシーが含まれていることを確認します。

IAM ロールを指定しない場合、アクションは CodeCatalyst コンソールの [環境] に記載されているデフォルトの IAM ロールを使用します。環境でデフォルトのロールを使用する場合は、次のポリシーがあることを確認してください。

  • 以下のアクセス許可ポリシー:

    警告

    アクセス許可は、次のポリシーに示すアクセス許可に制限します。より広範なアクセス許可を持つロールを使用すると、セキュリティリスクが発生する可能性があります。

    {
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "cloudformation:DescribeStackEvents",
                "cloudformation:DescribeChangeSet",
                "cloudformation:DescribeStacks",
                "cloudformation:ListStackResources"
            ],
            "Resource": "*"
        },
        {
            "Sid": "VisualEditor1",
            "Effect": "Allow",
            "Action": "sts:AssumeRole",
            "Resource": "arn:aws:iam::aws-account:role/cdk-*"
        }
    ]
}

  • 次のカスタム信頼ポリシー:

    {
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "",
            "Effect": "Allow",
            "Principal": {
                "Service":  [
                   "codecatalyst-runner.amazonaws.com",
                   "codecatalyst.amazonaws.com"
                 ]
            },
            "Action": "sts:AssumeRole"
        }
    ]
}
注記

必要に応じて、このアクションで CodeCatalystWorkflowDevelopmentRole-spaceName ロールを使用できます。このロールの詳細については、「アカウントとスペース用の CodeCatalystWorkflowDevelopmentRole-spaceName ロールを作成する」を参照してください。CodeCatalystWorkflowDevelopmentRole-spaceName ロールにはフルアクセス許可があり、セキュリティ上のリスクをもたらす可能性があることを理解してください。このロールは、セキュリティが懸念されないチュートリアルやシナリオでのみ使用することをお勧めします。

対応する UI: アクションのバージョンに応じて、次のいずれか。

  • (新しいバージョン) [設定] タブ/[環境]/[my-environment の内容]/3 つのドットメニュー/[ロールを切り替える]

  • (旧バージョン) [設定] タブ/「環境/アカウント/ロール」/[ロール]

Configuration

(CDKDeploy/Configuration)

(必須)

アクションの設定プロパティを定義できるセクション。

対応する UI: [設定] タブ

StackName

(CDKDeploy/Configuration/StackName)

(必須)

AWS CDK アプリの bin ディレクトリのエントリポイントファイルに表示される AWS CDK アプリスタックの名前です。次の例は、TypeScript エントリポイントファイルの内容を示し、スタック名は赤い斜体で強調表示されています。エントリポイントファイルが別の言語の場合、似ています。

import * as cdk from 'aws-cdk-lib';
import { CdkWorksopTypescriptStack } from '../lib/cdk_workshop_typescript-stack';

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

指定できるスタックは 1 つだけです。

ヒント

複数のスタックがある場合は、ネストされたスタックを使用して親スタックを作成できます。その後、このアクションで親スタックを指定して、すべてのスタックをデプロイできます。

対応する UI: [設定] タブ/[スタック名]

Region

(CDKDeploy/Configuration/Region)

(オプション)

AWS CDK アプリケーションスタックをデプロイする AWS リージョン を指定します。リージョンコードの一覧については、「リージョンエンドポイント」を参照してください。

リージョンを指定しない場合、[AWS CDK デプロイ] アクションは AWS CDK コードで指定されたリージョンにデプロイされます。詳細については、「AWS Cloud Development Kit (AWS CDK) デベロッパーガイド」の「環境枠」を参照してください。

対応する UI: [設定] タブ/[リージョン]

Tags

(CDKDeploy/Configuration/Tags)

(オプション)

AWS CDK アプリケーションスタックの AWS リソースに適用するタグを指定します。タグは、スタック自体とスタック内の個々のリソースに適用されます。タグ付けの詳細については、「AWS Cloud Development Kit (AWS CDK) デベロッパーガイド」の「タグ付け」を参照してください。

対応する UI: [設定] タブ/[高度な設定 - オプション]/[タグ]

Context

(CDKDeploy/Configuration/Context)

(オプション)

AWS CDK アプリケーションスタックに関連付けるコンテキストをキーと値のペアの形式で指定します。コンテキストの詳細については、「AWS Cloud Development Kit (AWS CDK) デベロッパーガイド」の「ランタイムコンテキスト」を参照してください。

対応する UI: [設定] タブ/[高度な設定 - オプション]/[コンテキスト]

CdkCliVersion

(CDKDeploy/Configuration/CdkCliVersion)

(オプション)

このプロパティは、[AWS CDK デプロイ] アクションのバージョン 1.0.13 以降、および [AWS CDK ブートストラップ] アクションのバージョン 1.0.8 以降で使用できます。

次のいずれかを指定します。

  • このアクションで使用する AWS Cloud Development Kit (AWS CDK) コマンドラインインターフェイス (CLI) のフルバージョン (AWS CDK ツールキットとも呼ばれます)。例えば、2.102.1 などです。アプリケーションのビルドとデプロイ時に一貫性と安定性を確保するため、フルバージョンを指定することを検討してください。

    または

  • latest。CDK CLI の最新の機能と修正を活用するには、latest を指定することを検討してください。

アクションは、指定されたバージョンの AWS CDK CLI (または最新バージョン) を CodeCatalyst ビルドイメージ にダウンロードし、このバージョンを使用して CDK アプリケーションをデプロイしたり、AWS 環境をブートストラップするために必要なコマンドを実行します。

使用できるサポートされている CDK CLI バージョンの一覧については、[AWS CDK バージョン] を参照してください。

このプロパティを省略すると、アクションは、次のいずれかのトピックで説明されているデフォルトの CLI AWS CDK バージョンを使用します。

対応する UI: [設定] タブ/ [AWS CDK CLI バージョン]

CdkRootPath

(CDKDeploy/Configuration/CdkRootPath)

(オプション)

AWS CDK プロジェクトの cdk.json ファイルを含むディレクトリへのパス。[AWS CDK デプロイ] アクションはこのフォルダから実行され、アクションによって作成された出力はこのディレクトリに追加されます。指定しない場合、[AWS CDK デプロイ] アクションは、cdk.json ファイルが AWS CDK プロジェクトのルートにあることを前提としています。

対応する UI: [設定] タブ/cdk.json が存在するディレクトリ

CfnOutputVariables

(CDKDeploy/Configuration/CfnOutputVariables)

(オプション)

ワークフロー出力変数として公開する AWS CDK アプリケーションコード内の CfnOutput コンストラクトを指定します。その後、ワークフロー内の後続のアクションでワークフロー出力変数を参照できます。CodeCatalyst における変数の詳細については、「ワークフローでの変数の使用」を参照してください。

例えば、AWS CDK アプリケーションコードが次のような場合です。

import { Duration, Stack, StackProps, CfnOutput, RemovalPolicy} from 'aws-cdk-lib';
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
import * as s3 from 'aws-cdk-lib/aws-s3';
import { Construct } from 'constructs';
import * as cdk from 'aws-cdk-lib';
export class HelloCdkStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);
    const bucket = new s3.Bucket(this, 'amzn-s3-demo-bucket', {
      removalPolicy: RemovalPolicy.DESTROY,
    });
    new CfnOutput(this, 'bucketName', {
      value: bucket.bucketName,
      description: 'The name of the s3 bucket',
      exportName: 'amzn-s3-demo-bucket',
    });
    const table = new dynamodb.Table(this, 'todos-table', {
      partitionKey: {name: 'todoId', type: dynamodb.AttributeType.NUMBER},
      billingMode: dynamodb.BillingMode.PAY_PER_REQUEST,
      removalPolicy: RemovalPolicy.DESTROY,
    })
    new CfnOutput(this, 'tableName', {
      value: table.tableName,
      description: 'The name of the dynamodb table',
      exportName: 'myDynamoDbTable',
    });
    ...
  }
}

...CfnOutputVariables プロパティは次のようになります。

Configuration:
  ...
  CfnOutputVariables: '["bucketName","tableName"]'

...その後、アクションは次のワークフロー出力変数を生成します。

キー 値

bucketName

bucket.bucketName

tableName

table.tableName

その後、後続のアクションで bucketName 変数と tableName 変数を参照できます。後続のアクションでワークフロー出力変数を参照する方法については、「事前定義済み変数の参照」を参照してください。

CfnOutputVariables プロパティに CfnOutput コンストラクトを指定しない場合、アクションはワークフロー出力変数として検出される最初の 4 つ (またはそれ以下) の CloudFormation 出力変数を公開します。詳細については、「「AWS CDK デプロイ」変数」を参照してください。

ヒント

アクションが生成するすべての CloudFormation 出力変数の一覧を取得するには、[AWS CDK デプロイ] アクションを含むワークフローを 1 回実行し、アクションの [ログ] タブを確認します。ログには、AWS CDK アプリケーションに関連付けられたすべての CloudFormation 出力変数の一覧が含まれます。すべての CloudFormation 変数が何であるかがわかったら、CfnOutputVariables プロパティを使用してワークフロー出力変数に変換する変数を指定できます。

AWS CloudFormation 出力変数の詳細については、AWS Cloud Development Kit (AWS CDK) API リファレンスの「class CfnOutput (construct)」にある CfnOutput コンストラクトのドキュメントを参照してください。

対応する UI: [設定] タブ/[AWS CloudFormation 出力変数]

CloudAssemblyRootPath

(CDKDeploy/Configuration/CloudAssemblyRootPath)

(オプション)

AWS CDK アプリケーションのスタックを (cdk synth オペレーションを使用して) クラウドアセンブリに既に合成している場合は、クラウドアセンブリディレクトリのルートパス (cdk.out) を指定します。指定されたクラウドアセンブリディレクトリにある AWS CloudFormation テンプレートは、cdk deploy --app コマンド AWS アカウント を使用して [AWS CDK デプロイアクション] によってデプロイされます。--app オプションが存在する場合、cdk synth オペレーションは実行されません。

クラウドアセンブリディレクトリを指定しない場合、[AWS CDK デプロイ] アクションは --app オプションなしで cdk deploy コマンドを実行します。--app オプションがない場合、cdk deploy オペレーションは (cdk synth) を合成し、AWS CDK アプリを AWS アカウント にデプロイします。

「AWS CDK デプロイ」アクションが実行時に合成を実行できるときに、既存の合成されたクラウドアセンブリを指定する理由

既存の合成されたクラウドアセンブリを指定して、次のことを行えます。

  • 「AWS CDK デプロイ」アクションを実行するたびに、まったく同じリソースセットがデプロイされていることを確認します。

    クラウドアセンブリを指定しない場合、[AWS CDK デプロイ] アクションは実行時期に応じて異なるファイルを合成してデプロイできます。例えば、[AWS CDK デプロイ] アクションは、テストステージ中に 1 つの依存関係のセット、および本番ステージ中に別の依存関係のセット (それらの依存関係がステージ間で変更された場合) を使用してクラウドアセンブリを合成する場合があります。テスト対象とデプロイ対象との正確なパリティを保証するには、一度合成してから、[Path to cloud assembly directory] フィールド (ビジュアルエディタ) または CloudAssemblyRootPath プロパティ (YAML エディタ) を使用して、既に合成済みのクラウドアセンブリを指定することをお勧めします。

  • AWS CDK アプリで非標準パッケージマネージャーとツールを使用する

    synth オペレーション中、[AWS CDK デプロイ] アクションは npm や pip などの標準ツールを使用してアプリを実行しようとします。アクションがこれらのツールを使用してアプリを正常に実行できない場合、合成は行われず、アクションは失敗します。この問題を回避するには、アプリの cdk.json ファイルで AWS CDK アプリを正常に実行するために必要な正確なコマンドを指定し、[AWS CDK デプロイ] アクションを含まないメソッドを使用してアプリを合成します。クラウドアセンブリが生成されたら、[AWS CDK デプロイ] アクションの [クラウドアセンブリディレクトリへのパス] フィールド (ビジュアルエディタ) または CloudAssemblyRootPath プロパティ (YAML エディタ) で指定できます。

AWS CDK アプリをインストールして実行するためのコマンドを含めるように cdk.json ファイルを設定する方法については、「アプリコマンドの指定」を参照してください。

cdk deploy および cdk synth コマンド、ならびに --app オプションの詳細については、「AWS Cloud Development Kit (AWS CDK) デベロッパーガイド」の「スタックのデプロイ」、「スタックの合成」、「合成のスキップ」を参照してください。

クラウドアセンブリの詳細については、「AWS Cloud Development Kit (AWS CDK) API リファレンス」の「クラウドアセンブリ」を参照してください。

対応する UI: [設定] タブ/クラウドアセンブリディレクトリへのパス

このページの内容

プライバシーサイト規約Cookie の設定
© 2025, Amazon Web Services, Inc. or its affiliates.All rights reserved.