View a markdown version of this page

AWS::ImageBuilder::ImageRecipe SystemsManagerAgent - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::ImageBuilder::ImageRecipe SystemsManagerAgent

Contains settings for the Systems Manager agent on your build instance. This setting applies to Linux and macOS build instances only. Requests that set it for a recipe with a Windows base image are rejected.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "UninstallAfterBuild" : Boolean
}

YAML

  UninstallAfterBuild: Boolean

Properties

UninstallAfterBuild

Specifies whether the Systems Manager agent is removed from your final build image before Image Builder creates the new AMI. If true, the agent is removed. If false, the agent is kept, so that it's included in the AMI. If you don't set this property, Image Builder removes the agent only if Image Builder installed the agent during the build. An agent that was pre-installed on the base image is kept.

Required: No

Type: Boolean

Update requires: Replacement