Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . m2 ]

update-environment

Description

Updates the configuration details for a specific environment.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-environment
[--apply-during-maintenance-window | --no-apply-during-maintenance-window]
[--desired-capacity <value>]
[--engine-version <value>]
--environment-id <value>
[--instance-type <value>]
[--preferred-maintenance-window <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--apply-during-maintenance-window | --no-apply-during-maintenance-window (boolean)

Indicates whether to update the environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest , it will fail if applyDuringMaintenanceWindow is set to true.

--desired-capacity (integer)

The desired capacity for the environment to update.

--engine-version (string)

The version of the runtime engine for the environment.

--environment-id (string)

The unique identifier of the runtime environment that you want to update.

--instance-type (string)

The instance type for the environment to update.

--preferred-maintenance-window (string)

Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

environmentId -> (string)

The unique identifier of the runtime environment that was updated.