Java tutorial
/* * Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.opsworks.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** * <p> * Used to specify a stack or deployment command. * </p> * * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/DeploymentCommand" target="_top">AWS API * Documentation</a> */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DeploymentCommand implements Serializable, Cloneable, StructuredPojo { /** * <p> * Specifies the operation. You can specify only one command. * </p> * <p> * For stacks, the following commands are available: * </p> * <ul> * <li> * <p> * <code>execute_recipes</code>: Execute one or more recipes. To specify the recipes, set an <code>Args</code> * parameter named <code>recipes</code> to the list of recipes to be executed. For example, to execute * <code>phpapp::appsetup</code>, set <code>Args</code> to <code>{"recipes":["phpapp::appsetup"]}</code>. * </p> * </li> * <li> * <p> * <code>install_dependencies</code>: Install the stack's dependencies. * </p> * </li> * <li> * <p> * <code>update_custom_cookbooks</code>: Update the stack's custom cookbooks. * </p> * </li> * <li> * <p> * <code>update_dependencies</code>: Update the stack's dependencies. * </p> * </li> * </ul> * <note> * <p> * 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. * </p> * </note> * <p> * For apps, the following commands are available: * </p> * <ul> * <li> * <p> * <code>deploy</code>: Deploy an app. Ruby on Rails apps have an optional <code>Args</code> parameter named * <code>migrate</code>. Set <code>Args</code> to {"migrate":["true"]} to migrate the database. The default setting * is {"migrate":["false"]}. * </p> * </li> * <li> * <p> * <code>rollback</code> 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. * </p> * </li> * <li> * <p> * <code>start</code>: Start the app's web or application server. * </p> * </li> * <li> * <p> * <code>stop</code>: Stop the app's web or application server. * </p> * </li> * <li> * <p> * <code>restart</code>: Restart the app's web or application server. * </p> * </li> * <li> * <p> * <code>undeploy</code>: Undeploy the app. * </p> * </li> * </ul> */ private String name; /** * <p> * The arguments of those commands that take arguments. It should be set to a JSON object with the following format: * </p> * <p> * <code>{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}</code> * </p> * <p> * The <code>update_dependencies</code> command takes two arguments: * </p> * <ul> * <li> * <p> * <code>upgrade_os_to</code> - Specifies the desired Amazon Linux version for instances whose OS you want to * upgrade, such as <code>Amazon Linux 2016.09</code>. You must also set the <code>allow_reboot</code> argument to * true. * </p> * </li> * <li> * <p> * <code>allow_reboot</code> - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if necessary, * after installing the updates. This argument can be set to either <code>true</code> or <code>false</code>. The * default value is <code>false</code>. * </p> * </li> * </ul> * <p> * For example, to upgrade an instance to Amazon Linux 2016.09, set <code>Args</code> to the following. * </p> * <p> * <code> { "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] } </code> * </p> */ private com.amazonaws.internal.SdkInternalMap<String, java.util.List<String>> args; /** * <p> * Specifies the operation. You can specify only one command. * </p> * <p> * For stacks, the following commands are available: * </p> * <ul> * <li> * <p> * <code>execute_recipes</code>: Execute one or more recipes. To specify the recipes, set an <code>Args</code> * parameter named <code>recipes</code> to the list of recipes to be executed. For example, to execute * <code>phpapp::appsetup</code>, set <code>Args</code> to <code>{"recipes":["phpapp::appsetup"]}</code>. * </p> * </li> * <li> * <p> * <code>install_dependencies</code>: Install the stack's dependencies. * </p> * </li> * <li> * <p> * <code>update_custom_cookbooks</code>: Update the stack's custom cookbooks. * </p> * </li> * <li> * <p> * <code>update_dependencies</code>: Update the stack's dependencies. * </p> * </li> * </ul> * <note> * <p> * 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. * </p> * </note> * <p> * For apps, the following commands are available: * </p> * <ul> * <li> * <p> * <code>deploy</code>: Deploy an app. Ruby on Rails apps have an optional <code>Args</code> parameter named * <code>migrate</code>. Set <code>Args</code> to {"migrate":["true"]} to migrate the database. The default setting * is {"migrate":["false"]}. * </p> * </li> * <li> * <p> * <code>rollback</code> 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. * </p> * </li> * <li> * <p> * <code>start</code>: Start the app's web or application server. * </p> * </li> * <li> * <p> * <code>stop</code>: Stop the app's web or application server. * </p> * </li> * <li> * <p> * <code>restart</code>: Restart the app's web or application server. * </p> * </li> * <li> * <p> * <code>undeploy</code>: Undeploy the app. * </p> * </li> * </ul> * * @param name * Specifies the operation. You can specify only one command.</p> * <p> * For stacks, the following commands are available: * </p> * <ul> * <li> * <p> * <code>execute_recipes</code>: Execute one or more recipes. To specify the recipes, set an * <code>Args</code> parameter named <code>recipes</code> to the list of recipes to be executed. For example, * to execute <code>phpapp::appsetup</code>, set <code>Args</code> to * <code>{"recipes":["phpapp::appsetup"]}</code>. * </p> * </li> * <li> * <p> * <code>install_dependencies</code>: Install the stack's dependencies. * </p> * </li> * <li> * <p> * <code>update_custom_cookbooks</code>: Update the stack's custom cookbooks. * </p> * </li> * <li> * <p> * <code>update_dependencies</code>: Update the stack's dependencies. * </p> * </li> * </ul> * <note> * <p> * 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. * </p> * </note> * <p> * For apps, the following commands are available: * </p> * <ul> * <li> * <p> * <code>deploy</code>: Deploy an app. Ruby on Rails apps have an optional <code>Args</code> parameter named * <code>migrate</code>. Set <code>Args</code> to {"migrate":["true"]} to migrate the database. The default * setting is {"migrate":["false"]}. * </p> * </li> * <li> * <p> * <code>rollback</code> 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. * </p> * </li> * <li> * <p> * <code>start</code>: Start the app's web or application server. * </p> * </li> * <li> * <p> * <code>stop</code>: Stop the app's web or application server. * </p> * </li> * <li> * <p> * <code>restart</code>: Restart the app's web or application server. * </p> * </li> * <li> * <p> * <code>undeploy</code>: Undeploy the app. * </p> * </li> * @see DeploymentCommandName */ public void setName(String name) { this.name = name; } /** * <p> * Specifies the operation. You can specify only one command. * </p> * <p> * For stacks, the following commands are available: * </p> * <ul> * <li> * <p> * <code>execute_recipes</code>: Execute one or more recipes. To specify the recipes, set an <code>Args</code> * parameter named <code>recipes</code> to the list of recipes to be executed. For example, to execute * <code>phpapp::appsetup</code>, set <code>Args</code> to <code>{"recipes":["phpapp::appsetup"]}</code>. * </p> * </li> * <li> * <p> * <code>install_dependencies</code>: Install the stack's dependencies. * </p> * </li> * <li> * <p> * <code>update_custom_cookbooks</code>: Update the stack's custom cookbooks. * </p> * </li> * <li> * <p> * <code>update_dependencies</code>: Update the stack's dependencies. * </p> * </li> * </ul> * <note> * <p> * 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. * </p> * </note> * <p> * For apps, the following commands are available: * </p> * <ul> * <li> * <p> * <code>deploy</code>: Deploy an app. Ruby on Rails apps have an optional <code>Args</code> parameter named * <code>migrate</code>. Set <code>Args</code> to {"migrate":["true"]} to migrate the database. The default setting * is {"migrate":["false"]}. * </p> * </li> * <li> * <p> * <code>rollback</code> 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. * </p> * </li> * <li> * <p> * <code>start</code>: Start the app's web or application server. * </p> * </li> * <li> * <p> * <code>stop</code>: Stop the app's web or application server. * </p> * </li> * <li> * <p> * <code>restart</code>: Restart the app's web or application server. * </p> * </li> * <li> * <p> * <code>undeploy</code>: Undeploy the app. * </p> * </li> * </ul> * * @return Specifies the operation. You can specify only one command.</p> * <p> * For stacks, the following commands are available: * </p> * <ul> * <li> * <p> * <code>execute_recipes</code>: Execute one or more recipes. To specify the recipes, set an * <code>Args</code> parameter named <code>recipes</code> to the list of recipes to be executed. For * example, to execute <code>phpapp::appsetup</code>, set <code>Args</code> to * <code>{"recipes":["phpapp::appsetup"]}</code>. * </p> * </li> * <li> * <p> * <code>install_dependencies</code>: Install the stack's dependencies. * </p> * </li> * <li> * <p> * <code>update_custom_cookbooks</code>: Update the stack's custom cookbooks. * </p> * </li> * <li> * <p> * <code>update_dependencies</code>: Update the stack's dependencies. * </p> * </li> * </ul> * <note> * <p> * 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. * </p> * </note> * <p> * For apps, the following commands are available: * </p> * <ul> * <li> * <p> * <code>deploy</code>: Deploy an app. Ruby on Rails apps have an optional <code>Args</code> parameter named * <code>migrate</code>. Set <code>Args</code> to {"migrate":["true"]} to migrate the database. The default * setting is {"migrate":["false"]}. * </p> * </li> * <li> * <p> * <code>rollback</code> 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. * </p> * </li> * <li> * <p> * <code>start</code>: Start the app's web or application server. * </p> * </li> * <li> * <p> * <code>stop</code>: Stop the app's web or application server. * </p> * </li> * <li> * <p> * <code>restart</code>: Restart the app's web or application server. * </p> * </li> * <li> * <p> * <code>undeploy</code>: Undeploy the app. * </p> * </li> * @see DeploymentCommandName */ public String getName() { return this.name; } /** * <p> * Specifies the operation. You can specify only one command. * </p> * <p> * For stacks, the following commands are available: * </p> * <ul> * <li> * <p> * <code>execute_recipes</code>: Execute one or more recipes. To specify the recipes, set an <code>Args</code> * parameter named <code>recipes</code> to the list of recipes to be executed. For example, to execute * <code>phpapp::appsetup</code>, set <code>Args</code> to <code>{"recipes":["phpapp::appsetup"]}</code>. * </p> * </li> * <li> * <p> * <code>install_dependencies</code>: Install the stack's dependencies. * </p> * </li> * <li> * <p> * <code>update_custom_cookbooks</code>: Update the stack's custom cookbooks. * </p> * </li> * <li> * <p> * <code>update_dependencies</code>: Update the stack's dependencies. * </p> * </li> * </ul> * <note> * <p> * 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. * </p> * </note> * <p> * For apps, the following commands are available: * </p> * <ul> * <li> * <p> * <code>deploy</code>: Deploy an app. Ruby on Rails apps have an optional <code>Args</code> parameter named * <code>migrate</code>. Set <code>Args</code> to {"migrate":["true"]} to migrate the database. The default setting * is {"migrate":["false"]}. * </p> * </li> * <li> * <p> * <code>rollback</code> 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. * </p> * </li> * <li> * <p> * <code>start</code>: Start the app's web or application server. * </p> * </li> * <li> * <p> * <code>stop</code>: Stop the app's web or application server. * </p> * </li> * <li> * <p> * <code>restart</code>: Restart the app's web or application server. * </p> * </li> * <li> * <p> * <code>undeploy</code>: Undeploy the app. * </p> * </li> * </ul> * * @param name * Specifies the operation. You can specify only one command.</p> * <p> * For stacks, the following commands are available: * </p> * <ul> * <li> * <p> * <code>execute_recipes</code>: Execute one or more recipes. To specify the recipes, set an * <code>Args</code> parameter named <code>recipes</code> to the list of recipes to be executed. For example, * to execute <code>phpapp::appsetup</code>, set <code>Args</code> to * <code>{"recipes":["phpapp::appsetup"]}</code>. * </p> * </li> * <li> * <p> * <code>install_dependencies</code>: Install the stack's dependencies. * </p> * </li> * <li> * <p> * <code>update_custom_cookbooks</code>: Update the stack's custom cookbooks. * </p> * </li> * <li> * <p> * <code>update_dependencies</code>: Update the stack's dependencies. * </p> * </li> * </ul> * <note> * <p> * 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. * </p> * </note> * <p> * For apps, the following commands are available: * </p> * <ul> * <li> * <p> * <code>deploy</code>: Deploy an app. Ruby on Rails apps have an optional <code>Args</code> parameter named * <code>migrate</code>. Set <code>Args</code> to {"migrate":["true"]} to migrate the database. The default * setting is {"migrate":["false"]}. * </p> * </li> * <li> * <p> * <code>rollback</code> 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. * </p> * </li> * <li> * <p> * <code>start</code>: Start the app's web or application server. * </p> * </li> * <li> * <p> * <code>stop</code>: Stop the app's web or application server. * </p> * </li> * <li> * <p> * <code>restart</code>: Restart the app's web or application server. * </p> * </li> * <li> * <p> * <code>undeploy</code>: Undeploy the app. * </p> * </li> * @return Returns a reference to this object so that method calls can be chained together. * @see DeploymentCommandName */ public DeploymentCommand withName(String name) { setName(name); return this; } /** * <p> * Specifies the operation. You can specify only one command. * </p> * <p> * For stacks, the following commands are available: * </p> * <ul> * <li> * <p> * <code>execute_recipes</code>: Execute one or more recipes. To specify the recipes, set an <code>Args</code> * parameter named <code>recipes</code> to the list of recipes to be executed. For example, to execute * <code>phpapp::appsetup</code>, set <code>Args</code> to <code>{"recipes":["phpapp::appsetup"]}</code>. * </p> * </li> * <li> * <p> * <code>install_dependencies</code>: Install the stack's dependencies. * </p> * </li> * <li> * <p> * <code>update_custom_cookbooks</code>: Update the stack's custom cookbooks. * </p> * </li> * <li> * <p> * <code>update_dependencies</code>: Update the stack's dependencies. * </p> * </li> * </ul> * <note> * <p> * 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. * </p> * </note> * <p> * For apps, the following commands are available: * </p> * <ul> * <li> * <p> * <code>deploy</code>: Deploy an app. Ruby on Rails apps have an optional <code>Args</code> parameter named * <code>migrate</code>. Set <code>Args</code> to {"migrate":["true"]} to migrate the database. The default setting * is {"migrate":["false"]}. * </p> * </li> * <li> * <p> * <code>rollback</code> 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. * </p> * </li> * <li> * <p> * <code>start</code>: Start the app's web or application server. * </p> * </li> * <li> * <p> * <code>stop</code>: Stop the app's web or application server. * </p> * </li> * <li> * <p> * <code>restart</code>: Restart the app's web or application server. * </p> * </li> * <li> * <p> * <code>undeploy</code>: Undeploy the app. * </p> * </li> * </ul> * * @param name * Specifies the operation. You can specify only one command.</p> * <p> * For stacks, the following commands are available: * </p> * <ul> * <li> * <p> * <code>execute_recipes</code>: Execute one or more recipes. To specify the recipes, set an * <code>Args</code> parameter named <code>recipes</code> to the list of recipes to be executed. For example, * to execute <code>phpapp::appsetup</code>, set <code>Args</code> to * <code>{"recipes":["phpapp::appsetup"]}</code>. * </p> * </li> * <li> * <p> * <code>install_dependencies</code>: Install the stack's dependencies. * </p> * </li> * <li> * <p> * <code>update_custom_cookbooks</code>: Update the stack's custom cookbooks. * </p> * </li> * <li> * <p> * <code>update_dependencies</code>: Update the stack's dependencies. * </p> * </li> * </ul> * <note> * <p> * 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. * </p> * </note> * <p> * For apps, the following commands are available: * </p> * <ul> * <li> * <p> * <code>deploy</code>: Deploy an app. Ruby on Rails apps have an optional <code>Args</code> parameter named * <code>migrate</code>. Set <code>Args</code> to {"migrate":["true"]} to migrate the database. The default * setting is {"migrate":["false"]}. * </p> * </li> * <li> * <p> * <code>rollback</code> 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. * </p> * </li> * <li> * <p> * <code>start</code>: Start the app's web or application server. * </p> * </li> * <li> * <p> * <code>stop</code>: Stop the app's web or application server. * </p> * </li> * <li> * <p> * <code>restart</code>: Restart the app's web or application server. * </p> * </li> * <li> * <p> * <code>undeploy</code>: Undeploy the app. * </p> * </li> * @see DeploymentCommandName */ public void setName(DeploymentCommandName name) { withName(name); } /** * <p> * Specifies the operation. You can specify only one command. * </p> * <p> * For stacks, the following commands are available: * </p> * <ul> * <li> * <p> * <code>execute_recipes</code>: Execute one or more recipes. To specify the recipes, set an <code>Args</code> * parameter named <code>recipes</code> to the list of recipes to be executed. For example, to execute * <code>phpapp::appsetup</code>, set <code>Args</code> to <code>{"recipes":["phpapp::appsetup"]}</code>. * </p> * </li> * <li> * <p> * <code>install_dependencies</code>: Install the stack's dependencies. * </p> * </li> * <li> * <p> * <code>update_custom_cookbooks</code>: Update the stack's custom cookbooks. * </p> * </li> * <li> * <p> * <code>update_dependencies</code>: Update the stack's dependencies. * </p> * </li> * </ul> * <note> * <p> * 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. * </p> * </note> * <p> * For apps, the following commands are available: * </p> * <ul> * <li> * <p> * <code>deploy</code>: Deploy an app. Ruby on Rails apps have an optional <code>Args</code> parameter named * <code>migrate</code>. Set <code>Args</code> to {"migrate":["true"]} to migrate the database. The default setting * is {"migrate":["false"]}. * </p> * </li> * <li> * <p> * <code>rollback</code> 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. * </p> * </li> * <li> * <p> * <code>start</code>: Start the app's web or application server. * </p> * </li> * <li> * <p> * <code>stop</code>: Stop the app's web or application server. * </p> * </li> * <li> * <p> * <code>restart</code>: Restart the app's web or application server. * </p> * </li> * <li> * <p> * <code>undeploy</code>: Undeploy the app. * </p> * </li> * </ul> * * @param name * Specifies the operation. You can specify only one command.</p> * <p> * For stacks, the following commands are available: * </p> * <ul> * <li> * <p> * <code>execute_recipes</code>: Execute one or more recipes. To specify the recipes, set an * <code>Args</code> parameter named <code>recipes</code> to the list of recipes to be executed. For example, * to execute <code>phpapp::appsetup</code>, set <code>Args</code> to * <code>{"recipes":["phpapp::appsetup"]}</code>. * </p> * </li> * <li> * <p> * <code>install_dependencies</code>: Install the stack's dependencies. * </p> * </li> * <li> * <p> * <code>update_custom_cookbooks</code>: Update the stack's custom cookbooks. * </p> * </li> * <li> * <p> * <code>update_dependencies</code>: Update the stack's dependencies. * </p> * </li> * </ul> * <note> * <p> * 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. * </p> * </note> * <p> * For apps, the following commands are available: * </p> * <ul> * <li> * <p> * <code>deploy</code>: Deploy an app. Ruby on Rails apps have an optional <code>Args</code> parameter named * <code>migrate</code>. Set <code>Args</code> to {"migrate":["true"]} to migrate the database. The default * setting is {"migrate":["false"]}. * </p> * </li> * <li> * <p> * <code>rollback</code> 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. * </p> * </li> * <li> * <p> * <code>start</code>: Start the app's web or application server. * </p> * </li> * <li> * <p> * <code>stop</code>: Stop the app's web or application server. * </p> * </li> * <li> * <p> * <code>restart</code>: Restart the app's web or application server. * </p> * </li> * <li> * <p> * <code>undeploy</code>: Undeploy the app. * </p> * </li> * @return Returns a reference to this object so that method calls can be chained together. * @see DeploymentCommandName */ public DeploymentCommand withName(DeploymentCommandName name) { this.name = name.toString(); return this; } /** * <p> * The arguments of those commands that take arguments. It should be set to a JSON object with the following format: * </p> * <p> * <code>{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}</code> * </p> * <p> * The <code>update_dependencies</code> command takes two arguments: * </p> * <ul> * <li> * <p> * <code>upgrade_os_to</code> - Specifies the desired Amazon Linux version for instances whose OS you want to * upgrade, such as <code>Amazon Linux 2016.09</code>. You must also set the <code>allow_reboot</code> argument to * true. * </p> * </li> * <li> * <p> * <code>allow_reboot</code> - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if necessary, * after installing the updates. This argument can be set to either <code>true</code> or <code>false</code>. The * default value is <code>false</code>. * </p> * </li> * </ul> * <p> * For example, to upgrade an instance to Amazon Linux 2016.09, set <code>Args</code> to the following. * </p> * <p> * <code> { "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] } </code> * </p> * * @return The arguments of those commands that take arguments. It should be set to a JSON object with the following * format:</p> * <p> * <code>{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}</code> * </p> * <p> * The <code>update_dependencies</code> command takes two arguments: * </p> * <ul> * <li> * <p> * <code>upgrade_os_to</code> - Specifies the desired Amazon Linux version for instances whose OS you want * to upgrade, such as <code>Amazon Linux 2016.09</code>. You must also set the <code>allow_reboot</code> * argument to true. * </p> * </li> * <li> * <p> * <code>allow_reboot</code> - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if * necessary, after installing the updates. This argument can be set to either <code>true</code> or * <code>false</code>. The default value is <code>false</code>. * </p> * </li> * </ul> * <p> * For example, to upgrade an instance to Amazon Linux 2016.09, set <code>Args</code> to the following. * </p> * <p> * <code> { "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] } </code> */ public java.util.Map<String, java.util.List<String>> getArgs() { if (args == null) { args = new com.amazonaws.internal.SdkInternalMap<String, java.util.List<String>>(); } return args; } /** * <p> * The arguments of those commands that take arguments. It should be set to a JSON object with the following format: * </p> * <p> * <code>{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}</code> * </p> * <p> * The <code>update_dependencies</code> command takes two arguments: * </p> * <ul> * <li> * <p> * <code>upgrade_os_to</code> - Specifies the desired Amazon Linux version for instances whose OS you want to * upgrade, such as <code>Amazon Linux 2016.09</code>. You must also set the <code>allow_reboot</code> argument to * true. * </p> * </li> * <li> * <p> * <code>allow_reboot</code> - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if necessary, * after installing the updates. This argument can be set to either <code>true</code> or <code>false</code>. The * default value is <code>false</code>. * </p> * </li> * </ul> * <p> * For example, to upgrade an instance to Amazon Linux 2016.09, set <code>Args</code> to the following. * </p> * <p> * <code> { "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] } </code> * </p> * * @param args * The arguments of those commands that take arguments. It should be set to a JSON object with the following * format:</p> * <p> * <code>{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}</code> * </p> * <p> * The <code>update_dependencies</code> command takes two arguments: * </p> * <ul> * <li> * <p> * <code>upgrade_os_to</code> - Specifies the desired Amazon Linux version for instances whose OS you want to * upgrade, such as <code>Amazon Linux 2016.09</code>. You must also set the <code>allow_reboot</code> * argument to true. * </p> * </li> * <li> * <p> * <code>allow_reboot</code> - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if * necessary, after installing the updates. This argument can be set to either <code>true</code> or * <code>false</code>. The default value is <code>false</code>. * </p> * </li> * </ul> * <p> * For example, to upgrade an instance to Amazon Linux 2016.09, set <code>Args</code> to the following. * </p> * <p> * <code> { "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] } </code> */ public void setArgs(java.util.Map<String, java.util.List<String>> args) { this.args = args == null ? null : new com.amazonaws.internal.SdkInternalMap<String, java.util.List<String>>(args); } /** * <p> * The arguments of those commands that take arguments. It should be set to a JSON object with the following format: * </p> * <p> * <code>{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}</code> * </p> * <p> * The <code>update_dependencies</code> command takes two arguments: * </p> * <ul> * <li> * <p> * <code>upgrade_os_to</code> - Specifies the desired Amazon Linux version for instances whose OS you want to * upgrade, such as <code>Amazon Linux 2016.09</code>. You must also set the <code>allow_reboot</code> argument to * true. * </p> * </li> * <li> * <p> * <code>allow_reboot</code> - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if necessary, * after installing the updates. This argument can be set to either <code>true</code> or <code>false</code>. The * default value is <code>false</code>. * </p> * </li> * </ul> * <p> * For example, to upgrade an instance to Amazon Linux 2016.09, set <code>Args</code> to the following. * </p> * <p> * <code> { "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] } </code> * </p> * * @param args * The arguments of those commands that take arguments. It should be set to a JSON object with the following * format:</p> * <p> * <code>{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}</code> * </p> * <p> * The <code>update_dependencies</code> command takes two arguments: * </p> * <ul> * <li> * <p> * <code>upgrade_os_to</code> - Specifies the desired Amazon Linux version for instances whose OS you want to * upgrade, such as <code>Amazon Linux 2016.09</code>. You must also set the <code>allow_reboot</code> * argument to true. * </p> * </li> * <li> * <p> * <code>allow_reboot</code> - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if * necessary, after installing the updates. This argument can be set to either <code>true</code> or * <code>false</code>. The default value is <code>false</code>. * </p> * </li> * </ul> * <p> * For example, to upgrade an instance to Amazon Linux 2016.09, set <code>Args</code> to the following. * </p> * <p> * <code> { "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] } </code> * @return Returns a reference to this object so that method calls can be chained together. */ public DeploymentCommand withArgs(java.util.Map<String, java.util.List<String>> args) { setArgs(args); return this; } public DeploymentCommand addArgsEntry(String key, java.util.List<String> value) { if (null == this.args) { this.args = new com.amazonaws.internal.SdkInternalMap<String, java.util.List<String>>(); } if (this.args.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.args.put(key, value); return this; } /** * Removes all the entries added into Args. * * @return Returns a reference to this object so that method calls can be chained together. */ public DeploymentCommand clearArgsEntries() { this.args = null; return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getArgs() != null) sb.append("Args: ").append(getArgs()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DeploymentCommand == false) return false; DeploymentCommand other = (DeploymentCommand) obj; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getArgs() == null ^ this.getArgs() == null) return false; if (other.getArgs() != null && other.getArgs().equals(this.getArgs()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getArgs() == null) ? 0 : getArgs().hashCode()); return hashCode; } @Override public DeploymentCommand clone() { try { return (DeploymentCommand) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException( "Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.opsworks.model.transform.DeploymentCommandMarshaller.getInstance().marshall(this, protocolMarshaller); } }