com.amazonaws.services.cloudformation.model

Class DescribeStacksRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudformation.model.DescribeStacksRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeStacksRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeStacks operation.

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.

See Also:

AmazonCloudFormation.describeStacks(DescribeStacksRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeStacksRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeStacksRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getNextToken() String that identifies the start of the next list of stacks, if there is one.
String	getStackName() The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID.
int	hashCode()
void	setNextToken(String nextToken) String that identifies the start of the next list of stacks, if there is one.
void	setStackName(String stackName) The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeStacksRequest	withNextToken(String nextToken) String that identifies the start of the next list of stacks, if there is one.
DescribeStacksRequest	withStackName(String stackName) The name or the unique stack ID that is associated with the stack, which are not always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique 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

DescribeStacksRequest

public DescribeStacksRequest()

Method Detail

getStackName

public String getStackName()

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.
• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Returns:

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.
• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

setStackName

public void setStackName(String stackName)

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.
• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Parameters:

stackName - The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.
• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

withStackName

public DescribeStacksRequest withStackName(String stackName)

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.
• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

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

Parameters:

stackName - The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

• Running stacks: You can specify either the stack's name or its unique stack ID.
• Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Returns:

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

getNextToken

public String getNextToken()

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

Constraints:
Length: 1 - 1024

Returns:

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

setNextToken

public void setNextToken(String nextToken)

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

Constraints:
Length: 1 - 1024

Parameters:

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

withNextToken

public DescribeStacksRequest withNextToken(String nextToken)

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

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.

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