Contents

module Fog
  module AWS
    class CloudFormation
      class Real

        require 'rackspace-fog/aws/parsers/cloud_formation/describe_stack_resources'

        # Describe stack resources
        #
        # ==== Parameters
        # * options<~Hash>:
        #   * 'PhysicalResourceId'<~String>: name or unique identifier that corresponds to a physical instance ID
        #   or (one of PhysicalResourceId and StackName is required)
        #   * 'StackName'<~String>: only return events related to this stack name
        #   * 'LogicalResourceId'<~String>: logical name of the resource as specified in the template
        #
        # ==== Returns
        # * response<~Excon::Response>:
        #   * body<~Hash>:
        #     * 'StackResources'<~Array> - Matching resources
        #       * resource<~Hash>:
        #         * 'StackId'<~String> -
        #         * 'StackName'<~String> -
        #         * 'LogicalResourceId'<~String> -
        #         * 'PhysicalResourceId'<~String> -
        #         * 'ResourceType'<~String> -
        #         * 'Timestamp'<~Time> -
        #         * 'ResourceStatus'<~String> -
        #
        # ==== See Also
        # http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_DescribeStackResources.html
        #
        def describe_stack_resources(options = {})
          request({
            'Action'    => 'DescribeStackResources',
            :parser     => Fog::Parsers::AWS::CloudFormation::DescribeStackResources.new
          }.merge!(options))
        end

      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
rackspace-fog-1.4.2	lib/rackspace-fog/aws/requests/cloud_formation/describe_stack_resources.rb