com.amazonaws.services.autoscaling.model

## クラス SetDesiredCapacityRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.autoscaling.model.SetDesiredCapacityRequest

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

      public class SetDesiredCapacityRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `SetDesiredCapacity operation`.

  Adjusts the desired size of the AutoScalingGroup by initiating scaling activities. When reducing the size of the group, it is not possible to define which Amazon EC2 instances will be terminated. This applies to any Auto Scaling decisions that might result in terminating instances.

  There are two common use cases for `SetDesiredCapacity` : one for users of the Auto Scaling triggering system, and another for developers who write their own triggering systems. Both use cases relate to the concept of cooldown.

  In the first case, if you use the Auto Scaling triggering system, `SetDesiredCapacity` changes the size of your Auto Scaling group without regard to the cooldown period. This could be useful, for example, if Auto Scaling did something unexpected for some reason. If your cooldown period is 10 minutes, Auto Scaling would normally reject requests to change the size of the group for that entire 10-minute period. The `SetDesiredCapacity` command allows you to circumvent this restriction and change the size of the group before the end of the cooldown period.

  In the second case, if you write your own triggering system, you can use `SetDesiredCapacity` to control the size of your Auto Scaling group. If you want the same cooldown functionality that Auto Scaling offers, you can configure `SetDesiredCapacity` to honor cooldown by setting the `HonorCooldown` parameter to `true` .

  関連項目:
    `AmazonAutoScaling.setDesiredCapacity(SetDesiredCapacityRequest)`, 直列化された形式

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

    コンストラクタ
    コンストラクタと説明
    `SetDesiredCapacityRequest()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getAutoScalingGroupName()` The name of the Auto Scaling group.
    `java.lang.Integer` | `getDesiredCapacity()` The new capacity setting for the Auto Scaling group.
    `java.lang.Boolean` | `getHonorCooldown()` By default, `SetDesiredCapacity` overrides any cooldown period.
    `int` | `hashCode()`
    `java.lang.Boolean` | `isHonorCooldown()` By default, `SetDesiredCapacity` overrides any cooldown period.
    `void` | `setAutoScalingGroupName(java.lang.String autoScalingGroupName)` The name of the Auto Scaling group.
    `void` | `setDesiredCapacity(java.lang.Integer desiredCapacity)` The new capacity setting for the Auto Scaling group.
    `void` | `setHonorCooldown(java.lang.Boolean honorCooldown)` By default, `SetDesiredCapacity` overrides any cooldown period.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `SetDesiredCapacityRequest` | `withAutoScalingGroupName(java.lang.String autoScalingGroupName)` The name of the Auto Scaling group.
    `SetDesiredCapacityRequest` | `withDesiredCapacity(java.lang.Integer desiredCapacity)` The new capacity setting for the Auto Scaling group.
    `SetDesiredCapacityRequest` | `withHonorCooldown(java.lang.Boolean honorCooldown)` By default, `SetDesiredCapacity` overrides any cooldown period.

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

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### SetDesiredCapacityRequest

          public SetDesiredCapacityRequest()

  - ### メソッドの詳細

    - #### getAutoScalingGroupName

          public java.lang.String getAutoScalingGroupName()

      The name of the Auto Scaling group.

      Constraints:
      Length: 1 - 1600
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      戻り値:
        The name of the Auto Scaling group.

    - #### setAutoScalingGroupName

          public void setAutoScalingGroupName(java.lang.String autoScalingGroupName)

      The name of the Auto Scaling group.

      Constraints:
      Length: 1 - 1600
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `autoScalingGroupName` - The name of the Auto Scaling group.

    - #### withAutoScalingGroupName

          public SetDesiredCapacityRequest withAutoScalingGroupName(java.lang.String autoScalingGroupName)

      The name of the Auto Scaling group.

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

      Constraints:
      Length: 1 - 1600
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `autoScalingGroupName` - The name of the Auto Scaling group.

    - #### getDesiredCapacity

          public java.lang.Integer getDesiredCapacity()

      The new capacity setting for the Auto Scaling group.
      戻り値:
        The new capacity setting for the Auto Scaling group.

    - #### setDesiredCapacity

          public void setDesiredCapacity(java.lang.Integer desiredCapacity)

      The new capacity setting for the Auto Scaling group.
      パラメータ:
        `desiredCapacity` - The new capacity setting for the Auto Scaling group.

    - #### withDesiredCapacity

          public SetDesiredCapacityRequest withDesiredCapacity(java.lang.Integer desiredCapacity)

      The new capacity setting for the Auto Scaling group.

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

      パラメータ:
        `desiredCapacity` - The new capacity setting for the Auto Scaling group.

    - #### isHonorCooldown

          public java.lang.Boolean isHonorCooldown()

      By default, `SetDesiredCapacity` overrides any cooldown period. Set to `True` if you want Auto Scaling to reject this request when the Auto Scaling group is in cooldown.
      戻り値:
        By default, `SetDesiredCapacity` overrides any cooldown period. Set to `True` if you want Auto Scaling to reject this request when the Auto Scaling group is in cooldown.

    - #### setHonorCooldown

          public void setHonorCooldown(java.lang.Boolean honorCooldown)

      By default, `SetDesiredCapacity` overrides any cooldown period. Set to `True` if you want Auto Scaling to reject this request when the Auto Scaling group is in cooldown.
      パラメータ:
        `honorCooldown` - By default, `SetDesiredCapacity` overrides any cooldown period. Set to `True` if you want Auto Scaling to reject this request when the Auto Scaling group is in cooldown.

    - #### withHonorCooldown

          public SetDesiredCapacityRequest withHonorCooldown(java.lang.Boolean honorCooldown)

      By default, `SetDesiredCapacity` overrides any cooldown period. Set to `True` if you want Auto Scaling to reject this request when the Auto Scaling group is in cooldown.

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

      パラメータ:
        `honorCooldown` - By default, `SetDesiredCapacity` overrides any cooldown period. Set to `True` if you want Auto Scaling to reject this request when the Auto Scaling group is in cooldown.

    - #### getHonorCooldown

          public java.lang.Boolean getHonorCooldown()

      By default, `SetDesiredCapacity` overrides any cooldown period. Set to `True` if you want Auto Scaling to reject this request when the Auto Scaling group is in cooldown.
      戻り値:
        By default, `SetDesiredCapacity` overrides any cooldown period. Set to `True` if you want Auto Scaling to reject this request when the Auto Scaling group is in cooldown.

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