com.amazonaws.services.opsworks.model

Class DescribeInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opsworks.model.DescribeInstancesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeInstancesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeInstances operation.

Requests a description of a set of instances.

NOTE: You must specify at least one of the parameters.

Required Permissions : To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

See Also:

AWSOpsWorks.describeInstances(DescribeInstancesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeInstancesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeInstancesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getInstanceIds() An array of instance IDs to be described.
String	getLayerId() A layer ID.
String	getStackId() A stack ID.
int	hashCode()
void	setInstanceIds(Collection<String> instanceIds) An array of instance IDs to be described.
void	setLayerId(String layerId) A layer ID.
void	setStackId(String stackId) A stack ID.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeInstancesRequest	withInstanceIds(Collection<String> instanceIds) An array of instance IDs to be described.
DescribeInstancesRequest	withInstanceIds(String... instanceIds) An array of instance IDs to be described.
DescribeInstancesRequest	withLayerId(String layerId) A layer ID.
DescribeInstancesRequest	withStackId(String stackId) A stack ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeInstancesRequest

public DescribeInstancesRequest()

Method Detail

getStackId

public String getStackId()

A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

Returns:

A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

setStackId

public void setStackId(String stackId)

A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

Parameters:

stackId - A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

withStackId

public DescribeInstancesRequest withStackId(String stackId)

A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

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

Parameters:

stackId - A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

Returns:

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

getLayerId

public String getLayerId()

A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

Returns:

A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

setLayerId

public void setLayerId(String layerId)

A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

Parameters:

layerId - A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

withLayerId

public DescribeInstancesRequest withLayerId(String layerId)

A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

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

Parameters:

layerId - A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

Returns:

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

getInstanceIds

public List<String> getInstanceIds()

An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

Returns:

An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

setInstanceIds

public void setInstanceIds(Collection<String> instanceIds)

An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

Parameters:

instanceIds - An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

withInstanceIds

public DescribeInstancesRequest withInstanceIds(String... instanceIds)

An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

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 - An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

Returns:

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

withInstanceIds

public DescribeInstancesRequest withInstanceIds(Collection<String> instanceIds)

An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

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

Parameters:

instanceIds - An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

Returns:

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

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 DescribeInstancesRequest 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()