You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::OpsWorks::Types::DeploymentCommand
- Inherits:
-
Struct
- Object
- Struct
- Aws::OpsWorks::Types::DeploymentCommand
- Defined in:
- (unknown)
Overview
When passing DeploymentCommand as input to an Aws::Client method, you can use a vanilla Hash:
{
name: "install_dependencies", # required, accepts install_dependencies, update_dependencies, update_custom_cookbooks, execute_recipes, configure, setup, deploy, rollback, start, stop, restart, undeploy
args: {
"String" => ["String"],
},
}
Used to specify a stack or deployment command.
Returned by:
Instance Attribute Summary collapse
-
#args ⇒ Hash<String,Array<String>>
The arguments of those commands that take arguments.
-
#name ⇒ String
Specifies the operation.
Instance Attribute Details
#args ⇒ Hash<String,Array<String>>
The arguments of those commands that take arguments. It should be set to a JSON object with the following format:
{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1",
"value2", ...], ...}
The update_dependencies
command takes two arguments:
upgrade_os_to
- Specifies the desired Amazon Linux version for instances whose OS you want to upgrade, such asAmazon Linux 2016.09
. You must also set theallow_reboot
argument to true.allow_reboot
- Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if necessary, after installing the updates. This argument can be set to eithertrue
orfalse
. The default value isfalse
.
For example, to upgrade an instance to Amazon Linux 2016.09, set Args
to the following.
{ "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] }
#name ⇒ String
Specifies the operation. You can specify only one command.
For stacks, the following commands are available:
execute_recipes
: Execute one or more recipes. To specify the recipes, set anArgs
parameter namedrecipes
to the list of recipes to be executed. For example, to executephpapp::appsetup
, setArgs
to`{"recipes":["phpapp::appsetup"]}`
.install_dependencies
: Install the stack\'s dependencies.update_custom_cookbooks
: Update the stack\'s custom cookbooks.update_dependencies
: Update the stack\'s dependencies.
For apps, the following commands are available:
deploy
: Deploy an app. Ruby on Rails apps have an optionalArgs
parameter namedmigrate
. SetArgs
to `\"migrate\":[\"true\"]` to migrate the database. The default setting is `\"migrate\":[\"false\"]`.rollback
Roll the app back to the previous version. When you update an app, AWS OpsWorks Stacks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions.start
: Start the app\'s web or application server.stop
: Stop the app\'s web or application server.restart
: Restart the app\'s web or application server.undeploy
: Undeploy the app.Possible values:
- install_dependencies
- update_dependencies
- update_custom_cookbooks
- execute_recipes
- configure
- setup
- deploy
- rollback
- start
- stop
- restart
- undeploy