com.amazonaws.services.cloudformation.model

Class ListStacksRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudformation.model.ListStacksRequest

All Implemented Interfaces:

Serializable

public class ListStacksRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the ListStacks operation.

Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).

See Also:

AmazonCloudFormation.listStacks(ListStacksRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListStacksRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getNextToken() String that identifies the start of the next list of stacks, if there is one.
List<String>	getStackStatusFilters() Stack status to use as a filter.
int	hashCode()
void	setNextToken(String nextToken) String that identifies the start of the next list of stacks, if there is one.
void	setStackStatusFilters(Collection<String> stackStatusFilters) Stack status to use as a filter.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListStacksRequest	withNextToken(String nextToken) String that identifies the start of the next list of stacks, if there is one.
ListStacksRequest	withStackStatusFilters(Collection<String> stackStatusFilters) Stack status to use as a filter.
ListStacksRequest	withStackStatusFilters(StackStatus... stackStatusFilters) Stack status to use as a filter.
ListStacksRequest	withStackStatusFilters(String... stackStatusFilters) Stack status to use as a filter.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListStacksRequest

public ListStacksRequest()

Method Detail

getNextToken

public String getNextToken()

String that identifies the start of the next list of stacks, if there is one.

Default: There is no default value.

Constraints:
Length: 1 - 1024

Returns:

String that identifies the start of the next list of stacks, if there is one.

Default: There is no default value.

setNextToken

public void setNextToken(String nextToken)

String that identifies the start of the next list of stacks, if there is one.

Default: There is no default value.

Constraints:
Length: 1 - 1024

Parameters:

nextToken - String that identifies the start of the next list of stacks, if there is one.

Default: There is no default value.

withNextToken

public ListStacksRequest withNextToken(String nextToken)

String that identifies the start of the next list of stacks, if there is one.

Default: There is no default value.

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

Constraints:
Length: 1 - 1024

Parameters:

nextToken - String that identifies the start of the next list of stacks, if there is one.

Default: There is no default value.

Returns:

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

getStackStatusFilters

public List<String> getStackStatusFilters()

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

Returns:

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

setStackStatusFilters

public void setStackStatusFilters(Collection<String> stackStatusFilters)

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

Parameters:

stackStatusFilters - Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

withStackStatusFilters

public ListStacksRequest withStackStatusFilters(String... stackStatusFilters)

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

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

Parameters:

stackStatusFilters - Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

Returns:

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

withStackStatusFilters

public ListStacksRequest withStackStatusFilters(Collection<String> stackStatusFilters)

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

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

Parameters:

stackStatusFilters - Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

Returns:

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

withStackStatusFilters

public ListStacksRequest withStackStatusFilters(StackStatus... stackStatusFilters)

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

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

Parameters:

stackStatusFilters - Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

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