Class UpdateEnvironmentRequest

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("software.amazon.awssdk:codegen") public final class UpdateEnvironmentRequest extends ElasticBeanstalkRequest implements ToCopyableBuilder<UpdateEnvironmentRequest.Builder,UpdateEnvironmentRequest>

Request to update an environment.

  • Method Details

    • 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()
      For responses, this returns true if the service returned a value for the OptionSettings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOptionSettings() method.

      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()
      For responses, this returns true if the service returned a value for the OptionsToRemove property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOptionsToRemove() method.

      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>
      Specified by:
      toBuilder in class ElasticBeanstalkRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends 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.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.