
update-environment
******************


DESCRIPTION
===========

Updates the environment description, deploys a new application
version, updates the configuration settings to an entirely new
configuration template, or updates select configuration option values
in the running environment.

Attempting to update both the release and configuration is not allowed
and AWS Elastic Beanstalk returns an "InvalidParameterCombination"
error.

When updating the configuration settings to a new template or
individual settings, a draft configuration is created and  describe-
configuration-settings for this environment returns two setting
descriptions with different "DeploymentStatus" values.


SYNOPSIS
========

   aws elasticbeanstalk update-environment
     [--environment-id <value>]
     [--version-label <value>]
     [--description <value>]
     [--template-name <value>]
     [--option-settings <value>]
     [--options-to-remove <value>]
     [--environment-name <value>]


REQUIRED PARAMETERS
===================

None


OPTIONAL PARAMETERS
===================

"--environment-id"  (string)
   The ID of the environment to update.

   If no environment with this ID exists, AWS Elastic Beanstalk
   returns an "InvalidParameterValue" error.

   Condition: You must specify either this or an EnvironmentName, or
   both. If you do not specify either, AWS Elastic Beanstalk returns
   "MissingRequiredParameter" error.

"--version-label"  (string)
   If this parameter is specified, AWS Elastic Beanstalk deploys the
   named application version to the environment. If no such
   application version is found, returns an "InvalidParameterValue"
   error.

"--description"  (string)
   If this parameter is specified, AWS Elastic Beanstalk updates the
   description of this environment.

"--template-name"  (string)
   If this parameter is specified, AWS Elastic Beanstalk deploys this
   configuration template to the environment. If no such configuration
   template is found, AWS Elastic Beanstalk returns an
   "InvalidParameterValue" error.

"--option-settings"  (list)
   If specified, AWS Elastic Beanstalk updates the configuration set
   associated with the running environment and sets the specified
   configuration options to the requested value.

      (structure)
         A specification identifying an individual configuration
         option along with its current value.

         "option_name"  (string)
            The name of the configuration option.

         "namespace"  (string)
            A unique namespace identifying the option's associated AWS
            resource.

         "value"  (string)
            The current value for the configuration option.

   *Parameter Syntax*

      [
        {
          "option_name": "string",
          "namespace": "string",
          "value": "string"
        }
        ...
      ]

"--options-to-remove"  (list)
   A list of custom user-defined configuration options to remove from
   the configuration set for this environment.

      (structure)
         A specification identifying an individual configuration
         option.

         "option_name"  (string)
            The name of the configuration option.

         "namespace"  (string)
            A unique namespace identifying the option's associated AWS
            resource.

   *Parameter Syntax*

      [
        {
          "option_name": "string",
          "namespace": "string"
        }
        ...
      ]

"--environment-name"  (string)
   The name of the environment to update. If no environment with this
   name exists, AWS Elastic Beanstalk returns an
   "InvalidParameterValue" error.

   Condition: You must specify either this or an EnvironmentId, or
   both. If you do not specify either, AWS Elastic Beanstalk returns
   "MissingRequiredParameter" error.
