<a id="cli-aws-proton-update-environment"></a>

# update-environment

## Description

Update an environment.

If the environment is associated with an environment account connection, *don’t* update or include the `protonServiceRoleArn` and `provisioningRepository` parameter to update or connect to an environment account connection.

You can only update to a new environment account connection if that connection was created in the same environment account that the current environment account connection was created in. The account connection must also be associated with the current environment.

If the environment *isn’t* associated with an environment account connection, *don’t* update or include the `environmentAccountConnectionId` parameter. You *can’t* update or connect the environment to an environment account connection if it *isn’t* already associated with an environment connection.

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

If the environment was configured for Amazon Web Services-managed provisioning, omit the `provisioningRepository` parameter.

If the environment was configured for self-managed provisioning, specify the `provisioningRepository` parameter and omit the `protonServiceRoleArn` and `environmentAccountConnectionId` parameters.

For more information, see [Environments](https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html) and [Provisioning methods](https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html) in the *Proton User Guide* .

There are four modes for updating an environment. 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.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironment)

## Synopsis

```
  update-environment
[--codebuild-role-arn <value>]
[--component-role-arn <value>]
--deployment-type <value>
[--description <value>]
[--environment-account-connection-id <value>]
--name <value>
[--proton-service-role-arn <value>]
[--provisioning-repository <value>]
[--spec <value>]
[--template-major-version <value>]
[--template-minor-version <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
```

## Options

`--codebuild-role-arn` (string)

> The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

> Constraints:

> * min: `1`
> * max: `2048`
> * pattern: `^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$`

`--component-role-arn` (string)

> The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

> The environment must have a `componentRoleArn` to allow directly defined components to be associated with the environment.

> For more information about components, see [Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the *Proton User Guide* .

> Constraints:

> * min: `1`
> * max: `2048`
> * pattern: `^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$`

`--deployment-type` (string) [required]

> There are four modes for updating an environment. 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 major or minor 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.

> Constraints:

> * min: `0`
> * max: `500`

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

> Constraints:

> * pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`

`--name` (string) [required]

> The name of the environment to update.

> Constraints:

> * min: `1`
> * max: `100`
> * pattern: `^[0-9A-Za-z]+[0-9A-Za-z_\-]*$`

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

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

> Constraints:

> * min: `1`
> * max: `200`
> * pattern: `^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+$`

`--provisioning-repository` (structure)

> The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see  CreateRepository .

> branch -> (string) [required]

> > The repository branch.

> > Constraints:

> > * min: `1`
> > * max: `200`

> name -> (string) [required]

> > The repository name.

> > Constraints:

> > * min: `1`
> > * max: `100`
> > * pattern: `[A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*`

> provider -> (string) [required]

> > The repository provider.

> > Possible values:

> > * `GITHUB`
> > * `GITHUB_ENTERPRISE`
> > * `BITBUCKET`

Shorthand Syntax:

```
branch=string,name=string,provider=string
```

JSON Syntax:

```json
{
  "branch": "string",
  "name": "string",
  "provider": "GITHUB"|"GITHUB_ENTERPRISE"|"BITBUCKET"
}
```

`--spec` (string)

> The formatted specification that defines the update.

> Constraints:

> * min: `1`
> * max: `51200`

`--template-major-version` (string)

> The major version of the environment to update.

> Constraints:

> * min: `1`
> * max: `20`
> * pattern: `^(0|([1-9]{1}\d*))$`

`--template-minor-version` (string)

> The minor version of the environment to update.

> Constraints:

> * min: `1`
> * max: `20`
> * pattern: `^(0|([1-9]{1}\d*))$`

`--cli-input-json` | `--cli-input-yaml` (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those 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. This may not be specified along with `--cli-input-yaml`.

`--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`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Output

environment -> (structure)

> The environment detail data that’s returned by Proton.

> arn -> (string) [required]

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

> codebuildRoleArn -> (string)

> > The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.

> > Constraints:

> > * min: `1`
> > * max: `2048`
> > * pattern: `^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$`

> componentRoleArn -> (string)

> > The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.

> > The environment must have a `componentRoleArn` to allow directly defined components to be associated with the environment.

> > For more information about components, see [Proton components](https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html) in the *Proton User Guide* .

> > Constraints:

> > * min: `1`
> > * max: `2048`
> > * pattern: `^arn:(aws|aws-cn|aws-us-gov):iam::\d{12}:role/([\w+=,.@-]{1,512}[/:])*([\w+=,.@-]{1,64})$`

> createdAt -> (timestamp) [required]

> > The time when the environment was created.

> deploymentStatus -> (string) [required]

> > The environment deployment status.

> > Possible values:

> > * `IN_PROGRESS`
> > * `FAILED`
> > * `SUCCEEDED`
> > * `DELETE_IN_PROGRESS`
> > * `DELETE_FAILED`
> > * `DELETE_COMPLETE`
> > * `CANCELLING`
> > * `CANCELLED`

> deploymentStatusMessage -> (string)

> > An environment deployment status message.

> description -> (string)

> > The description of the environment.

> > Constraints:

> > * min: `0`
> > * max: `500`

> environmentAccountConnectionId -> (string)

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

> > Constraints:

> > * pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`

> environmentAccountId -> (string)

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

> > Constraints:

> > * pattern: `^\d{12}$`

> lastAttemptedDeploymentId -> (string)

> > The ID of the last attempted deployment of this environment.

> > Constraints:

> > * pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`

> lastDeploymentAttemptedAt -> (timestamp) [required]

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

> lastDeploymentSucceededAt -> (timestamp) [required]

> > The time when the environment was last deployed successfully.

> lastSucceededDeploymentId -> (string)

> > The ID of the last successful deployment of this environment.

> > Constraints:

> > * pattern: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`

> name -> (string) [required]

> > The name of the environment.

> > Constraints:

> > * min: `1`
> > * max: `100`
> > * pattern: `^[0-9A-Za-z]+[0-9A-Za-z_\-]*$`

> protonServiceRoleArn -> (string)

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

> > Constraints:

> > * min: `1`
> > * max: `200`
> > * pattern: `^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+$`

> provisioning -> (string)

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

> > Possible values:

> > * `CUSTOMER_MANAGED`

> provisioningRepository -> (structure)

> > The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see [CreateRepository](https://docs.aws.amazon.com/proton/latest/APIReference/API_CreateRepository.html) .

> > arn -> (string) [required]

> > > The Amazon Resource Name (ARN) of the linked repository.

> > branch -> (string) [required]

> > > The repository branch.

> > > Constraints:

> > > * min: `1`
> > > * max: `200`

> > name -> (string) [required]

> > > The repository name.

> > > Constraints:

> > > * min: `1`
> > > * max: `100`
> > > * pattern: `[A-Za-z0-9_.-].*/[A-Za-z0-9_.-].*`

> > provider -> (string) [required]

> > > The repository provider.

> > > Possible values:

> > > * `GITHUB`
> > > * `GITHUB_ENTERPRISE`
> > > * `BITBUCKET`

> spec -> (string)

> > The environment spec.

> > Constraints:

> > * min: `1`
> > * max: `51200`

> templateMajorVersion -> (string) [required]

> > The major version of the environment template.

> > Constraints:

> > * min: `1`
> > * max: `20`
> > * pattern: `^(0|([1-9]{1}\d*))$`

> templateMinorVersion -> (string) [required]

> > The minor version of the environment template.

> > Constraints:

> > * min: `1`
> > * max: `20`
> > * pattern: `^(0|([1-9]{1}\d*))$`

> templateName -> (string) [required]

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

> > Constraints:

> > * min: `1`
> > * max: `100`
> > * pattern: `^[0-9A-Za-z]+[0-9A-Za-z_\-]*$`