AWS SDK for C++  1.8.94
AWS SDK for C++
Public Member Functions | List of all members
Aws::OpsWorks::Model::DeploymentCommand Class Reference

#include <DeploymentCommand.h>

Public Member Functions

 DeploymentCommand ()
 
 DeploymentCommand (Aws::Utils::Json::JsonView jsonValue)
 
DeploymentCommandoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const DeploymentCommandNameGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const DeploymentCommandName &value)
 
void SetName (DeploymentCommandName &&value)
 
DeploymentCommandWithName (const DeploymentCommandName &value)
 
DeploymentCommandWithName (DeploymentCommandName &&value)
 
const Aws::Map< Aws::String, Aws::Vector< Aws::String > > & GetArgs () const
 
bool ArgsHasBeenSet () const
 
void SetArgs (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
 
void SetArgs (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
 
DeploymentCommandWithArgs (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
 
DeploymentCommandWithArgs (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
 
DeploymentCommandAddArgs (const Aws::String &key, const Aws::Vector< Aws::String > &value)
 
DeploymentCommandAddArgs (Aws::String &&key, const Aws::Vector< Aws::String > &value)
 
DeploymentCommandAddArgs (const Aws::String &key, Aws::Vector< Aws::String > &&value)
 
DeploymentCommandAddArgs (Aws::String &&key, Aws::Vector< Aws::String > &&value)
 
DeploymentCommandAddArgs (const char *key, Aws::Vector< Aws::String > &&value)
 
DeploymentCommandAddArgs (const char *key, const Aws::Vector< Aws::String > &value)
 

Detailed Description

Used to specify a stack or deployment command.

See Also:

AWS API Reference

Definition at line 34 of file DeploymentCommand.h.

Constructor & Destructor Documentation

◆ DeploymentCommand() [1/2]

Aws::OpsWorks::Model::DeploymentCommand::DeploymentCommand ( )

◆ DeploymentCommand() [2/2]

Aws::OpsWorks::Model::DeploymentCommand::DeploymentCommand ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddArgs() [1/6]

DeploymentCommand& Aws::OpsWorks::Model::DeploymentCommand::AddArgs ( const Aws::String key,
const Aws::Vector< Aws::String > &  value 
)
inline

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

Definition at line 342 of file DeploymentCommand.h.

◆ AddArgs() [2/6]

DeploymentCommand& Aws::OpsWorks::Model::DeploymentCommand::AddArgs ( Aws::String &&  key,
const Aws::Vector< Aws::String > &  value 
)
inline

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

Definition at line 360 of file DeploymentCommand.h.

◆ AddArgs() [3/6]

DeploymentCommand& Aws::OpsWorks::Model::DeploymentCommand::AddArgs ( const Aws::String key,
Aws::Vector< Aws::String > &&  value 
)
inline

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

Definition at line 378 of file DeploymentCommand.h.

◆ AddArgs() [4/6]

DeploymentCommand& Aws::OpsWorks::Model::DeploymentCommand::AddArgs ( Aws::String &&  key,
Aws::Vector< Aws::String > &&  value 
)
inline

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

Definition at line 396 of file DeploymentCommand.h.

◆ AddArgs() [5/6]

DeploymentCommand& Aws::OpsWorks::Model::DeploymentCommand::AddArgs ( const char *  key,
Aws::Vector< Aws::String > &&  value 
)
inline

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

Definition at line 414 of file DeploymentCommand.h.

◆ AddArgs() [6/6]

DeploymentCommand& Aws::OpsWorks::Model::DeploymentCommand::AddArgs ( const char *  key,
const Aws::Vector< Aws::String > &  value 
)
inline

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

Definition at line 432 of file DeploymentCommand.h.

◆ ArgsHasBeenSet()

bool Aws::OpsWorks::Model::DeploymentCommand::ArgsHasBeenSet ( ) const
inline

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

Definition at line 252 of file DeploymentCommand.h.

◆ GetArgs()

const Aws::Map<Aws::String, Aws::Vector<Aws::String> >& Aws::OpsWorks::Model::DeploymentCommand::GetArgs ( ) const
inline

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

Definition at line 234 of file DeploymentCommand.h.

◆ GetName()

const DeploymentCommandName& Aws::OpsWorks::Model::DeploymentCommand::GetName ( ) const
inline

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.

Definition at line 70 of file DeploymentCommand.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::OpsWorks::Model::DeploymentCommand::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::OpsWorks::Model::DeploymentCommand::NameHasBeenSet ( ) const
inline

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.

Definition at line 99 of file DeploymentCommand.h.

◆ operator=()

DeploymentCommand& Aws::OpsWorks::Model::DeploymentCommand::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetArgs() [1/2]

void Aws::OpsWorks::Model::DeploymentCommand::SetArgs ( const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &  value)
inline

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

Definition at line 270 of file DeploymentCommand.h.

◆ SetArgs() [2/2]

void Aws::OpsWorks::Model::DeploymentCommand::SetArgs ( Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&  value)
inline

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

Definition at line 288 of file DeploymentCommand.h.

◆ SetName() [1/2]

void Aws::OpsWorks::Model::DeploymentCommand::SetName ( const DeploymentCommandName value)
inline

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.

Definition at line 128 of file DeploymentCommand.h.

◆ SetName() [2/2]

void Aws::OpsWorks::Model::DeploymentCommand::SetName ( DeploymentCommandName &&  value)
inline

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.

Definition at line 157 of file DeploymentCommand.h.

◆ WithArgs() [1/2]

DeploymentCommand& Aws::OpsWorks::Model::DeploymentCommand::WithArgs ( const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &  value)
inline

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

Definition at line 306 of file DeploymentCommand.h.

◆ WithArgs() [2/2]

DeploymentCommand& Aws::OpsWorks::Model::DeploymentCommand::WithArgs ( Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&  value)
inline

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

Definition at line 324 of file DeploymentCommand.h.

◆ WithName() [1/2]

DeploymentCommand& Aws::OpsWorks::Model::DeploymentCommand::WithName ( const DeploymentCommandName value)
inline

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.

Definition at line 186 of file DeploymentCommand.h.

◆ WithName() [2/2]

DeploymentCommand& Aws::OpsWorks::Model::DeploymentCommand::WithName ( DeploymentCommandName &&  value)
inline

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.

Definition at line 215 of file DeploymentCommand.h.


The documentation for this class was generated from the following file: