UpdateEnvironmentRequest (AWS Java SDK :: Services :: AWS Elastic Beanstalk 2.16.77 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.elasticbeanstalk.model.ElasticBeanstalkRequest
    - - software.amazon.awssdk.services.elasticbeanstalk.model.UpdateEnvironmentRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

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

Request to update an environment.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateEnvironmentRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UpdateEnvironmentRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`groupName()` The name of the group to which the target environment belongs.
`int`	`hashCode()`
`boolean`	`hasOptionSettings()` Returns true if the OptionSettings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasOptionsToRemove()` Returns true if the OptionsToRemove property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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.
`List<SdkField<?>>`	`sdkFields()`
`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()`
`String`	`toString()` Returns a string representation of this object.
`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.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - applicationName
```
public final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final String platformArn()
```
    The ARN of the platform, if used.
    
    Returns:
    
    The ARN of the platform, if used.
  - hasOptionSettings
```
public final boolean hasOptionSettings()
```
    Returns true if the OptionSettings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - optionSettings
```
public final 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasOptionSettings() to see if a value was sent in this field.
    
    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.
  - hasOptionsToRemove
```
public final boolean hasOptionsToRemove()
```
    Returns true if the OptionsToRemove property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - optionsToRemove
```
public final List<OptionSpecification> optionsToRemove()
```
    A list of custom user-defined configuration options to remove from the configuration set for this environment.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasOptionsToRemove() to see if a value was sent in this field.
    
    Returns:
    
    A list of custom user-defined configuration options to remove from the configuration set for this environment.
  - toBuilder
```
public UpdateEnvironmentRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>
    
    Specified by:
    
    toBuilder in class ElasticBeanstalkRequest
  - builder
```
public static UpdateEnvironmentRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateEnvironmentRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateEnvironmentRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

applicationName

environmentId

environmentName

groupName

description

tier

versionLabel

templateName

solutionStackName

platformArn

hasOptionSettings

optionSettings

hasOptionsToRemove

optionsToRemove

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields