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() For responses, this returns true if the service returned a value for the Configure property.
boolean	hasDeploy() For responses, this returns true if the service returned a value for the Deploy property.
int	hashCode()
boolean	hasSetup() For responses, this returns true if the service returned a value for the Setup property.
boolean	hasShutdown() For responses, this returns true if the service returned a value for the Shutdown property.
boolean	hasUndeploy() For responses, this returns true if the service returned a value for the Undeploy property.
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 final boolean hasSetup()

For responses, this returns true if the service returned a value for the Setup property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

setup

public final 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSetup() method.

Returns:

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

hasConfigure

public final boolean hasConfigure()

For responses, this returns true if the service returned a value for the Configure property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

configure

public final 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasConfigure() method.

Returns:

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

hasDeploy

public final boolean hasDeploy()

For responses, this returns true if the service returned a value for the Deploy property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

deploy

public final 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDeploy() method.

Returns:

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

hasUndeploy

public final boolean hasUndeploy()

For responses, this returns true if the service returned a value for the Undeploy property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

undeploy

public final 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUndeploy() method.

Returns:

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

hasShutdown

public final boolean hasShutdown()

For responses, this returns true if the service returned a value for the Shutdown property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

shutdown

public final 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasShutdown() method.

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 final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo