interface RecipesProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.OpsWorks.CfnLayer.RecipesProperty |
Java | software.amazon.awscdk.services.opsworks.CfnLayer.RecipesProperty |
Python | aws_cdk.aws_opsworks.CfnLayer.RecipesProperty |
TypeScript | @aws-cdk/aws-opsworks » CfnLayer » RecipesProperty |
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.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as opsworks from '@aws-cdk/aws-opsworks';
const recipesProperty: opsworks.CfnLayer.RecipesProperty = {
configure: ['configure'],
deploy: ['deploy'],
setup: ['setup'],
shutdown: ['shutdown'],
undeploy: ['undeploy'],
};
Properties
Name | Type | Description |
---|---|---|
configure? | string[] | An array of custom recipe names to be run following a configure event. |
deploy? | string[] | An array of custom recipe names to be run following a deploy event. |
setup? | string[] | An array of custom recipe names to be run following a setup event. |
shutdown? | string[] | An array of custom recipe names to be run following a shutdown event. |
undeploy? | string[] | An array of custom recipe names to be run following a undeploy event. |
configure?
Type:
string[]
(optional)
An array of custom recipe names to be run following a configure
event.
deploy?
Type:
string[]
(optional)
An array of custom recipe names to be run following a deploy
event.
setup?
Type:
string[]
(optional)
An array of custom recipe names to be run following a setup
event.
shutdown?
Type:
string[]
(optional)
An array of custom recipe names to be run following a shutdown
event.
undeploy?
Type:
string[]
(optional)
An array of custom recipe names to be run following a undeploy
event.