Adding the "AWS CDK bootstrap" action

This section describes how to add the AWS CDK bootstrap action to your workflow. The AWS CDK bootstrap action provisions a bootstrap stack in your AWS environment using the modern template. If a bootstrap stack already exists, the action updates it if necessary. Having a bootstrap stack present in AWS is a prerequisite for deploying an AWS CDK app.

For more information about bootstrapping, see Bootstrapping in the AWS Cloud Development Kit (AWS CDK) Developer Guide.

When to use this action

Use this action if you have a workflow that deploys an AWS CDK app, and you want to deploy (and update, if needed) the bootstrap stack at the same time. In this case, you would add the AWS CDK bootstrap action to the same workflow as the one that deploys your AWS CDK app.

Do not use this action if either of the following applies:

• You already deployed a bootstrap stack using another mechanism, and you want to keep it intact (no updates).

• You want to use a custom bootstrap template, which is not supported with the AWS CDK bootstrap action.

Prerequisites

Before you can use the AWS CDK bootstrap action, make sure you have an AWS CDK app ready. The bootstrap action will synthesize the AWS CDK app before bootstrapping. You can write your app in any programming language supported by the AWS CDK.

Make sure your AWS CDK app files are available in:

• A CodeCatalyst source repository, or

• A CodeCatalyst output artifact generated by another workflow action

Example workflow

Refer to the Example workflow in the Adding the "AWS CDK deploy" action for a workflow that includes the AWS CDK bootstrap action.

Adding the "AWS CDK bootstrap" action

Use the following instructions to add the AWS CDK bootstrap action to your workflow.

Prerequisites

Before you begin, make sure you have completed the tasks described in Prerequisites.

Visual

To add the "AWS CDK bootstrap" action using the visual editor

1. Open the CodeCatalyst console at https://codecatalyst.aws/.

2. Choose your project.

3. In the navigation pane, choose CI/CD, and then choose Workflows.

4. Choose the name of your workflow. You can filter by the source repository or branch name where the workflow is defined, or filter by workflow name.

5. Choose Edit.

6. Choose Visual.

7. At the top-left, choose + Actions to open the action catalog.

8. From the drop-down list, choose Amazon CodeCatalyst.

9. Search for the AWS CDK bootstrap action, and do one of the following:

   • Choose the plus sign (+) to add the action to the workflow diagram and open its configuration pane.

     Or

   • Choose AWS CDK bootstrap. The action details dialog box appears. On this dialog box:

     • (Optional) Choose View source to view the action's source code.

     • Choose Add to workflow to add the action to the workflow diagram and open its configuration pane.

10. In the Inputs, Configuration, and Outputs tabs, complete the fields according to your needs. For a description of each field, see the "AWS CDK bootstrap" action reference. This reference provides detailed information about each field (and corresponding YAML property value) as it appears in both the YAML and visual editors.

11. (Optional) Choose Validate to validate the workflow's YAML code before committing.

12. Choose Commit, enter a commit message, and then choose Commit again.

    Note

    If your AWS CDK bootstrap action fails with an npm install error, see How do I fix "npm install" errors? for information about how to fix the error.

YAML

To add the "AWS CDK bootstrap" action using the YAML editor

1. Open the CodeCatalyst console at https://codecatalyst.aws/.

2. Choose your project.

3. In the navigation pane, choose CI/CD, and then choose Workflows.

4. Choose the name of your workflow. You can filter by the source repository or branch name where the workflow is defined, or filter by workflow name.

5. Choose Edit.

6. Choose YAML.

7. At the top-left, choose + Actions to open the action catalog.

8. From the drop-down list, choose Amazon CodeCatalyst.

9. Search for the AWS CDK bootstrap action, and choose + to add it to the workflow diagram and open its configuration pane.

10. Modify the properties in the YAML code according to your needs. An explanation of each available property is provided in the "AWS CDK bootstrap" action reference.

11. (Optional) Choose Validate to validate the workflow's YAML code before committing.

12. Choose Commit, enter a commit message, and then choose Commit again.

    Note

    If your AWS CDK bootstrap action fails with an npm install error, see How do I fix "npm install" errors? for information about how to fix the error.

Variables produced by the "AWS CDK bootstrap" action

When the AWS CDK bootstrap action runs, it produces variables that you can use in subsequent workflow actions. For details, see "AWS CDK bootstrap" action output variables in the Workflow output variable reference.

"AWS CDK bootstrap" action definition

The AWS CDK bootstrap action is defined as a set of YAML properties inside your workflow definition file. For information about these properties, see "AWS CDK bootstrap" action reference in the Workflow definition reference.