「AWS CDK ブートストラップ」アクション YAML - Amazon CodeCatalyst
CDKBootstrapActionIdentifierDependsOnComputeTypeFleetTimeoutInputsSourcesArtifacts - inputOutputsArtifacts - outputNameFilesEnvironmentNameConnectionsNameRoleConfigurationRegionCdkCliVersion

「AWS CDK ブートストラップ」アクション YAML

以下は、[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.    
  CDKBootstrapAction_nn: 
    Identifier: aws/cdk-bootstrap@v2
    DependsOn:
      - action-name
    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_bootstrap_artifacts
          Files: 
            - "cdk.out/**/*"
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Configuration:
      Region: us-west-2
      CdkCliVersion: version

CDKBootstrapAction

(必須)

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

デフォルト: CDKBootstrapAction_nn。

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

Identifier

(CDKBootstrapAction/Identifier)

(必須)

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

注記

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

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

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

DependsOn

(CDKBootstrapAction/DependsOn)

(オプション)

このアクションを実行するために正常に実行する必要があるアクション、アクショングループ、またはゲートを指定します。

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

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

Compute

(CDKBootstrapAction/Compute)

(オプション)

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

対応する UI: なし

Type

(CDKBootstrapAction/Compute/Type)

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

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

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

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

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

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

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

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

Fleet

(CDKBootstrapAction/Compute/Fleet)

(オプション)

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

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

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

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

Timeout

(CDKBootstrapAction/Timeout)

(必須)

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

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

Inputs

(CDKBootstrapAction/Inputs)

(オプション)

Inputs セクションでは、ワークフローの実行中に [AWS CDK ブートストラップ] アクションに必要なデータを定義します。

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

注記

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

Sources

(CDKBootstrapAction/Inputs/Sources)

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

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

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

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

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

Artifacts - input

(CDKBootstrapAction/Inputs/Artifacts)

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

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

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

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

Outputs

(CDKBootstrapAction/Outputs)

(オプション)

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

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

Artifacts - output

(CDKBootstrapAction/Outputs/Artifacts)

(オプション)

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

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

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

Name

(CDKBootstrapAction/Outputs/Artifacts/Name)

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

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

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

Files

(CDKBootstrapAction/Outputs/Artifacts/Files)

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

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

注記

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

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

Environment

(CDKBootstrapAction/Environment)

(必須)

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

注記

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

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

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

Name

(CDKBootstrapAction/Environment/Name)

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

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

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

Connections

(CDKBootstrapAction/Environment/Connections)

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

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

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

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

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

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

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

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

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

Name

(CDKBootstrapAction/Environment/Connections/Name)

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

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

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

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

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

Role

(CDKBootstrapAction/Environment/Connections/Role)

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

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

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

注記

次のアクセス許可ポリシーに示すアクセス許可は、書き込み時にブートストラップを実行するために cdk bootstrap コマンドで必要なアクセス許可です。AWS CDK がブートストラップコマンドを変更すると、これらのアクセス許可も変更される可能性があります。

警告

このロールは、[AWS CDK ブートストラップ] アクションでのみ使用します。これはかなりの程度許容されており、他のアクションで使用するとセキュリティリスクが発生する可能性があります。

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

    {
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "iam:GetRole",
                "ssm:GetParameterHistory",
                "ecr:PutImageScanningConfiguration",
                "cloudformation:*",
                "iam:CreateRole",
                "iam:AttachRolePolicy",
                "ssm:GetParameters",
                "iam:PutRolePolicy",
                "ssm:GetParameter",
                "ssm:DeleteParameters",
                "ecr:DeleteRepository",
                "ssm:PutParameter",
                "ssm:DeleteParameter",
                "iam:PassRole",
                "ecr:SetRepositoryPolicy",
                "ssm:GetParametersByPath",
                "ecr:DescribeRepositories",
                "ecr:GetLifecyclePolicy"
            ],
            "Resource": [
                "arn:aws:ssm:aws-region:aws-account:parameter/cdk-bootstrap/*",
                "arn:aws:cloudformation:aws-region:aws-account:stack/CDKToolkit/*",
                "arn:aws:ecr:aws-region:aws-account:repository/cdk-*",
                "arn:aws:iam::aws-account:role/cdk-*"
            ]
        },
        {
            "Sid": "VisualEditor1",
            "Effect": "Allow",
            "Action": [
                "cloudformation:RegisterType",
                "cloudformation:CreateUploadBucket",
                "cloudformation:ListExports",
                "cloudformation:DescribeStackDriftDetectionStatus",
                "cloudformation:SetTypeDefaultVersion",
                "cloudformation:RegisterPublisher",
                "cloudformation:ActivateType",
                "cloudformation:ListTypes",
                "cloudformation:DeactivateType",
                "cloudformation:SetTypeConfiguration",
                "cloudformation:DeregisterType",
                "cloudformation:ListTypeRegistrations",
                "cloudformation:EstimateTemplateCost",
                "cloudformation:DescribeAccountLimits",
                "cloudformation:BatchDescribeTypeConfigurations",
                "cloudformation:CreateStackSet",
                "cloudformation:ListStacks",
                "cloudformation:DescribeType",
                "cloudformation:ListImports",
                "s3:*",
                "cloudformation:PublishType",
                "ecr:CreateRepository",
                "cloudformation:DescribePublisher",
                "cloudformation:DescribeTypeRegistration",
                "cloudformation:TestType",
                "cloudformation:ValidateTemplate",
                "cloudformation:ListTypeVersions"
            ],
            "Resource": "*"
        }
    ]
}
    注記

    ロールを初めて使用するとき、リソースポリシーステートメントで次のワイルドカードを使用し、使用可能になった後にリソース名でポリシーをスコープダウンします。

    "Resource": "*"

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

    {
    "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

(CDKBootstrapAction/Configuration)

(必須)

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

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

Region

(CDKBootstrapAction/Configuration/Region)

(必須)

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

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

CdkCliVersion

(CDKBootstrapAction/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 バージョン]