Amazonka.OpsWorks.Types.DeploymentCommand

Documentation

data DeploymentCommand

Used to specify a stack or deployment command.

See: newDeploymentCommand smart constructor.

Constructors

DeploymentCommand'

Fields

• args :: Maybe (HashMap Text [Text])

  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 as Amazon Linux 2016.09. You must also set the allow_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 either true or false. The default value is false.

  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 :: DeploymentCommandName

  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 {"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.

  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.

  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":["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.

Instances

FromJSON DeploymentCommand

Defined in Amazonka.OpsWorks.Types.DeploymentCommand

Methods

parseJSON :: Value -> Parser DeploymentCommand

parseJSONList :: Value -> Parser [DeploymentCommand]

ToJSON DeploymentCommand

Defined in Amazonka.OpsWorks.Types.DeploymentCommand

Methods

toJSON :: DeploymentCommand -> Value

toEncoding :: DeploymentCommand -> Encoding

toJSONList :: [DeploymentCommand] -> Value

toEncodingList :: [DeploymentCommand] -> Encoding

Generic DeploymentCommand

Defined in Amazonka.OpsWorks.Types.DeploymentCommand

Associated Types

type Rep DeploymentCommand :: Type -> Type

Methods

from :: DeploymentCommand -> Rep DeploymentCommand x

to :: Rep DeploymentCommand x -> DeploymentCommand

Read DeploymentCommand

Defined in Amazonka.OpsWorks.Types.DeploymentCommand

Methods

readsPrec :: Int -> ReadS DeploymentCommand

readList :: ReadS [DeploymentCommand]

readPrec :: ReadPrec DeploymentCommand

readListPrec :: ReadPrec [DeploymentCommand]

Show DeploymentCommand

Defined in Amazonka.OpsWorks.Types.DeploymentCommand

Methods

showsPrec :: Int -> DeploymentCommand -> ShowS

show :: DeploymentCommand -> String

showList :: [DeploymentCommand] -> ShowS

NFData DeploymentCommand

Defined in Amazonka.OpsWorks.Types.DeploymentCommand

Methods

rnf :: DeploymentCommand -> ()

Eq DeploymentCommand

Defined in Amazonka.OpsWorks.Types.DeploymentCommand

Methods

(==) :: DeploymentCommand -> DeploymentCommand -> Bool

(/=) :: DeploymentCommand -> DeploymentCommand -> Bool

Hashable DeploymentCommand

Defined in Amazonka.OpsWorks.Types.DeploymentCommand

Methods

hashWithSalt :: Int -> DeploymentCommand -> Int

hash :: DeploymentCommand -> Int

type Rep DeploymentCommand

Defined in Amazonka.OpsWorks.Types.DeploymentCommand

type Rep DeploymentCommand = D1 ('MetaData "DeploymentCommand" "Amazonka.OpsWorks.Types.DeploymentCommand" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "DeploymentCommand'" 'PrefixI 'True) (S1 ('MetaSel ('Just "args") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeploymentCommandName)))

newDeploymentCommand

Arguments

:: DeploymentCommandName

$sel:name:DeploymentCommand'

-> DeploymentCommand

Create a value of DeploymentCommand with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:args:DeploymentCommand', deploymentCommand_args - 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 as Amazon Linux 2016.09. You must also set the allow_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 either true or false. The default value is false.

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"] }

$sel:name:DeploymentCommand', deploymentCommand_name - 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 {"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.

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.

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":["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.

deploymentCommand_args :: Lens' DeploymentCommand (Maybe (HashMap Text [Text]))

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 as Amazon Linux 2016.09. You must also set the allow_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 either true or false. The default value is false.

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"] }

deploymentCommand_name :: Lens' DeploymentCommand DeploymentCommandName

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 {"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.

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.

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":["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.