com.amazonaws.services.elasticbeanstalk.model

## クラス TerminateEnvironmentRequest

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

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

      public class TerminateEnvironmentRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `TerminateEnvironment operation`.

  Terminates the specified environment.

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

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getEnvironmentId()` The ID of the environment to terminate.
    `java.lang.String` | `getEnvironmentName()` The name of the environment to terminate.
    `java.lang.Boolean` | `getTerminateResources()` Indicates whether the associated AWS resources should shut down when the environment is terminated: `true`: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment.
    `int` | `hashCode()`
    `java.lang.Boolean` | `isTerminateResources()` Indicates whether the associated AWS resources should shut down when the environment is terminated: `true`: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment.
    `void` | `setEnvironmentId(java.lang.String environmentId)` The ID of the environment to terminate.
    `void` | `setEnvironmentName(java.lang.String environmentName)` The name of the environment to terminate.
    `void` | `setTerminateResources(java.lang.Boolean terminateResources)` Indicates whether the associated AWS resources should shut down when the environment is terminated: `true`: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `TerminateEnvironmentRequest` | `withEnvironmentId(java.lang.String environmentId)` The ID of the environment to terminate.
    `TerminateEnvironmentRequest` | `withEnvironmentName(java.lang.String environmentName)` The name of the environment to terminate.
    `TerminateEnvironmentRequest` | `withTerminateResources(java.lang.Boolean terminateResources)` Indicates whether the associated AWS resources should shut down when the environment is terminated: `true`: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment.

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

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### TerminateEnvironmentRequest

          public TerminateEnvironmentRequest()

      Default constructor for a new TerminateEnvironmentRequest 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 terminate.

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

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

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

        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 TerminateEnvironmentRequest withEnvironmentId(java.lang.String environmentId)

      The ID of the environment to terminate.

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

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

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

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

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

        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 TerminateEnvironmentRequest withEnvironmentName(java.lang.String environmentName)

      The name of the environment to terminate.

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

        Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns `MissingRequiredParameter` error.

    - #### isTerminateResources

          public java.lang.Boolean isTerminateResources()

      Indicates whether the associated AWS resources should shut down when the environment is terminated:

      `true`: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment.

      `false`: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate.

      - `true`: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
      - `false`: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

      For more information, see the AWS Elastic Beanstalk User Guide.

      Default: `true`

      Valid Values: `true` | `false`

      戻り値:
        Indicates whether the associated AWS resources should shut down when the environment is terminated:

        `true`: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment.

        `false`: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate.

        - `true`: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
        - `false`: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

        For more information, see the AWS Elastic Beanstalk User Guide.

        Default: `true`

        Valid Values: `true` | `false`

    - #### setTerminateResources

          public void setTerminateResources(java.lang.Boolean terminateResources)

      Indicates whether the associated AWS resources should shut down when the environment is terminated:

      `true`: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment.

      `false`: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate.

      - `true`: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
      - `false`: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

      For more information, see the AWS Elastic Beanstalk User Guide.

      Default: `true`

      Valid Values: `true` | `false`

      パラメータ:
        `terminateResources` - Indicates whether the associated AWS resources should shut down when the environment is terminated:

        `true`: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment.

        `false`: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate.

        - `true`: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
        - `false`: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

        For more information, see the AWS Elastic Beanstalk User Guide.

        Default: `true`

        Valid Values: `true` | `false`

    - #### withTerminateResources

          public TerminateEnvironmentRequest withTerminateResources(java.lang.Boolean terminateResources)

      Indicates whether the associated AWS resources should shut down when the environment is terminated:

      `true`: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment.

      `false`: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate.

      - `true`: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
      - `false`: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

      For more information, see the AWS Elastic Beanstalk User Guide.

      Default: `true`

      Valid Values: `true` | `false`

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

      パラメータ:
        `terminateResources` - Indicates whether the associated AWS resources should shut down when the environment is terminated:

        `true`: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment.

        `false`: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate.

        - `true`: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
        - `false`: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

        For more information, see the AWS Elastic Beanstalk User Guide.

        Default: `true`

        Valid Values: `true` | `false`

    - #### getTerminateResources

          public java.lang.Boolean getTerminateResources()

      Indicates whether the associated AWS resources should shut down when the environment is terminated:

      `true`: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment.

      `false`: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate.

      - `true`: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
      - `false`: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

      For more information, see the AWS Elastic Beanstalk User Guide.

      Default: `true`

      Valid Values: `true` | `false`

      戻り値:
        Indicates whether the associated AWS resources should shut down when the environment is terminated:

        `true`: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment.

        `false`: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate.

        - `true`: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.
        - `false`: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

        For more information, see the AWS Elastic Beanstalk User Guide.

        Default: `true`

        Valid Values: `true` | `false`

    - #### 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`