Package software.amazon.awssdk.services.elasticbeanstalk.model

Class UpdateEnvironmentRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.elasticbeanstalk.model.UpdateEnvironmentRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

@Generated("software.amazon.awssdk:codegen")
public class UpdateEnvironmentRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

Request to update an environment.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateEnvironmentRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	applicationName()	The name of the application with which the environment is associated.
static UpdateEnvironmentRequest.Builder	builder()
String	description()	If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
String	environmentId()	The ID of the environment to update.
String	environmentName()	The name of the environment to update.
boolean	equals(Object obj)
String	groupName()	The name of the group to which the target environment belongs.
int	hashCode()
List<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.
List<OptionSpecification>	optionsToRemove()	A list of custom user-defined configuration options to remove from the configuration set for this environment.
String	platformArn()	The ARN of the platform, if used.
static Class<? extends UpdateEnvironmentRequest.Builder>	serializableBuilderClass()
String	solutionStackName()	This specifies the platform version that the environment will run after the environment is updated.
String	templateName()	If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment.
EnvironmentTier	tier()	This specifies the tier to use to update the environment.
UpdateEnvironmentRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	versionLabel()	If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

applicationName

public String applicationName()

The name of the application with which the environment is associated.

Returns:

The name of the application with which the environment is associated.

environmentId

public 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:

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

public 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:

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.

groupName

public 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.

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.

description

public String description()

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.

tier

public 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.

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.

versionLabel

public 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:

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.

templateName

public 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:

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.

solutionStackName

public String solutionStackName()

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.

platformArn

public String platformArn()

The ARN of the platform, if used.

Returns:

The ARN of the platform, if used.

optionSettings

public List<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:

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

public List<OptionSpecification> optionsToRemove()

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.

toBuilder

public UpdateEnvironmentRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

Returns:

a builder for type T

builder

public static UpdateEnvironmentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateEnvironmentRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object