describe_stack_resource ( $stack_name, $logical_resource_id, $opt )

Returns a description of the specified resource in the specified stack.

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.

Access

public

Parameters

Parameter

Type

Required

Description

$stack_name

string

Required

The name or the unique identifier associated with the stack. Default: There is no default value.

$logical_resource_id

string

Required

The logical name of the resource as specified in the template. Default: There is no default value.

$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

Describe a single stack resources.

$stack = new AmazonCloudFormation();

$response = $stack->describe_stack_resource('aws-php-sdk-stack2', 'MyLoadBalancer');

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

Source

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

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

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback