You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::OpsWorks::Types::Recipes

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb

Overview

Note:

When making an API call, you may pass Recipes data as a hash:

{
  setup: ["String"],
  configure: ["String"],
  deploy: ["String"],
  undeploy: ["String"],
  shutdown: ["String"],
}

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.

Instance Attribute Summary collapse

Instance Attribute Details

#configureArray<String>

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

Returns:

  • (Array<String>)


4821
4822
4823
4824
4825
4826
4827
4828
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 4821

class Recipes < Struct.new(
  :setup,
  :configure,
  :deploy,
  :undeploy,
  :shutdown)
  include Aws::Structure
end

#deployArray<String>

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

Returns:

  • (Array<String>)


4821
4822
4823
4824
4825
4826
4827
4828
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 4821

class Recipes < Struct.new(
  :setup,
  :configure,
  :deploy,
  :undeploy,
  :shutdown)
  include Aws::Structure
end

#setupArray<String>

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

Returns:

  • (Array<String>)


4821
4822
4823
4824
4825
4826
4827
4828
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 4821

class Recipes < Struct.new(
  :setup,
  :configure,
  :deploy,
  :undeploy,
  :shutdown)
  include Aws::Structure
end

#shutdownArray<String>

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

Returns:

  • (Array<String>)


4821
4822
4823
4824
4825
4826
4827
4828
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 4821

class Recipes < Struct.new(
  :setup,
  :configure,
  :deploy,
  :undeploy,
  :shutdown)
  include Aws::Structure
end

#undeployArray<String>

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

Returns:

  • (Array<String>)


4821
4822
4823
4824
4825
4826
4827
4828
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 4821

class Recipes < Struct.new(
  :setup,
  :configure,
  :deploy,
  :undeploy,
  :shutdown)
  include Aws::Structure
end