com.amazonaws.services.opsworks.model

Class DeploymentCommand

java.lang.Object

com.amazonaws.services.opsworks.model.DeploymentCommand

All Implemented Interfaces:

Serializable

public class DeploymentCommand
extends Object
implements Serializable

Used to specify a deployment operation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeploymentCommand()

Method Summary

Methods

Modifier and Type	Method and Description
DeploymentCommand	addArgsEntry(String key, List<String> value) An array of command arguments.
DeploymentCommand	clearArgsEntries() Removes all the entries added into Args.
boolean	equals(Object obj)
Map<String,List<String>>	getArgs() An array of command arguments.
String	getName() Specifies the deployment operation.
int	hashCode()
void	setArgs(Map<String,List<String>> args) An array of command arguments.
void	setName(DeploymentCommandName name) Specifies the deployment operation.
void	setName(String name) Specifies the deployment operation.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DeploymentCommand	withArgs(Map<String,List<String>> args) An array of command arguments.
DeploymentCommand	withName(DeploymentCommandName name) Specifies the deployment operation.
DeploymentCommand	withName(String name) Specifies the deployment operation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeploymentCommand

public DeploymentCommand()

Method Detail

getName

public String getName()

Specifies the deployment operation. You can specify only one command.

For stacks, the available commands are:

• execute_recipes: Execute the recipes that are specified by the Args parameter.
• install_dependencies: Installs the stack's dependencies.
• update_custom_cookbooks: Update the stack's custom cookbooks.
• update_dependencies: Update the stack's dependencies.

For apps, the available commands are:

• deploy: Deploy the app.
• rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks 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.

Constraints:
Allowed Values: install_dependencies, update_dependencies, update_custom_cookbooks, execute_recipes, deploy, rollback, start, stop, restart, undeploy

Returns:

Specifies the deployment operation. You can specify only one command.

For stacks, the available commands are:

• execute_recipes: Execute the recipes that are specified by the Args parameter.
• install_dependencies: Installs the stack's dependencies.
• update_custom_cookbooks: Update the stack's custom cookbooks.
• update_dependencies: Update the stack's dependencies.

For apps, the available commands are:

• deploy: Deploy the app.
• rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks 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.

See Also:

DeploymentCommandName

setName

public void setName(String name)

Specifies the deployment operation. You can specify only one command.

For stacks, the available commands are:

• execute_recipes: Execute the recipes that are specified by the Args parameter.
• install_dependencies: Installs the stack's dependencies.
• update_custom_cookbooks: Update the stack's custom cookbooks.
• update_dependencies: Update the stack's dependencies.

For apps, the available commands are:

• deploy: Deploy the app.
• rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks 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.

Constraints:
Allowed Values: install_dependencies, update_dependencies, update_custom_cookbooks, execute_recipes, deploy, rollback, start, stop, restart, undeploy

Parameters:

name - Specifies the deployment operation. You can specify only one command.

For stacks, the available commands are:

• execute_recipes: Execute the recipes that are specified by the Args parameter.
• install_dependencies: Installs the stack's dependencies.
• update_custom_cookbooks: Update the stack's custom cookbooks.
• update_dependencies: Update the stack's dependencies.

For apps, the available commands are:

• deploy: Deploy the app.
• rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks 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.

See Also:

DeploymentCommandName

withName

public DeploymentCommand withName(String name)

Specifies the deployment operation. You can specify only one command.

For stacks, the available commands are:

• execute_recipes: Execute the recipes that are specified by the Args parameter.
• install_dependencies: Installs the stack's dependencies.
• update_custom_cookbooks: Update the stack's custom cookbooks.
• update_dependencies: Update the stack's dependencies.

For apps, the available commands are:

• deploy: Deploy the app.
• rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: install_dependencies, update_dependencies, update_custom_cookbooks, execute_recipes, deploy, rollback, start, stop, restart, undeploy

Parameters:

name - Specifies the deployment operation. You can specify only one command.

For stacks, the available commands are:

• execute_recipes: Execute the recipes that are specified by the Args parameter.
• install_dependencies: Installs the stack's dependencies.
• update_custom_cookbooks: Update the stack's custom cookbooks.
• update_dependencies: Update the stack's dependencies.

For apps, the available commands are:

• deploy: Deploy the app.
• rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks 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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

DeploymentCommandName

setName

public void setName(DeploymentCommandName name)

Specifies the deployment operation. You can specify only one command.

For stacks, the available commands are:

• execute_recipes: Execute the recipes that are specified by the Args parameter.
• install_dependencies: Installs the stack's dependencies.
• update_custom_cookbooks: Update the stack's custom cookbooks.
• update_dependencies: Update the stack's dependencies.

For apps, the available commands are:

• deploy: Deploy the app.
• rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks 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.

Constraints:
Allowed Values: install_dependencies, update_dependencies, update_custom_cookbooks, execute_recipes, deploy, rollback, start, stop, restart, undeploy

Parameters:

name - Specifies the deployment operation. You can specify only one command.

For stacks, the available commands are:

• execute_recipes: Execute the recipes that are specified by the Args parameter.
• install_dependencies: Installs the stack's dependencies.
• update_custom_cookbooks: Update the stack's custom cookbooks.
• update_dependencies: Update the stack's dependencies.

For apps, the available commands are:

• deploy: Deploy the app.
• rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks 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.

See Also:

DeploymentCommandName

withName

public DeploymentCommand withName(DeploymentCommandName name)

Specifies the deployment operation. You can specify only one command.

For stacks, the available commands are:

• execute_recipes: Execute the recipes that are specified by the Args parameter.
• install_dependencies: Installs the stack's dependencies.
• update_custom_cookbooks: Update the stack's custom cookbooks.
• update_dependencies: Update the stack's dependencies.

For apps, the available commands are:

• deploy: Deploy the app.
• rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: install_dependencies, update_dependencies, update_custom_cookbooks, execute_recipes, deploy, rollback, start, stop, restart, undeploy

Parameters:

name - Specifies the deployment operation. You can specify only one command.

For stacks, the available commands are:

• execute_recipes: Execute the recipes that are specified by the Args parameter.
• install_dependencies: Installs the stack's dependencies.
• update_custom_cookbooks: Update the stack's custom cookbooks.
• update_dependencies: Update the stack's dependencies.

For apps, the available commands are:

• deploy: Deploy the app.
• rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks 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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

DeploymentCommandName

getArgs

public Map<String,List<String>> getArgs()

An array of command arguments. This parameter is currently used only to specify the list of recipes to be executed by the ExecuteRecipes command.

Returns:

An array of command arguments. This parameter is currently used only to specify the list of recipes to be executed by the ExecuteRecipes command.

setArgs

public void setArgs(Map<String,List<String>> args)

An array of command arguments. This parameter is currently used only to specify the list of recipes to be executed by the ExecuteRecipes command.

Parameters:

args - An array of command arguments. This parameter is currently used only to specify the list of recipes to be executed by the ExecuteRecipes command.

withArgs

public DeploymentCommand withArgs(Map<String,List<String>> args)

An array of command arguments. This parameter is currently used only to specify the list of recipes to be executed by the ExecuteRecipes command.

Returns a reference to this object so that method calls can be chained together.

Parameters:

args - An array of command arguments. This parameter is currently used only to specify the list of recipes to be executed by the ExecuteRecipes command.

Returns:

A reference to this updated object so that method calls can be chained together.

addArgsEntry

public DeploymentCommand addArgsEntry(String key,
                             List<String> value)

An array of command arguments. This parameter is currently used only to specify the list of recipes to be executed by the ExecuteRecipes command.

The method adds a new key-value pair into Args parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Args.

value - The corresponding value of the entry to be added into Args.

clearArgsEntries

public DeploymentCommand clearArgsEntries()

Removes all the entries added into Args.

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object