@Generated(value="software.amazon.awssdk:codegen") public class DeploymentCommand extends Object implements StructuredPojo, ToCopyableBuilder<DeploymentCommand.Builder,DeploymentCommand>
Used to specify a stack or deployment command.
Modifier and Type | Class and Description |
---|---|
static interface |
DeploymentCommand.Builder |
Modifier and Type | Method and Description |
---|---|
Map<String,List<String>> |
args()
The arguments of those commands that take arguments.
|
static DeploymentCommand.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
DeploymentCommandName |
name()
Specifies the operation.
|
String |
nameString()
Specifies the operation.
|
static Class<? extends DeploymentCommand.Builder> |
serializableBuilderClass() |
DeploymentCommand.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public 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.
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.
If the service returns an enum value that is not available in the current SDK version, name
will return
DeploymentCommandName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
nameString()
.
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.
DeploymentCommandName
public String nameString()
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.
If the service returns an enum value that is not available in the current SDK version, name
will return
DeploymentCommandName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
nameString()
.
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.
DeploymentCommandName
public Map<String,List<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 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"] }
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
{"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"] }
public DeploymentCommand.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DeploymentCommand.Builder,DeploymentCommand>
public static DeploymentCommand.Builder builder()
public static Class<? extends DeploymentCommand.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.