com.amazonaws.services.elasticbeanstalk.model
Class UpdateEnvironmentRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.elasticbeanstalk.model.UpdateEnvironmentRequest

All Implemented Interfaces:

Serializable

public class UpdateEnvironmentRequest
extends AmazonWebServiceRequest
implements Serializable

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.

See Also:

AWSElasticBeanstalk.updateEnvironment(UpdateEnvironmentRequest), Serialized Form

Constructor Summary

UpdateEnvironmentRequest()
Default constructor for a new UpdateEnvironmentRequest object.

Method Summary

boolean	equals(Object obj)
String	getDescription() If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
String	getEnvironmentId() The ID of the environment to update.
String	getEnvironmentName() The name of the environment to update.
List<ConfigurationOptionSetting>	getOptionSettings() If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
List<OptionSpecification>	getOptionsToRemove() A list of custom user-defined configuration options to remove from the configuration set for this environment.
String	getTemplateName() If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment.
String	getVersionLabel() If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment.
int	hashCode()
void	setDescription(String description) If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
void	setEnvironmentId(String environmentId) The ID of the environment to update.
void	setEnvironmentName(String environmentName) The name of the environment to update.
void	setOptionSettings(Collection<ConfigurationOptionSetting> 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.
void	setOptionsToRemove(Collection<OptionSpecification> optionsToRemove) A list of custom user-defined configuration options to remove from the configuration set for this environment.
void	setTemplateName(String templateName) If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment.
void	setVersionLabel(String versionLabel) If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateEnvironmentRequest	withDescription(String description) If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
UpdateEnvironmentRequest	withEnvironmentId(String environmentId) The ID of the environment to update.
UpdateEnvironmentRequest	withEnvironmentName(String environmentName) The name of the environment to update.
UpdateEnvironmentRequest	withOptionSettings(Collection<ConfigurationOptionSetting> 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.
UpdateEnvironmentRequest	withOptionSettings(ConfigurationOptionSetting... 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.
UpdateEnvironmentRequest	withOptionsToRemove(Collection<OptionSpecification> optionsToRemove) A list of custom user-defined configuration options to remove from the configuration set for this environment.
UpdateEnvironmentRequest	withOptionsToRemove(OptionSpecification... optionsToRemove) A list of custom user-defined configuration options to remove from the configuration set for this environment.
UpdateEnvironmentRequest	withTemplateName(String templateName) If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment.
UpdateEnvironmentRequest	withVersionLabel(String versionLabel) If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateEnvironmentRequest

public UpdateEnvironmentRequest()

Default constructor for a new UpdateEnvironmentRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

Method Detail

getEnvironmentId

public String getEnvironmentId()

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.

Returns:

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.

setEnvironmentId

public void setEnvironmentId(String 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.

Parameters:

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.

withEnvironmentId

public UpdateEnvironmentRequest withEnvironmentId(String 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getEnvironmentName

public String getEnvironmentName()

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:
Length: 4 - 23

Returns:

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.

setEnvironmentName

public void setEnvironmentName(String 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:
Length: 4 - 23

Parameters:

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.

withEnvironmentName

public UpdateEnvironmentRequest withEnvironmentName(String 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 4 - 23

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getVersionLabel

public String getVersionLabel()

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:
Length: 1 - 100

Returns:

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.

setVersionLabel

public void setVersionLabel(String 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:
Length: 1 - 100

Parameters:

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.

withVersionLabel

public UpdateEnvironmentRequest withVersionLabel(String 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getTemplateName

public String getTemplateName()

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:
Length: 1 - 100

Returns:

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.

setTemplateName

public void setTemplateName(String 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:
Length: 1 - 100

Parameters:

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.

withTemplateName

public UpdateEnvironmentRequest withTemplateName(String 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getDescription

public String getDescription()

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

Constraints:
Length: 0 - 200

Returns:

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

setDescription

public void setDescription(String description)

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

Constraints:
Length: 0 - 200

Parameters:

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

withDescription

public UpdateEnvironmentRequest withDescription(String description)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 200

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getOptionSettings

public List<ConfigurationOptionSetting> getOptionSettings()

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

Returns:

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

setOptionSettings

public void setOptionSettings(Collection<ConfigurationOptionSetting> 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.

Parameters:

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.

withOptionSettings

public UpdateEnvironmentRequest withOptionSettings(ConfigurationOptionSetting... 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

withOptionSettings

public UpdateEnvironmentRequest withOptionSettings(Collection<ConfigurationOptionSetting> 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

getOptionsToRemove

public List<OptionSpecification> getOptionsToRemove()

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

Returns:

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

setOptionsToRemove

public void setOptionsToRemove(Collection<OptionSpecification> optionsToRemove)

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

Parameters:

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

withOptionsToRemove

public UpdateEnvironmentRequest withOptionsToRemove(OptionSpecification... optionsToRemove)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

withOptionsToRemove

public UpdateEnvironmentRequest withOptionsToRemove(Collection<OptionSpecification> optionsToRemove)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object