AWS SDK for .NET Documentation
UpdateEnvironmentRequest Class
AmazonAmazon.ElasticBeanstalk.ModelUpdateEnvironmentRequest Did this page help you?   Yes   No    Tell us about it...
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

CopyC#
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

CopyC#
DeploymentStatus
values.

Declaration Syntax
C#
public class UpdateEnvironmentRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
UpdateEnvironmentRequest()()()()
Initializes a new instance of the UpdateEnvironmentRequest class

Description
Gets and sets the property Description.

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


EnvironmentId
Gets and sets the property EnvironmentId.

The ID of the environment to update.

If no environment with this ID exists, AWS Elastic Beanstalk returns an

CopyC#
InvalidParameterValue
error.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns

CopyC#
MissingRequiredParameter
error.


EnvironmentName
Gets and sets the property EnvironmentName.

The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an

CopyC#
InvalidParameterValue
error.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns

CopyC#
MissingRequiredParameter
error.


Equals(Object)
Determines whether the specified Object is equal to the current 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
Gets and sets the property 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
Gets and sets the property OptionsToRemove.

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


TemplateName
Gets and sets the property 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

CopyC#
InvalidParameterValue
error.


Tier
Gets and sets the property Tier.

This specifies the tier to use to update the environment.

Condition: You can only update the tier version for an environment. If you change the name of the type, AWS Elastic Beanstalk returns

CopyC#
InvalidParameterValue
error.


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
VersionLabel
Gets and sets the property 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

CopyC#
InvalidParameterValue
error.


WithDescription(String) Obsolete.
Sets the Description property

WithEnvironmentId(String) Obsolete.
Sets the EnvironmentId property

WithEnvironmentName(String) Obsolete.
Sets the EnvironmentName property

WithOptionSettings(array<ConfigurationOptionSetting>[]()[][]) Obsolete.
Sets the OptionSettings property

WithOptionSettings(IEnumerable<(Of <<'(ConfigurationOptionSetting>)>>)) Obsolete.
Sets the OptionSettings property

WithOptionsToRemove(array<OptionSpecification>[]()[][]) Obsolete.
Sets the OptionsToRemove property

WithOptionsToRemove(IEnumerable<(Of <<'(OptionSpecification>)>>)) Obsolete.
Sets the OptionsToRemove property

WithTemplateName(String) Obsolete.
Sets the TemplateName property

WithTier(EnvironmentTier) Obsolete.
Sets the Tier property

WithVersionLabel(String) Obsolete.
Sets the VersionLabel property

Inheritance Hierarchy
Object
AmazonWebServiceRequest
 UpdateEnvironmentRequest

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)