get_template ( $stack_name, $opt )

Returns the template body for a specified stack name. You can get the template for running or deleted stacks.

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.

If the template does not exist, a ValidationError is returned.

Access

public

Parameters

Parameter

Type

Required

Description

$stack_name

string

Required

The name or the unique identifier associated with the stack.

$opt

array

Optional

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

  • 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

Get a stack template and convert it to an associative array.

$stack = new AmazonCloudFormation();

$response = $stack->get_template('my-stack');

if ($response->isOK())
{
	$template_as_array = json_decode((string) $response->body->TemplateBody(0), true);
	// print_r($template_as_array);
}

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

Related Methods

Source

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

public function get_template($stack_name, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['StackName'] = $stack_name;
    
    return $this->authenticate('GetTemplate', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback