UpdateEnvironmentMessage

import type { UpdateEnvironmentMessage } from "https://aws-api.deno.dev/v0.4/services/elasticbeanstalk.ts?docs=full";

Request to update an environment.

interface UpdateEnvironmentMessage {

ApplicationName?: string | null;

Description?: string | null;

EnvironmentId?: string | null;

EnvironmentName?: string | null;

GroupName?: string | null;

OptionSettings?: ConfigurationOptionSetting[] | null;

OptionsToRemove?: OptionSpecification[] | null;

PlatformArn?: string | null;

SolutionStackName?: string | null;

TemplateName?: string | null;

Tier?: EnvironmentTier | null;

VersionLabel?: string | null;

}

§Properties

ApplicationName?: string | null

[src]

The name of the application with which the environment is associated.

Description?: string | null

[src]

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

EnvironmentId?: string | null

[src]

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.

EnvironmentName?: string | null

[src]

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.

GroupName?: string | null

[src]

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) for details.

OptionSettings?: ConfigurationOptionSetting[] | null

[src]

If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

OptionsToRemove?: OptionSpecification[] | null

[src]

A list of custom user-defined configuration options to remove from the configuration set for this environment.

PlatformArn?: string | null

[src]

The ARN of the platform, if used.

SolutionStackName?: string | null

[src]

This specifies the platform version that the environment will run after the environment is updated.

TemplateName?: string | null

[src]

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.

Tier?: EnvironmentTier | null

[src]

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.

VersionLabel?: string | null

[src]

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.