describe_configuration_options ( $opt )

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

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

  • ApplicationName - string - Optional - The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.
  • TemplateName - string - Optional - The name of the configuration template whose configuration options you want to describe.
  • EnvironmentName - string - Optional - The name of the environment whose configuration options you want to describe.
  • SolutionStackName - string - Optional - The name of the solution stack whose configuration options you want to describe.
  • Options - array - Optional - If specified, restricts the descriptions to only the specified options.
    • x - array - Optional - This represents a simple array index.
      • Namespace - string - Optional - A unique namespace identifying the option’s associated AWS resource.
      • OptionName - string - Optional - The name of the configuration option.
  • 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 configuration options.

// Instantiate the class
$bean = new AmazonElasticBeanstalk();

$response = $bean->describe_configuration_options();

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

Describe configuration options for a specific application and environment.

// Instantiate the class
$bean = new AmazonElasticBeanstalk();

$response = $bean->describe_configuration_options(array(
	'ApplicationName' => 'my-application',
	'EnvironmentName' => 'my-environment'
));

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

Describe all possible configuration options for a specific solution stack.

// Instantiate the class
$bean = new AmazonElasticBeanstalk();

$response = $bean->describe_configuration_options(array(
	'SolutionStackName' => '32bit Amazon Linux running Tomcat 6'
));

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

Related Methods

Source

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

public function describe_configuration_options($opt = null)
{
    if (!$opt) $opt = array();
            
    // Optional list + map
    if (isset($opt['Options']))
    {
        $opt = array_merge($opt, CFComplexType::map(array(
            'Options' => $opt['Options']
        ), 'member'));
        unset($opt['Options']);
    }

    return $this->authenticate('DescribeConfigurationOptions', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback