DeploymentCommand (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.opsworks.model.DeploymentCommand

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<DeploymentCommand.Builder,DeploymentCommand>

@Generated("software.amazon.awssdk:codegen")
public class DeploymentCommand
extends Object
implements StructuredPojo, ToCopyableBuilder<DeploymentCommand.Builder,DeploymentCommand>

Used to specify a stack or deployment command.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DeploymentCommand.Builder

Nested Classes
Modifier and Type	Class	Description
`static interface`	`DeploymentCommand.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,List<String>>`	`args()`	The arguments of those commands that take arguments.
`static DeploymentCommand.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`	Marshalls this structured data using the given `ProtocolMarshaller`.
`String`	`name()`	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()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - name
```
public 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.
    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.
    Returns:
    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.
    See Also:
    
    DeploymentCommandName
  - args
```
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"] }
    Returns:
    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"] }
  - toBuilder
```
public DeploymentCommand.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DeploymentCommand.Builder,DeploymentCommand>
    
    Returns:
    
    a builder for type T
  - builder
```
public static DeploymentCommand.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DeploymentCommand.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Class DeploymentCommand

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

name

args

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

marshall