describe_stacks ( $opt )

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

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • StackName - string - Optional - The name or the unique identifier associated with the stack. Default: There is no default value.
  • NextToken - string - Optional -
  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Describe all stacks.

$stack = new AmazonCloudFormation();

$response = $stack->describe_stacks();

// Success?
var_dump($response->isOK());
Result:
bool(true)

Related Methods

Source

Method defined in services/cloudformation.class.php | Toggle source view (6 lines) | View on GitHub

public function describe_stacks($opt = null)
{
    if (!$opt) $opt = array();
            
    return $this->authenticate('DescribeStacks', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback