CDKBootstrapAction Identifier DependsOn Compute Type Fleet Timeout Inputs Sources Artifacts - input Outputs Artifacts - output Name Files Environment Name Connections Name Role Configuration Region CdkCliVersion

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@v1
    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@v1。

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

DependsOn

(CDKBootstrapAction/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 分で、最大値は「」で説明されていますワークフローのクォータ。デフォルトのタイムアウトは、最大タイムアウトと同じです。

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

Inputs

(CDKBootstrapAction/Inputs)

(オプション)

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

対応する UI: Inputs タブ

注記

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 アカウントおよび VPCs CodeCatalystへのデプロイ「」および「」を参照してください環境を作成する。

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

Name

(CDKBootstrapAction/Environment/Name)

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

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

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

Connections

(CDKBootstrapAction/Environment/Connections)

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

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

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

アクションは、 CodeCatalyst コンソールの環境で指定された AWS アカウント接続とデフォルトの IAM ロールを使用します。アカウント接続とデフォルトの IAM ロールを環境に追加する方法については、「」を参照してください環境を作成する。
デフォルトの IAM ロールには、アクションに必要なポリシーとアクセス許可が含まれている必要があります。これらのポリシーとアクセス許可を確認するには、アクションの YAML 定義ドキュメントの「ロール」プロパティの説明を参照してください。

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

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

（新しいバージョン) 設定タブ/環境/環境の内容 ?/3 つのドットメニュー/切り替えロール
（旧バージョン) 設定タブ/'環境/アカウント/ロール'/ AWS アカウント接続

Name

(CDKBootstrapAction/Environment/Connections/Name)

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

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

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

（新しいバージョン) 設定タブ/環境/マイ環境の内容 ?/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: アクションのバージョンに応じて、次のいずれかになります。

（新しいバージョン) 設定タブ/環境/マイ環境の内容 ?/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 「バージョン」を参照してください。

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

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

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

AWS CDK 「ブートストラップ」アクションによって生成される変数

Amazon S3 への発行