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

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DeploymentCommand.Builder,DeploymentCommand>

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

Used to specify a stack or deployment command.

See Also:: Serialized Form

Nested Class Summary

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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasArgs()`	For responses, this returns true if the service returned a value for the Args property.
`int`	`hashCode()`
`DeploymentCommandName`	`name()`	Specifies the operation.
`String`	`nameAsString()`	Specifies the operation.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DeploymentCommand.Builder>`	`serializableBuilderClass()`
`DeploymentCommand.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final 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 nameAsString().
    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
  - nameAsString
```
public final String nameAsString()
```
    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 nameAsString().
    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
  - hasArgs
```
public final boolean hasArgs()
```
    For responses, this returns true if the service returned a value for the Args property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - args
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasArgs() method.
    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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DeploymentCommand.Builder,DeploymentCommand>
  - builder
```
public static DeploymentCommand.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DeploymentCommand.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DeploymentCommand

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

nameAsString

hasArgs

args

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields