Interface DeploymentCommand.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DeploymentCommand.Builder,
,DeploymentCommand> SdkBuilder<DeploymentCommand.Builder,
,DeploymentCommand> SdkPojo
- Enclosing class:
DeploymentCommand
-
Method Summary
Modifier and TypeMethodDescriptionargs
(Map<String, ? extends Collection<String>> args) The arguments of those commands that take arguments.Specifies the operation.name
(DeploymentCommandName name) Specifies the operation.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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 anArgs
parameter namedrecipes
to the list of recipes to be executed. For example, to executephpapp::appsetup
, setArgs
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 optionalArgs
parameter namedmigrate
. SetArgs
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.
- Parameters:
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 anArgs
parameter namedrecipes
to the list of recipes to be executed. For example, to executephpapp::appsetup
, setArgs
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 optionalArgs
parameter namedmigrate
. SetArgs
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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 anArgs
parameter namedrecipes
to the list of recipes to be executed. For example, to executephpapp::appsetup
, setArgs
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 optionalArgs
parameter namedmigrate
. SetArgs
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.
- Parameters:
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 anArgs
parameter namedrecipes
to the list of recipes to be executed. For example, to executephpapp::appsetup
, setArgs
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 optionalArgs
parameter namedmigrate
. SetArgs
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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 asAmazon Linux 2016.09
. You must also set theallow_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 eithertrue
orfalse
. The default value isfalse
.
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"] }
- Parameters:
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 asAmazon Linux 2016.09
. You must also set theallow_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 eithertrue
orfalse
. The default value isfalse
.
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"] }
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-