com.amazonaws.services.ec2.model

Class StopInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.StopInstancesRequest

All Implemented Interfaces:

DryRunSupportedRequest<StopInstancesRequest>, java.io.Serializable, java.lang.Cloneable

public class StopInstancesRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<StopInstancesRequest>

Container for the parameters to the StopInstances operation.

Stops an Amazon EBS-backed instance.

We don't charge hourly usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. 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, and you can't stop instance store-backed instances.

When you stop an instance, we shut it down. 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.

Stopping an instance is different to rebooting or terminating 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 rebooting, stopping, and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide .

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide .

See Also:

AmazonEC2.stopInstances(StopInstancesRequest), Serialized Form

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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(java.util.List<java.lang.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 java.util.List<java.lang.String> getInstanceIds()

One or more instance IDs.

Returns:

One or more instance IDs.

setInstanceIds

public void setInstanceIds(java.util.Collection<java.lang.String> instanceIds)

One or more instance IDs.

Parameters:

instanceIds - One or more instance IDs.

withInstanceIds

public StopInstancesRequest withInstanceIds(java.lang.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.

withInstanceIds

public StopInstancesRequest withInstanceIds(java.util.Collection<java.lang.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 java.lang.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(java.lang.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(java.lang.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 java.lang.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 java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object