Class Recipes
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Recipes.Builder
builder()
An array of custom recipe names to be run following aconfigure
event.deploy()
An array of custom recipe names to be run following adeploy
event.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Configure property.final boolean
For responses, this returns true if the service returned a value for the Deploy property.final int
hashCode()
final boolean
hasSetup()
For responses, this returns true if the service returned a value for the Setup property.final boolean
For responses, this returns true if the service returned a value for the Shutdown property.final boolean
For responses, this returns true if the service returned a value for the Undeploy property.static Class
<? extends Recipes.Builder> setup()
An array of custom recipe names to be run following asetup
event.shutdown()
An array of custom recipe names to be run following ashutdown
event.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.undeploy()
An array of custom recipe names to be run following aundeploy
event.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Recipes.Builder,
Recipes> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-