Container for the parameters to the UpdateEnvironment operation.
Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.
Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error.
When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.
Declaration Syntax| C# |
public class UpdateEnvironmentRequest : AmazonWebServiceRequest
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | UpdateEnvironmentRequest()()()() | Initializes a new instance of the UpdateEnvironmentRequest class |
 | Description |
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
Constraints: |
| EnvironmentId |
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 |
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.
Constraints: |
| Equals(Object) | (Inherited from Object.) |
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) |
| OptionSettings |
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 |
A list of custom user-defined configuration options to remove from the configuration set for this environment.
|
| TemplateName |
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.
Constraints: |
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
| VersionLabel |
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.
Constraints: |
| WithDescription(String) |
Sets the Description property
|
| WithEnvironmentId(String) |
Sets the EnvironmentId property
|
| WithEnvironmentName(String) |
Sets the EnvironmentName property
|
| WithOptionSettings(array<ConfigurationOptionSetting>[]()[][]) |
Adds elements to the OptionSettings collection
|
| WithOptionSettings(IEnumerable<(Of <<'(ConfigurationOptionSetting>)>>)) |
Adds elements to the OptionSettings collection
|
| WithOptionsToRemove(array<OptionSpecification>[]()[][]) |
Adds elements to the OptionsToRemove collection
|
| WithOptionsToRemove(IEnumerable<(Of <<'(OptionSpecification>)>>)) |
Adds elements to the OptionsToRemove collection
|
| WithTemplateName(String) |
Sets the TemplateName property
|
| WithVersionLabel(String) |
Sets the VersionLabel property
|
Inheritance Hierarchy| Object | ||
 | AmazonWebServiceRequest | |
| UpdateEnvironmentRequest | |
