com.amazonaws.services.ec2.model

Class StopInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.StopInstancesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<StopInstancesRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StopInstancesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<StopInstancesRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
StopInstancesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Request<StopInstancesRequest>	getDryRunRequest() This method is intended for internal use only.
Boolean	getForce() Forces the instances to stop.
Boolean	getHibernate() Hibernates the instance if the instance was enabled for hibernation at launch.
List<String>	getInstanceIds() The IDs of the instances.
int	hashCode()
Boolean	isForce() Forces the instances to stop.
Boolean	isHibernate() Hibernates the instance if the instance was enabled for hibernation at launch.
void	setForce(Boolean force) Forces the instances to stop.
void	setHibernate(Boolean hibernate) Hibernates the instance if the instance was enabled for hibernation at launch.
void	setInstanceIds(Collection<String> instanceIds) The IDs of the instances.
String	toString() Returns a string representation of this object.
StopInstancesRequest	withForce(Boolean force) Forces the instances to stop.
StopInstancesRequest	withHibernate(Boolean hibernate) Hibernates the instance if the instance was enabled for hibernation at launch.
StopInstancesRequest	withInstanceIds(Collection<String> instanceIds) The IDs of the instances.
StopInstancesRequest	withInstanceIds(String... instanceIds) The IDs of the instances.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StopInstancesRequest

public StopInstancesRequest()

Default constructor for StopInstancesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the 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 - The IDs of the instances.

Method Detail

getInstanceIds

public List<String> getInstanceIds()

The IDs of the instances.

Returns:

The IDs of the instances.

setInstanceIds

public void setInstanceIds(Collection<String> instanceIds)

The IDs of the instances.

Parameters:

instanceIds - The IDs of the instances.

withInstanceIds

public StopInstancesRequest withInstanceIds(String... instanceIds)

The IDs of the instances.

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.

Parameters:

instanceIds - The IDs of the instances.

Returns:

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

withInstanceIds

public StopInstancesRequest withInstanceIds(Collection<String> instanceIds)

The IDs of the instances.

Parameters:

instanceIds - The IDs of the instances.

Returns:

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

setHibernate

public void setHibernate(Boolean hibernate)

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

Default: false

Parameters:

hibernate - Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

Default: false

getHibernate

public Boolean getHibernate()

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

Default: false

Returns:

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

Default: false

withHibernate

public StopInstancesRequest withHibernate(Boolean hibernate)

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

Default: false

Parameters:

hibernate - Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

Default: false

Returns:

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

isHibernate

public Boolean isHibernate()

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

Default: false

Returns:

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

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

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

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

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:

Returns a reference to this 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

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StopInstancesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()