Package software.amazon.awscdk.services.opsworks

Interface CfnLayer.RecipesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLayer.RecipesProperty.Jsii$Proxy

Enclosing class:

CfnLayer

@Stability(Stable)
public static interface CfnLayer.RecipesProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.opsworks.*;
 RecipesProperty recipesProperty = RecipesProperty.builder()
         .configure(List.of("configure"))
         .deploy(List.of("deploy"))
         .setup(List.of("setup"))
         .shutdown(List.of("shutdown"))
         .undeploy(List.of("undeploy"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLayer.RecipesProperty.Builder	A builder for CfnLayer.RecipesProperty
static final class	CfnLayer.RecipesProperty.Jsii$Proxy	An implementation for CfnLayer.RecipesProperty

Method Summary

Modifier and Type	Method	Description
static CfnLayer.RecipesProperty.Builder	builder()
default List<String>	getConfigure()	An array of custom recipe names to be run following a configure event.
default List<String>	getDeploy()	An array of custom recipe names to be run following a deploy event.
default List<String>	getSetup()	An array of custom recipe names to be run following a setup event.
default List<String>	getShutdown()	An array of custom recipe names to be run following a shutdown event.
default List<String>	getUndeploy()	An array of custom recipe names to be run following a undeploy event.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConfigure

@Stability(Stable)
@Nullable
default List<String> getConfigure()

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

getDeploy

@Stability(Stable)
@Nullable
default List<String> getDeploy()

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

getSetup

@Stability(Stable)
@Nullable
default List<String> getSetup()

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

getShutdown

@Stability(Stable)
@Nullable
default List<String> getShutdown()

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

getUndeploy

@Stability(Stable)
@Nullable
default List<String> getUndeploy()

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

builder

@Stability(Stable)
static CfnLayer.RecipesProperty.Builder builder()

Returns:

a CfnLayer.RecipesProperty.Builder of CfnLayer.RecipesProperty