com.amazonaws.services.ec2.model

Class StopInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.StopInstancesRequest

All Implemented Interfaces:

ReadLimitInfo, DryRunSupportedRequest<StopInstancesRequest>, Serializable, Cloneable

public class StopInstancesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<StopInstancesRequest>

Container for the parameters to the StopInstances operation.

Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

You can't start or stop Spot Instances.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide .

For more information about troubleshooting, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide .

See Also:

AmazonEC2.stopInstances(StopInstancesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StopInstancesRequest() Default constructor for a new StopInstancesRequest object.
StopInstancesRequest(List<String> instanceIds) Constructs a new StopInstancesRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
StopInstancesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Request<StopInstancesRequest>	getDryRunRequest() This method is intended for internal use only.
Boolean	getForce() Forces the instances to stop.
List<String>	getInstanceIds() One or more instance IDs.
int	hashCode()
Boolean	isForce() Forces the instances to stop.
void	setForce(Boolean force) Forces the instances to stop.
void	setInstanceIds(Collection<String> instanceIds) One or more instance IDs.
String	toString() Returns a string representation of this object; useful for testing and debugging.
StopInstancesRequest	withForce(Boolean force) Forces the instances to stop.
StopInstancesRequest	withInstanceIds(Collection<String> instanceIds) One or more instance IDs.
StopInstancesRequest	withInstanceIds(String... instanceIds) One or more instance IDs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StopInstancesRequest

public StopInstancesRequest()

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

StopInstancesRequest

public StopInstancesRequest(List<String> instanceIds)

Constructs a new StopInstancesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

instanceIds - One or more instance IDs.

Method Detail

getInstanceIds

public List<String> getInstanceIds()

One or more instance IDs.

Returns:

One or more instance IDs.

setInstanceIds

public void setInstanceIds(Collection<String> instanceIds)

One or more instance IDs.

Parameters:

instanceIds - One or more instance IDs.

withInstanceIds

public StopInstancesRequest withInstanceIds(String... instanceIds)

One or more instance IDs.

NOTE: This method appends the values to the existing list (if any). Use setInstanceIds(java.util.Collection) or withInstanceIds(java.util.Collection) if you want to override the existing values.

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

Parameters:

instanceIds - One or more instance IDs.

Returns:

A reference to this updated object so that method calls can be chained together.

withInstanceIds

public StopInstancesRequest withInstanceIds(Collection<String> instanceIds)

One or more instance IDs.

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

Parameters:

instanceIds - One or more instance IDs.

Returns:

A reference to this updated object so that method calls can be chained together.

isForce

public Boolean isForce()

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

Returns:

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

setForce

public void setForce(Boolean force)

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

Parameters:

force - Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

withForce

public StopInstancesRequest withForce(Boolean force)

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

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

Parameters:

force - Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

Returns:

A reference to this updated object so that method calls can be chained together.

getForce

public Boolean getForce()

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

Returns:

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

getDryRunRequest

public Request<StopInstancesRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<StopInstancesRequest>

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public StopInstancesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()