com.amazonaws.services.elasticbeanstalk.model

## クラス UpdateEnvironmentRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.elasticbeanstalk.model.UpdateEnvironmentRequest

- すべての実装されたインタフェース:
    java.io.Serializable

      public class UpdateEnvironmentRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `UpdateEnvironment operation`.

  Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.

  Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an `InvalidParameterCombination` error.

  When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different `DeploymentStatus` values.

  関連項目:
    `AWSElasticBeanstalk.updateEnvironment(UpdateEnvironmentRequest)`, 直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `UpdateEnvironmentRequest()` Default constructor for a new UpdateEnvironmentRequest object.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getDescription()` If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
    `java.lang.String` | `getEnvironmentId()` The ID of the environment to update.
    `java.lang.String` | `getEnvironmentName()` The name of the environment to update.
    `java.util.List<ConfigurationOptionSetting>` | `getOptionSettings()` If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
    `java.util.List<OptionSpecification>` | `getOptionsToRemove()` A list of custom user-defined configuration options to remove from the configuration set for this environment.
    `java.lang.String` | `getTemplateName()` If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment.
    `java.lang.String` | `getVersionLabel()` If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment.
    `int` | `hashCode()`
    `void` | `setDescription(java.lang.String description)` If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
    `void` | `setEnvironmentId(java.lang.String environmentId)` The ID of the environment to update.
    `void` | `setEnvironmentName(java.lang.String environmentName)` The name of the environment to update.
    `void` | `setOptionSettings(java.util.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.
    `void` | `setOptionsToRemove(java.util.Collection<OptionSpecification> optionsToRemove)` A list of custom user-defined configuration options to remove from the configuration set for this environment.
    `void` | `setTemplateName(java.lang.String templateName)` If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment.
    `void` | `setVersionLabel(java.lang.String versionLabel)` If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `UpdateEnvironmentRequest` | `withDescription(java.lang.String description)` If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
    `UpdateEnvironmentRequest` | `withEnvironmentId(java.lang.String environmentId)` The ID of the environment to update.
    `UpdateEnvironmentRequest` | `withEnvironmentName(java.lang.String environmentName)` The name of the environment to update.
    `UpdateEnvironmentRequest` | `withOptionSettings(java.util.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` | `withOptionSettings(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` | `withOptionsToRemove(java.util.Collection<OptionSpecification> optionsToRemove)` A list of custom user-defined configuration options to remove from the configuration set for this environment.
    `UpdateEnvironmentRequest` | `withOptionsToRemove(OptionSpecification... optionsToRemove)` A list of custom user-defined configuration options to remove from the configuration set for this environment.
    `UpdateEnvironmentRequest` | `withTemplateName(java.lang.String templateName)` If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment.
    `UpdateEnvironmentRequest` | `withVersionLabel(java.lang.String versionLabel)` If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### UpdateEnvironmentRequest

          public UpdateEnvironmentRequest()

      Default constructor for a new UpdateEnvironmentRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

  - ### メソッドの詳細

    - #### getEnvironmentId

          public java.lang.String getEnvironmentId()

      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.

      戻り値:
        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.

    - #### setEnvironmentId

          public void setEnvironmentId(java.lang.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.

      パラメータ:
        `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.

    - #### withEnvironmentId

          public UpdateEnvironmentRequest withEnvironmentId(java.lang.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 a reference to this object so that method calls can be chained together.

      パラメータ:
        `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.

    - #### getEnvironmentName

          public java.lang.String getEnvironmentName()

      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.

      Constraints:
      Length: 4 - 23

      戻り値:
        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.

    - #### setEnvironmentName

          public void setEnvironmentName(java.lang.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.

      Constraints:
      Length: 4 - 23

      パラメータ:
        `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.

    - #### withEnvironmentName

          public UpdateEnvironmentRequest withEnvironmentName(java.lang.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 a reference to this object so that method calls can be chained together.

      Constraints:
      Length: 4 - 23

      パラメータ:
        `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.

    - #### getVersionLabel

          public java.lang.String getVersionLabel()

      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.

      Constraints:
      Length: 1 - 100

      戻り値:
        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.

    - #### setVersionLabel

          public void setVersionLabel(java.lang.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.

      Constraints:
      Length: 1 - 100

      パラメータ:
        `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.

    - #### withVersionLabel

          public UpdateEnvironmentRequest withVersionLabel(java.lang.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 a reference to this object so that method calls can be chained together.

      Constraints:
      Length: 1 - 100

      パラメータ:
        `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.

    - #### getTemplateName

          public java.lang.String getTemplateName()

      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.

      Constraints:
      Length: 1 - 100

      戻り値:
        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.

    - #### setTemplateName

          public void setTemplateName(java.lang.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.

      Constraints:
      Length: 1 - 100

      パラメータ:
        `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.

    - #### withTemplateName

          public UpdateEnvironmentRequest withTemplateName(java.lang.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 a reference to this object so that method calls can be chained together.

      Constraints:
      Length: 1 - 100

      パラメータ:
        `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.

    - #### getDescription

          public java.lang.String getDescription()

      If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

      Constraints:
      Length: 0 - 200

      戻り値:
        If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

    - #### setDescription

          public void setDescription(java.lang.String description)

      If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

      Constraints:
      Length: 0 - 200

      パラメータ:
        `description` - If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

    - #### withDescription

          public UpdateEnvironmentRequest withDescription(java.lang.String description)

      If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

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

      Constraints:
      Length: 0 - 200

      パラメータ:
        `description` - If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

    - #### getOptionSettings

          public java.util.List<ConfigurationOptionSetting> getOptionSettings()

      If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
      戻り値:
        If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

    - #### setOptionSettings

          public void setOptionSettings(java.util.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.
      パラメータ:
        `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.

    - #### withOptionSettings

          public UpdateEnvironmentRequest withOptionSettings(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 a reference to this object so that method calls can be chained together.

      パラメータ:
        `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.

    - #### withOptionSettings

          public UpdateEnvironmentRequest withOptionSettings(java.util.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.

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

      パラメータ:
        `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.

    - #### getOptionsToRemove

          public java.util.List<OptionSpecification> getOptionsToRemove()

      A list of custom user-defined configuration options to remove from the configuration set for this environment.
      戻り値:
        A list of custom user-defined configuration options to remove from the configuration set for this environment.

    - #### setOptionsToRemove

          public void setOptionsToRemove(java.util.Collection<OptionSpecification> optionsToRemove)

      A list of custom user-defined configuration options to remove from the configuration set for this environment.
      パラメータ:
        `optionsToRemove` - A list of custom user-defined configuration options to remove from the configuration set for this environment.

    - #### withOptionsToRemove

          public UpdateEnvironmentRequest withOptionsToRemove(OptionSpecification... optionsToRemove)

      A list of custom user-defined configuration options to remove from the configuration set for this environment.

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

      パラメータ:
        `optionsToRemove` - A list of custom user-defined configuration options to remove from the configuration set for this environment.

    - #### withOptionsToRemove

          public UpdateEnvironmentRequest withOptionsToRemove(java.util.Collection<OptionSpecification> optionsToRemove)

      A list of custom user-defined configuration options to remove from the configuration set for this environment.

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

      パラメータ:
        `optionsToRemove` - A list of custom user-defined configuration options to remove from the configuration set for this environment.

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`