View a markdown version of this page

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

Contains deletion settings of underlying resources of an image when it is replaced or deleted, including its Amazon Machine Images (AMIs), snapshots, or containers.

Note

If you specify the Retain option in the DeletionPolicy or UpdateReplacePolicy, Image Builder does not delete the underlying resources.

Syntax

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

JSON

{
  "ExecutionRole" : String
}

YAML

  ExecutionRole: String

Properties

ExecutionRole

The name or Amazon Resource Name (ARN) of the IAM role that grants Image Builder permission to delete the image and its underlying resources. This property is required when you specify DeletionSettings.

Required: Yes

Type: String

Update requires: No interruption