@Generated(value="software.amazon.awssdk:codegen") public final class UpdateEnvironmentRequest extends ElasticBeanstalkRequest implements ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>
Request to update an environment.
Modifier and Type | Class and Description |
---|---|
static interface |
UpdateEnvironmentRequest.Builder |
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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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()
Take this object and create a builder that contains all of the current property values of this object.
|
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.
|
overrideConfiguration
copy
public final String applicationName()
The name of the application with which the environment is associated.
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.
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.
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.
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.
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.
public final String description()
If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
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.
Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns
InvalidParameterValue
error.
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.
InvalidParameterValue
error.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.
InvalidParameterValue
error.public final String solutionStackName()
This specifies the platform version that the environment will run after the environment is updated.
public final String platformArn()
The ARN of the platform, if used.
public final boolean hasOptionSettings()
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.
public final boolean hasOptionsToRemove()
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.
public UpdateEnvironmentRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>
toBuilder
in class ElasticBeanstalkRequest
public static UpdateEnvironmentRequest.Builder builder()
public static Class<? extends UpdateEnvironmentRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.