com.amazonaws.services.autoscaling.model.TerminateInstanceInAutoScalingGroupRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.autoscaling.model;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.autoscaling.AmazonAutoScaling#terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest) TerminateInstanceInAutoScalingGroup operation}.
*
* Terminates the specified instance. Optionally, the desired group size
* can be adjusted.
*
*
* NOTE: This call simply registers a termination request. The
* termination of the instance cannot happen immediately.
*
*
* @see com.amazonaws.services.autoscaling.AmazonAutoScaling#terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest)
*/
public class TerminateInstanceInAutoScalingGroupRequest extends AmazonWebServiceRequest {
/**
* The ID of the EC2 instance to be terminated.
*
* Constraints:
* Length: 1 - 16
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*/
private String instanceId;
/**
* Specifies whether (true) or not (false) terminating this
* instance should also decrement the size of the
* AutoScalingGroup.
*/
private Boolean shouldDecrementDesiredCapacity;
/**
* The ID of the EC2 instance to be terminated.
*
* Constraints:
* Length: 1 - 16
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @return The ID of the EC2 instance to be terminated.
*/
public String getInstanceId() {
return instanceId;
}
/**
* The ID of the EC2 instance to be terminated.
*
* Constraints:
* Length: 1 - 16
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param instanceId The ID of the EC2 instance to be terminated.
*/
public void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
/**
* The ID of the EC2 instance to be terminated.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 16
* Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
*
* @param instanceId The ID of the EC2 instance to be terminated.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public TerminateInstanceInAutoScalingGroupRequest withInstanceId(String instanceId) {
this.instanceId = instanceId;
return this;
}
/**
* Specifies whether (true) or not (false) terminating this
* instance should also decrement the size of the
* AutoScalingGroup.
*
* @return Specifies whether (true) or not (false) terminating this
* instance should also decrement the size of the
* AutoScalingGroup.
*/
public Boolean isShouldDecrementDesiredCapacity() {
return shouldDecrementDesiredCapacity;
}
/**
* Specifies whether (true) or not (false) terminating this
* instance should also decrement the size of the
* AutoScalingGroup.
*
* @param shouldDecrementDesiredCapacity Specifies whether (true) or not (false) terminating this
* instance should also decrement the size of the
* AutoScalingGroup.
*/
public void setShouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity) {
this.shouldDecrementDesiredCapacity = shouldDecrementDesiredCapacity;
}
/**
* Specifies whether (true) or not (false) terminating this
* instance should also decrement the size of the
* AutoScalingGroup.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param shouldDecrementDesiredCapacity Specifies whether (true) or not (false) terminating this
* instance should also decrement the size of the
* AutoScalingGroup.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public TerminateInstanceInAutoScalingGroupRequest withShouldDecrementDesiredCapacity(Boolean shouldDecrementDesiredCapacity) {
this.shouldDecrementDesiredCapacity = shouldDecrementDesiredCapacity;
return this;
}
/**
* Specifies whether (true) or not (false) terminating this
* instance should also decrement the size of the
* AutoScalingGroup.
*
* @return Specifies whether (true) or not (false) terminating this
* instance should also decrement the size of the
* AutoScalingGroup.
*/
public Boolean getShouldDecrementDesiredCapacity() {
return shouldDecrementDesiredCapacity;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
sb.append("InstanceId: " + instanceId + ", ");
sb.append("ShouldDecrementDesiredCapacity: " + shouldDecrementDesiredCapacity + ", ");
sb.append("}");
return sb.toString();
}
}