Class DeploymentCommand
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DeploymentCommand.Builder,
DeploymentCommand>
Used to specify a stack or deployment command.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionargs()
The arguments of those commands that take arguments.static DeploymentCommand.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
hasArgs()
For responses, this returns true if the service returned a value for the Args property.final int
hashCode()
final DeploymentCommandName
name()
Specifies the operation.final String
Specifies the operation.static Class
<? extends DeploymentCommand.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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.
If the service returns an enum value that is not available in the current SDK version,
name
will returnDeploymentCommandName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- 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 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.
-
- See Also:
-
-
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 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.
If the service returns an enum value that is not available in the current SDK version,
name
will returnDeploymentCommandName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- 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 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.
-
- See Also:
-
-
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 theisEmpty()
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
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"] }
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 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"] }
-
-
-
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 interfaceToCopyableBuilder<DeploymentCommand.Builder,
DeploymentCommand> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-