Class UpdateEnvironmentRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.elasticbeanstalk.model.UpdateEnvironmentRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class UpdateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Request to update an environment.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description UpdateEnvironmentRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UpdateEnvironmentRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getApplicationName()
The name of the application with which the environment is associated.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.String
getGroupName()
The name of the group to which the target environment belongs.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
getSolutionStackName()
This specifies the platform version that the environment will run after the environment is updated.String
getTemplateName()
If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment.EnvironmentTier
getTier()
This specifies the tier to use to update the environment.String
getVersionLabel()
If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment.int
hashCode()
void
setApplicationName(String applicationName)
The name of the application with which the environment is associated.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
setGroupName(String groupName)
The name of the group to which the target environment belongs.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
setSolutionStackName(String solutionStackName)
This specifies the platform version that the environment will run after the environment is updated.void
setTemplateName(String templateName)
If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment.void
setTier(EnvironmentTier tier)
This specifies the tier to use to update 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
withApplicationName(String applicationName)
The name of the application with which the environment is associated.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
withGroupName(String groupName)
The name of the group to which the target environment belongs.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
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
withOptionsToRemove(OptionSpecification... optionsToRemove)
A list of custom user-defined configuration options to remove from the configuration set for this environment.UpdateEnvironmentRequest
withOptionsToRemove(Collection<OptionSpecification> optionsToRemove)
A list of custom user-defined configuration options to remove from the configuration set for this environment.UpdateEnvironmentRequest
withSolutionStackName(String solutionStackName)
This specifies the platform version that the environment will run after the environment is updated.UpdateEnvironmentRequest
withTemplateName(String templateName)
If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment.UpdateEnvironmentRequest
withTier(EnvironmentTier tier)
This specifies the tier to use to update 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
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setApplicationName
public void setApplicationName(String applicationName)
The name of the application with which the environment is associated.
- Parameters:
applicationName
- The name of the application with which the environment is associated.
-
getApplicationName
public String getApplicationName()
The name of the application with which the environment is associated.
- Returns:
- The name of the application with which the environment is associated.
-
withApplicationName
public UpdateEnvironmentRequest withApplicationName(String applicationName)
The name of the application with which the environment is associated.
- Parameters:
applicationName
- The name of the application with which the environment is associated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
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.- 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:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
environmentName
- The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns anInvalidParameterValue
error.Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns
MissingRequiredParameter
error.
-
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.- 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.
-
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.- Parameters:
environmentName
- The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns anInvalidParameterValue
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:
- Returns a reference to this object so that method calls can be chained together.
-
setGroupName
public void setGroupName(String groupName)
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.
- Parameters:
groupName
- 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.
-
getGroupName
public String getGroupName()
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.
- Returns:
- 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.
-
withGroupName
public UpdateEnvironmentRequest withGroupName(String groupName)
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.
- Parameters:
groupName
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
public void setDescription(String description)
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
- Parameters:
description
- If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
-
getDescription
public String getDescription()
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
- Returns:
- 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.
- Parameters:
description
- If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTier
public void setTier(EnvironmentTier 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.- Parameters:
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.
-
getTier
public EnvironmentTier getTier()
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.- Returns:
- 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.
-
withTier
public UpdateEnvironmentRequest withTier(EnvironmentTier 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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- 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 anInvalidParameterValue
error.
-
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.- 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.
-
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.- 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 anInvalidParameterValue
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- 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 anInvalidParameterValue
error.
-
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.- 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.
-
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.- 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 anInvalidParameterValue
error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSolutionStackName
public void setSolutionStackName(String solutionStackName)
This specifies the platform version that the environment will run after the environment is updated.
- Parameters:
solutionStackName
- This specifies the platform version that the environment will run after the environment is updated.
-
getSolutionStackName
public String getSolutionStackName()
This specifies the platform version that the environment will run after the environment is updated.
- Returns:
- This specifies the platform version that the environment will run after the environment is updated.
-
withSolutionStackName
public UpdateEnvironmentRequest withSolutionStackName(String solutionStackName)
This specifies the platform version that the environment will run after the environment is updated.
- Parameters:
solutionStackName
- This specifies the platform version that the environment will run after the environment is updated.- Returns:
- Returns a reference to this 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.
NOTE: This method appends the values to the existing list (if any). Use
setOptionSettings(java.util.Collection)
orwithOptionSettings(java.util.Collection)
if you want to override the existing values.- 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:
- Returns a reference to this 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.
- 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:
- Returns a reference to this 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.
NOTE: This method appends the values to the existing list (if any). Use
setOptionsToRemove(java.util.Collection)
orwithOptionsToRemove(java.util.Collection)
if you want to override the existing values.- Parameters:
optionsToRemove
- A list of custom user-defined configuration options to remove from the configuration set for this environment.- Returns:
- Returns a reference to this 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.
- Parameters:
optionsToRemove
- A list of custom user-defined configuration options to remove from the configuration set for this environment.- Returns:
- Returns a reference to this 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public UpdateEnvironmentRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-