class Aws::ElasticBeanstalk::Types::UpdateEnvironmentMessage

Request to update an environment.

@note When making an API call, you may pass UpdateEnvironmentMessage

data as a hash:

    {
      application_name: "ApplicationName",
      environment_id: "EnvironmentId",
      environment_name: "EnvironmentName",
      group_name: "GroupName",
      description: "Description",
      tier: {
        name: "String",
        type: "String",
        version: "String",
      },
      version_label: "VersionLabel",
      template_name: "ConfigurationTemplateName",
      solution_stack_name: "SolutionStackName",
      platform_arn: "PlatformArn",
      option_settings: [
        {
          resource_name: "ResourceName",
          namespace: "OptionNamespace",
          option_name: "ConfigurationOptionName",
          value: "ConfigurationOptionValue",
        },
      ],
      options_to_remove: [
        {
          resource_name: "ResourceName",
          namespace: "OptionNamespace",
          option_name: "ConfigurationOptionName",
        },
      ],
    }

@!attribute [rw] application_name

The name of the application with which the environment is
associated.
@return [String]

@!attribute [rw] environment_id

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.
@return [String]

@!attribute [rw] environment_name

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.
@return [String]

@!attribute [rw] group_name

The name of the group to which the target environment belongs.
Specify a group name only if the environment's name is specified in
an environment manifest and not with the environment name or
environment ID parameters. See [Environment Manifest (env.yaml)][1]
for details.

[1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html
@return [String]

@!attribute [rw] description

If this parameter is specified, AWS Elastic Beanstalk updates the
description of this environment.
@return [String]

@!attribute [rw] tier

This specifies the tier to use to update the environment.

Condition: At this time, if you change the tier version, name, or
type, AWS Elastic Beanstalk returns `InvalidParameterValue` error.
@return [Types::EnvironmentTier]

@!attribute [rw] version_label

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.
@return [String]

@!attribute [rw] template_name

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.
@return [String]

@!attribute [rw] solution_stack_name

This specifies the platform version that the environment will run
after the environment is updated.
@return [String]

@!attribute [rw] platform_arn

The ARN of the platform, if used.
@return [String]

@!attribute [rw] option_settings

If specified, AWS Elastic Beanstalk updates the configuration set
associated with the running environment and sets the specified
configuration options to the requested value.
@return [Array<Types::ConfigurationOptionSetting>]

@!attribute [rw] options_to_remove

A list of custom user-defined configuration options to remove from
the configuration set for this environment.
@return [Array<Types::OptionSpecification>]

@see docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/UpdateEnvironmentMessage AWS API Documentation

Constants

SENSITIVE