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

Interface UpdateEnvironmentRequest.Builder

All Superinterfaces:

CopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>, SdkBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

Enclosing class:

UpdateEnvironmentRequest

public static interface UpdateEnvironmentRequest.Builder
extends CopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

Method Summary

Modifier and Type	Method	Description
UpdateEnvironmentRequest.Builder	applicationName(String applicationName)	The name of the application with which the environment is associated.
UpdateEnvironmentRequest.Builder	description(String description)	If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
UpdateEnvironmentRequest.Builder	environmentId(String environmentId)	The ID of the environment to update.
UpdateEnvironmentRequest.Builder	environmentName(String environmentName)	The name of the environment to update.
UpdateEnvironmentRequest.Builder	groupName(String groupName)	The name of the group to which the target environment belongs.
UpdateEnvironmentRequest.Builder	optionSettings(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.Builder	optionSettings(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.Builder	optionsToRemove(Collection<OptionSpecification> optionsToRemove)	A list of custom user-defined configuration options to remove from the configuration set for this environment.
UpdateEnvironmentRequest.Builder	optionsToRemove(OptionSpecification... optionsToRemove)	A list of custom user-defined configuration options to remove from the configuration set for this environment.
UpdateEnvironmentRequest.Builder	platformArn(String platformArn)	The ARN of the platform, if used.
UpdateEnvironmentRequest.Builder	solutionStackName(String solutionStackName)	This specifies the platform version that the environment will run after the environment is updated.
UpdateEnvironmentRequest.Builder	templateName(String templateName)	If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment.
UpdateEnvironmentRequest.Builder	tier(EnvironmentTier tier)	This specifies the tier to use to update the environment.
UpdateEnvironmentRequest.Builder	versionLabel(String versionLabel)	If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

applicationName

UpdateEnvironmentRequest.Builder applicationName(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.

environmentId

UpdateEnvironmentRequest.Builder environmentId(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.

environmentName

UpdateEnvironmentRequest.Builder environmentName(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 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:

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

groupName

UpdateEnvironmentRequest.Builder groupName(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.

description

UpdateEnvironmentRequest.Builder description(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.

tier

UpdateEnvironmentRequest.Builder tier(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.

versionLabel

UpdateEnvironmentRequest.Builder versionLabel(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 an InvalidParameterValue error.

Returns:

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

templateName

UpdateEnvironmentRequest.Builder templateName(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 an InvalidParameterValue error.

Returns:

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

solutionStackName

UpdateEnvironmentRequest.Builder solutionStackName(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.

platformArn

UpdateEnvironmentRequest.Builder platformArn(String platformArn)

The ARN of the platform, if used.

Parameters:

platformArn - The ARN of the platform, if used.

Returns:

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

optionSettings

UpdateEnvironmentRequest.Builder optionSettings(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.

optionSettings

UpdateEnvironmentRequest.Builder optionSettings(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) or #withOptionSettings(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.

optionsToRemove

UpdateEnvironmentRequest.Builder optionsToRemove(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.

optionsToRemove

UpdateEnvironmentRequest.Builder optionsToRemove(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) or #withOptionsToRemove(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.