delete_environment_configuration ( $application_name, $environment_name, $opt )

Deletes the draft configuration associated with the running environment.

Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.

Access

public

Parameters

Parameter

Type

Required

Description

$application_name

string

Required

The name of the application the environment is associated with.

$environment_name

string

Required

The name of the environment to delete the draft configuration from.

$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

Delete an environment configuration.

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

$response = $bean->delete_environment_configuration('my-application', 'my-environment');

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

Related Methods

Source

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

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

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback