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

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

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

このアクション定義は、より広範なワークフロー定義ファイル内のセクションとして存在します。ファイルの詳細については、「ワークフロー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。

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

DependsOn

(CDKDeploy/DependsOn)

(オプション)

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

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

「依存」機能の詳細については、「」を参照してくださいシーケンスアクション。

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

Compute

(CDKDeploy/Compute)

(オプション)

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

対応する UI: なし

Type

(CDKDeploy/Compute/Type)

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

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

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

対応する 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必要とするデータを定義します。

対応する UI: Inputs タブ

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/**/*"には、 を指定する必要があります。

対応する UI: タブ/アーティファクトの出力/ビルドによって生成されたアーティファクト/ファイルの追加

Environment

(CDKDeploy/Environment)

(必須)

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

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

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

Name

(CDKDeploy/Environment/Name)

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

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

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

Connections

(CDKDeploy/Environment/Connections)

（新しいバージョンの アクションではオプション。古いバージョンでは必須）

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

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

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

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

Name

(CDKDeploy/Environment/Connections/Name)

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

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

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

Role

(CDKDeploy/Environment/Connections/Role)

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

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

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

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

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

Configuration

(CDKDeploy/Configuration)

(必須)

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

対応する UI: 設定タブ

StackName

(CDKDeploy/Configuration/StackName)

(必須)

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

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 CDK CLI CodeCatalyst ビルドイメージ にダウンロードし、このバージョンを使用してCDKアプリケーションをデプロイしたり、環境をブートストラップしたり AWS するために必要なコマンドを実行します。

使用できるサポートされているCDKCLIバージョンのリストについては、AWS CDK 「バージョン」を参照してください。

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

対応する 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および tableName変数を参照できます。後続のアクションでワークフロー出力変数を参照する方法については、「」を参照してください事前定義された変数の参照。

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

AWS CloudFormation 出力変数の詳細については、「 AWS Cloud Development Kit (AWS CDK) APIリファレンスCfnOutput」の「 クラス 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 「deploy」アクションが実行時に合成できるときに、既存の合成されたクラウドアセンブリを指定するのはなぜですか？

合成された既存のクラウドアセンブリを次のように指定できます。

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

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

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

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