Class: Aws::OpsWorks::Types::DeploymentCommand

Inherits:

Struct

Object
Struct
Aws::OpsWorks::Types::DeploymentCommand

show all

Includes:: Structure

Defined in:: lib/aws-sdk-opsworks/types.rb

Overview

Used to specify a stack or deployment command.

Constant Summary collapse

SENSITIVE =

[]

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:

‘: [“value1”, “value2”, …], “arg_name2” : [“value1”, “value2”, …], …`

The ‘update_dependencies` command takes two arguments:

‘upgrade_os_to` - Specifies the Amazon Linux version that you want instances to run, such as `Amazon Linux 2`. You must also set the `allow_reboot` argument to true.
‘allow_reboot` - Specifies whether to allow OpsWorks Stacks to reboot the instances if necessary, after installing the updates. This argument can be set to either `true` or `false`. The default value is `false`.

For example, to upgrade an instance to Amazon Linux 2018.03, set ‘Args` to the following.

‘ { “upgrade_os_to”:[“Amazon Linux 2018.03”], “allow_reboot”: } `

Returns:

(Hash<String,Array<String>>)

# File 'lib/aws-sdk-opsworks/types.rb', line 2176

class DeploymentCommand < Struct.new(
  :name,
  :args)
  SENSITIVE = []
  include Aws::Structure
end

#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 an `Args` parameter named `recipes` to the list of recipes to be executed. For example, to execute `phpapp::appsetup`, set `Args` to `href=""phpapp::appsetup"">recipes”:`.
‘install_dependencies`: Install the stack’s dependencies.
‘update_custom_cookbooks`: Update the stack’s custom cookbooks.
‘update_dependencies`: Update the stack’s dependencies.

<note markdown=“1”> The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing.

</note>

For apps, the following commands are available:

‘deploy`: Deploy an app. Ruby on Rails apps have an optional `Args` parameter named `migrate`. Set `Args` to {“migrate”:\} to migrate the database. The default setting is {“migrate”:\}.
‘rollback` Roll the app back to the previous version. When you update an app, 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.