public class DeploymentCommand
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Used to specify a stack or deployment command.
Modifier and Type | Field and Description |
---|---|
private SdkInternalMap<java.lang.String,java.util.List<java.lang.String>> |
args
The arguments of those commands that take arguments.
|
private java.lang.String |
name
Specifies the operation.
|
Constructor and Description |
---|
DeploymentCommand() |
Modifier and Type | Method and Description |
---|---|
DeploymentCommand |
addArgsEntry(java.lang.String key,
java.util.List<java.lang.String> value) |
DeploymentCommand |
clearArgsEntries()
Removes all the entries added into Args.
|
DeploymentCommand |
clone() |
boolean |
equals(java.lang.Object obj) |
java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
getArgs()
The arguments of those commands that take arguments.
|
java.lang.String |
getName()
Specifies the operation.
|
int |
hashCode() |
void |
setArgs(java.util.Map<java.lang.String,java.util.List<java.lang.String>> args)
The arguments of those commands that take arguments.
|
void |
setName(DeploymentCommandName name)
Specifies the operation.
|
void |
setName(java.lang.String name)
Specifies the operation.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DeploymentCommand |
withArgs(java.util.Map<java.lang.String,java.util.List<java.lang.String>> args)
The arguments of those commands that take arguments.
|
DeploymentCommand |
withName(DeploymentCommandName name)
Specifies the operation.
|
DeploymentCommand |
withName(java.lang.String name)
Specifies the operation.
|
private java.lang.String 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.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 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.private SdkInternalMap<java.lang.String,java.util.List<java.lang.String>> 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 2014.09
. You must also set the
allow_reboot
argument to true.allow_reboot
- Specifies whether to allow AWS OpsWorks
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 2014.09, set
Args
to the following.
{ "upgrade_os_to":["Amazon Linux 2014.09"], "allow_reboot":["true"] }
public void setName(java.lang.String 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.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 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.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.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 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.DeploymentCommandName
public java.lang.String getName()
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.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 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.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.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 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.DeploymentCommandName
public DeploymentCommand withName(java.lang.String 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.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 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.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.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 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.DeploymentCommandName
public void setName(DeploymentCommandName 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.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 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.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.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 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.DeploymentCommandName
public DeploymentCommand withName(DeploymentCommandName 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.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 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.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.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 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.DeploymentCommandName
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getArgs()
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 2014.09
. You must also set the
allow_reboot
argument to true.allow_reboot
- Specifies whether to allow AWS OpsWorks
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 2014.09, set
Args
to the following.
{ "upgrade_os_to":["Amazon Linux 2014.09"], "allow_reboot":["true"] }
{"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 2014.09
. You must also set the
allow_reboot
argument to true.allow_reboot
- Specifies whether to allow AWS
OpsWorks 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 2014.09, set
Args
to the following.
{ "upgrade_os_to":["Amazon Linux 2014.09"], "allow_reboot":["true"] }
public void setArgs(java.util.Map<java.lang.String,java.util.List<java.lang.String>> 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 2014.09
. You must also set the
allow_reboot
argument to true.allow_reboot
- Specifies whether to allow AWS OpsWorks
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 2014.09, set
Args
to the following.
{ "upgrade_os_to":["Amazon Linux 2014.09"], "allow_reboot":["true"] }
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 2014.09
. You must also set the
allow_reboot
argument to true.allow_reboot
- Specifies whether to allow AWS
OpsWorks 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 2014.09, set
Args
to the following.
{ "upgrade_os_to":["Amazon Linux 2014.09"], "allow_reboot":["true"] }
public DeploymentCommand withArgs(java.util.Map<java.lang.String,java.util.List<java.lang.String>> 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 2014.09
. You must also set the
allow_reboot
argument to true.allow_reboot
- Specifies whether to allow AWS OpsWorks
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 2014.09, set
Args
to the following.
{ "upgrade_os_to":["Amazon Linux 2014.09"], "allow_reboot":["true"] }
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 2014.09
. You must also set the
allow_reboot
argument to true.allow_reboot
- Specifies whether to allow AWS
OpsWorks 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 2014.09, set
Args
to the following.
{ "upgrade_os_to":["Amazon Linux 2014.09"], "allow_reboot":["true"] }
public DeploymentCommand addArgsEntry(java.lang.String key, java.util.List<java.lang.String> value)
public DeploymentCommand clearArgsEntries()
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public DeploymentCommand clone()
clone
in class java.lang.Object