Manage an Image Builder image pipeline using the console - EC2 Image Builder

Manage an Image Builder image pipeline using the console

This section contains information to help you manage and run images with EC2 Image Builder using the Image Builder console.

Edit Configuration Details and Additional Settings

After you have created an image pipeline, you can edit its configuration details and additional settings. To edit the configuration details and additional settings, use the following steps.

To update an image pipeline with a new image recipe, you must use the AWS CLI. See Update an image pipeline for more information.

  1. To edit configuration details, including description, build schedule, or infrastructure details, navigate to the Image pipelines page and select the check box next to the name of the pipeline that you want to edit. Then select the View details button.

  2. On the Image pipeline details page, note the Summary details of the image pipeline, and the Output image, Configuration, and Image recipe tabs.

  3. Under the Configuration tab, select Edit next to Configuration details.

  4. On the Edit configuration details page, you can edit your configuration. Then select Save changes.

  5. To edit additional settings, including associated licenses, AMI distribution settings, image export settings, and SNS notification settings, navigate to the Image pipelines page and select the check box next to the name of the pipeline that you want to edit. Select View details.

    Note

    License Manager settings will not replicate across AWS Regions that must be enabled in your account, for example, between the ap-east-1 (Hong Kong) and the me-south-1 (Bahrain) Regions.

  6. On the Image pipeline detail page, under the Configuration tab, select Edit next to Additional settings.

  7. On the Edit additional settings page, you can edit your configuration. Then select Save changes.

After an image recipe has been created, its components cannot be modified or replaced. If you want to update the components in an image recipe, create a new recipe or recipe version.

Delete Pipeline

To delete an image pipeline, use the following steps.

  1. Navigate to the Image pipelines page and select the check box next to the name of the pipeline that you want to delete.

  2. From the Actions dropdown, select Delete.

  3. You will be prompted to confirm deletion of the pipeline by entering Delete in the text box and selecting Delete.

When you delete your pipeline, its associated resources are disassociated and the configuration is deleted.

Note

To successfully delete resources in Image Builder, you must delete them in the following order.

  1. Image pipeline

  2. Infrastructure configuration/Distribution configuration/Image recipe

  3. Component

  4. Image

Create New Component

You can create components to add to your image recipes. Components include build components and test components. Build components are orchestration documents that define a sequence of steps for downloading, installing, and configuring software packages. They also define validation and security hardening steps. Test components are orchestration documents that define tests to run on software packages. A component is defined using a YAML document format. After an image recipe has been created, its components cannot be modified or replaced. To update components after an image recipe has been created you must create a new recipe or recipe version. To create a new component, use the following steps.

  1. Select Components in the left navigation pane. Then select Create component.

  2. On the Create component page, under Component details, enter the following:

    • Image Operating system (OS). Specify the OS with which the component is compatible.

    • Component category. From the dropdown, select the type of build or test component you are creating.

    • Component name. Enter a name for the component.

    • Component version. Enter the version number of the component.

    • Description. Provide an optional description to help you identify the component.

    • Change description. Provide an optional description to help you understand the changes made to this version of the component.

  3. Under Definition document, which is the document that defines the actions that Image Builder performs on your image, enter the document content in YAML format in the provided field. You can optionally use the AWS-provided example (auto-filled when you select Use example) and edit the content inline.

  4. After you have entered the component details, select Create component. When you create a recipe or create a pipeline, the component will be available in the Component dropdown.

  5. To delete a component, from the Components page, select the check box next to the component that you want to delete. From the Actions dropdown, select Delete component.

You can create a new component version by selecting the check box next to the component and, under the Actions dropdown, select Create new version. This will take you to the Create Component page, where you can create a new component version.

Working with Image Recipes

After you have created an image recipe, you can manage it from the Recipes page in the EC2 Image Builder console. You can either delete an image recipe or create a new version of a recipe.

Delete an Image Recipe

To delete an image recipe, select the check box next to the image recipe and, under the Actions dropdown, select Delete recipe. When you delete an image recipe, images and components associated with the image recipe are disassociated, and the configuration is deleted. A dialog box prompts you to confirm the deletion by entering delete.

Note

To successfully delete resources in Image Builder, you must delete them in the following order.

  1. Image pipeline

  2. Infrastructure configuration/Distribution configuration/Image recipe

  3. Component

  4. Image

Create a New Image Recipe Version

To create a new image recipe version, select the check box next to the image recipe and, under the Actions dropdown, select Create new version. This takes you to the Create Recipe page, where you can create a new image recipe version. For instructions for creating an image recipe, see the steps under Build and automate an operating system image deployment using the EC2 Image Builder console.