View a markdown version of this page

AWS::ImageBuilder::Image ImagePipelineExecutionSettings - 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::Image ImagePipelineExecutionSettings

Contains settings for creating an image by running an existing image pipeline.

Syntax

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

JSON

{
  "DeploymentId" : String,
  "OnUpdate" : Boolean
}

YAML

  DeploymentId: String
  OnUpdate: Boolean

Properties

DeploymentId

The deployment ID of the image pipeline that creates this image. The deployment ID changes each time the pipeline configuration changes. To set this value, use the Fn::GetAtt intrinsic function to retrieve the DeploymentId attribute of your AWS::ImageBuilder::ImagePipeline resource.

Required: No

Type: String

Update requires: Some interruptions

OnUpdate

Specifies whether the pipeline runs again when the referenced image pipeline is updated. If you set this to true, a change to the pipeline's deployment ID triggers a new pipeline execution and builds a new image. The default value is false.

Required: No

Type: Boolean

Update requires: Some interruptions