software.amazon.awssdk.services.opsworks.model

Class Recipes

java.lang.Object

software.amazon.awssdk.services.opsworks.model.Recipes

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Recipes.Builder,Recipes>

@Generated(value="software.amazon.awssdk:codegen")
public final class Recipes
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Recipes.Builder,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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Recipes.Builder

Method Summary

Modifier and Type	Method and Description
static Recipes.Builder	builder()
List<String>	configure() An array of custom recipe names to be run following a configure event.
List<String>	deploy() An array of custom recipe names to be run following a deploy event.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasConfigure() Returns true if the Configure property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasDeploy() Returns true if the Deploy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasSetup() Returns true if the Setup property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasShutdown() Returns true if the Shutdown property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasUndeploy() Returns true if the Undeploy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<SdkField<?>>	sdkFields()
static Class<? extends Recipes.Builder>	serializableBuilderClass()
List<String>	setup() An array of custom recipe names to be run following a setup event.
List<String>	shutdown() An array of custom recipe names to be run following a shutdown event.
Recipes.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	undeploy() An array of custom recipe names to be run following a undeploy event.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasSetup

public boolean hasSetup()

Returns true if the Setup property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

setup

public List<String> setup()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSetup() to see if a value was sent in this field.

Returns:

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

hasConfigure

public boolean hasConfigure()

Returns true if the Configure property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

configure

public List<String> configure()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasConfigure() to see if a value was sent in this field.

Returns:

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

hasDeploy

public boolean hasDeploy()

Returns true if the Deploy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

deploy

public List<String> deploy()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasDeploy() to see if a value was sent in this field.

Returns:

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

hasUndeploy

public boolean hasUndeploy()

Returns true if the Undeploy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

undeploy

public List<String> undeploy()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasUndeploy() to see if a value was sent in this field.

Returns:

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

hasShutdown

public boolean hasShutdown()

Returns true if the Shutdown property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

shutdown

public List<String> shutdown()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasShutdown() to see if a value was sent in this field.

Returns:

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

toBuilder

public Recipes.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Recipes.Builder,Recipes>

builder

public static Recipes.Builder builder()

serializableBuilderClass

public static Class<? extends Recipes.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo