describe_configuration_settings ( $application_name, $opt )

Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.

When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.

Related Topics

  • DeleteEnvironmentConfiguration

Access

public

Parameters

Parameter

Type

Required

Description

$application_name

string

Required

The application for the environment or configuration template.

$opt

array

Optional

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

  • TemplateName - string - Optional - The name of the configuration template to describe. Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.
  • EnvironmentName - string - Optional - The name of the environment to describe. Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.
  • 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 configuration settings for a specific application.

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

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

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

Related Methods

Source

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

public function describe_configuration_settings($application_name, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['ApplicationName'] = $application_name;
    
    return $this->authenticate('DescribeConfigurationSettings', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback