AWS CloudFormation
User Guide (Version )

AWS::OpsWorks::Layer Recipes

AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy, undeploy, and shutdown. For each layer, AWS OpsWorks Stacks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

Syntax

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

JSON

{ "Configure" : [ String, ... ], "Deploy" : [ String, ... ], "Setup" : [ String, ... ], "Shutdown" : [ String, ... ], "Undeploy" : [ String, ... ] }

YAML

Configure: - String Deploy: - String Setup: - String Shutdown: - String Undeploy: - String

Properties

Configure

An array of custom recipe names to be run following a configure event.

Required: No

Type: List of String

Update requires: No interruption

Deploy

An array of custom recipe names to be run following a deploy event.

Required: No

Type: List of String

Update requires: No interruption

Setup

An array of custom recipe names to be run following a setup event.

Required: No

Type: List of String

Update requires: No interruption

Shutdown

An array of custom recipe names to be run following a shutdown event.

Required: No

Type: List of String

Update requires: No interruption

Undeploy

An array of custom recipe names to be run following a undeploy event.

Required: No

Type: List of String

Update requires: No interruption

On this page: