Class UpdateEnvironmentRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Request to update an environment.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
The name of the application with which the environment is associated.If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.The ID of the environment to update.The name of the environment to update.The name of the group to which the target environment belongs.If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.A list of custom user-defined configuration options to remove from the configuration set for this environment.This specifies the platform version that the environment will run after the environment is updated.If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment.getTier()
This specifies the tier to use to update the environment.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.toString()
Returns a string representation of this object; useful for testing and debugging.withApplicationName
(String applicationName) The name of the application with which the environment is associated.withDescription
(String description) If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.withEnvironmentId
(String environmentId) The ID of the environment to update.withEnvironmentName
(String environmentName) The name of the environment to update.withGroupName
(String groupName) The name of the group to which the target environment belongs.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.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.withOptionsToRemove
(OptionSpecification... optionsToRemove) A list of custom user-defined configuration options to remove from the configuration set for this environment.withOptionsToRemove
(Collection<OptionSpecification> optionsToRemove) A list of custom user-defined configuration options to remove from the configuration set for this environment.withSolutionStackName
(String solutionStackName) This specifies the platform version that the environment will run after the environment is updated.withTemplateName
(String templateName) If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment.withTier
(EnvironmentTier tier) This specifies the tier to use to update the environment.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
-
Constructor Details
-
UpdateEnvironmentRequest
public UpdateEnvironmentRequest()
-
-
Method Details
-
setApplicationName
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
The name of the application with which the environment is associated.
- Returns:
- The name of the application with which the environment is associated.
-
withApplicationName
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-