[ aws . appconfig ]

update-environment

Description

Updates an environment.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-environment
--application-id <value>
--environment-id <value>
[--name <value>]
[--description <value>]
[--monitors <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--application-id (string)

The application ID.

--environment-id (string)

The environment ID.

--name (string)

The name of the environment.

--description (string)

A description of the environment.

--monitors (list)

Amazon CloudWatch alarms to monitor during the deployment process.

(structure)

Amazon CloudWatch alarms to monitor during the deployment process.

AlarmArn -> (string)

Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.

AlarmRoleArn -> (string)

ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn .

Shorthand Syntax:

AlarmArn=string,AlarmRoleArn=string ...

JSON Syntax:

[
  {
    "AlarmArn": "string",
    "AlarmRoleArn": "string"
  }
  ...
]

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

See ‘aws help’ for descriptions of global parameters.

Examples

To update an environment

The following update-environment example updates an environment’s description.

aws appconfig update-environment \
    --application-id 339ohji \
    --environment-id 54j1r29 \
    --description "An environment for examples."

Output:

{
    "ApplicationId": "339ohji",
    "Id": "54j1r29",
    "Name": "Example-Environment",
    "Description": "An environment for examples.",
    "State": "RolledBack"
}

For more information, see Step 2: Creating an environment in the AWS AppConfig User Guide.

Output

ApplicationId -> (string)

The application ID.

Id -> (string)

The environment ID.

Name -> (string)

The name of the environment.

Description -> (string)

The description of the environment.

State -> (string)

The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT , DEPLOYING , ROLLING_BACK , or ROLLED_BACK

Monitors -> (list)

Amazon CloudWatch alarms monitored during the deployment.

(structure)

Amazon CloudWatch alarms to monitor during the deployment process.

AlarmArn -> (string)

Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.

AlarmRoleArn -> (string)

ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn .