Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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 . proton ]

update-environment

Description

Update an environment.

If the environment is associated with an environment account connection, don't update or include the protonServiceRoleArn parameter to update or connect to an environment account connection.

You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.

If the environment isn't associated with an environment account connection, don't update or include the environmentAccountConnectionId parameter to update or connect to an environment account connection.

You can update either the environmentAccountConnectionId or protonServiceRoleArn parameter and value. You can’t update both.

There are four modes for updating an environment as described in the following. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type .

MINOR_VERSION

In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that's higher than the major version in use and a minor version (optional).

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-environment
--deployment-type <value>
[--description <value>]
[--environment-account-connection-id <value>]
--name <value>
[--proton-service-role-arn <value>]
[--spec <value>]
[--template-major-version <value>]
[--template-minor-version <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--deployment-type (string)

There are four modes for updating an environment as described in the following. The deploymentType field defines the mode.

NONE

In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated.

CURRENT_VERSION

In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated. Don’t include minor or major version parameters when you use this deployment-type .

MINOR_VERSION

In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in use, by default. You can also specify a different minor version of the current major version in use.

MAJOR_VERSION

In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template, by default. You can also specify a different major version that is higher than the major version in use and a minor version (optional).

Possible values:

  • NONE
  • CURRENT_VERSION
  • MINOR_VERSION
  • MAJOR_VERSION

--description (string)

A description of the environment update.

--environment-account-connection-id (string)

The ID of the environment account connection.

You can only update to a new environment account connection if it was created in the same environment account that the current environment account connection was created in and is associated with the current environment.

--name (string)

The name of the environment to update.

--proton-service-role-arn (string)

The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make API calls to other services your behalf.

--spec (string)

The formatted specification that defines the update.

--template-major-version (string)

The ID of the major version of the environment to update.

--template-minor-version (string)

The ID of the minor version of the environment to update.

--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

environment -> (structure)

The environment detail data that's returned by AWS Proton.

arn -> (string)

The Amazon Resource Name (ARN) of the environment.

createdAt -> (timestamp)

The time when the environment was created.

deploymentStatus -> (string)

The environment deployment status.

deploymentStatusMessage -> (string)

An environment deployment status message.

description -> (string)

The description of the environment.

environmentAccountConnectionId -> (string)

The ID of the environment account connection that's used to provision infrastructure resources in an environment account.

environmentAccountId -> (string)

The ID of the environment account that the environment infrastructure resources are provisioned in.

lastDeploymentAttemptedAt -> (timestamp)

The time when a deployment of the environment was last attempted.

lastDeploymentSucceededAt -> (timestamp)

The time when the environment was last deployed successfully.

name -> (string)

The name of the environment.

protonServiceRoleArn -> (string)

The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf.

provisioning -> (string)

When included, indicates that the environment template is for customer provisioned and managed infrastructure.

spec -> (string)

The environment spec.

templateMajorVersion -> (string)

The ID of the major version of the environment template.

templateMinorVersion -> (string)

The ID of the minor version of the environment template.

templateName -> (string)

The Amazon Resource Name (ARN) of the environment template.