AWS Elastic Beanstalk details page.
* The location of the lastest AWS Elastic Beanstalk WSDL is http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl.
*
* Endpoints
*
* AWS Elastic Beanstalk supports the following region-specific endpoint:
*
* - https://elasticbeanstalk.us-east-1.amazonaws.com
*
*
*
* @version Tue Aug 23 12:47:06 PDT 2011
* @license See the included NOTICE.md file for complete information.
* @copyright See the included NOTICE.md file for complete information.
* @link http://aws.amazon.com/elasticbeanstalk/AWS Elastic Beanstalk
* @link http://aws.amazon.com/documentation/elasticbeanstalk/AWS Elastic Beanstalk documentation
*/
class AmazonElasticBeanstalk extends CFRuntime
{
/*%******************************************************************************************%*/
// CLASS CONSTANTS
/**
* Specify the default queue URL.
*/
const DEFAULT_URL = 'elasticbeanstalk.us-east-1.amazonaws.com';
/**
* Specify the queue URL for the US-East (Northern Virginia) Region.
*/
const REGION_US_E1 = 'us-east-1';
/*%******************************************************************************************%*/
// SETTERS
/**
* This allows you to explicitly sets the region for the service to use.
*
* @param string $region (Required) The region to explicitly set. Available options are .
* @return $this A reference to the current instance.
*/
public function set_region($region)
{
$this->set_hostname('http://elasticbeanstalk.'. $region .'.amazonaws.com');
return $this;
}
/*%******************************************************************************************%*/
// CONSTRUCTOR
/**
* Constructs a new instance of .
*
* @param string $key (Optional) Your Amazon API Key. If blank, it will look for the AWS_KEY constant.
* @param string $secret_key (Optional) Your Amazon API Secret Key. If blank, it will look for the AWS_SECRET_KEY constant.
* @return boolean false if no valid values are set, otherwise true.
*/
public function __construct($key = null, $secret_key = null)
{
$this->api_version = '2010-12-01';
$this->hostname = self::DEFAULT_URL;
if (!$key && !defined('AWS_KEY'))
{
// @codeCoverageIgnoreStart
throw new Beanstalk_Exception('No account key was passed into the constructor, nor was it set in the AWS_KEY constant.');
// @codeCoverageIgnoreEnd
}
if (!$secret_key && !defined('AWS_SECRET_KEY'))
{
// @codeCoverageIgnoreStart
throw new Beanstalk_Exception('No account secret was passed into the constructor, nor was it set in the AWS_SECRET_KEY constant.');
// @codeCoverageIgnoreEnd
}
return parent::__construct($key, $secret_key);
}
/*%******************************************************************************************%*/
// SERVICE METHODS
/**
*
* Checks if the specified CNAME is available.
*
* @param string $cname_prefix (Required) The prefix used when this CNAME is reserved.
* @param array $opt (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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function check_dns_availability($cname_prefix, $opt = null)
{
if (!$opt) $opt = array();
$opt['CNAMEPrefix'] = $cname_prefix;
return $this->authenticate('CheckDNSAvailability', $opt, $this->hostname);
}
/**
*
* 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.
*
* @param array $opt (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 - 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function describe_configuration_options($opt = null)
{
if (!$opt) $opt = array();
// Optional parameter
if (isset($opt['Options']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Options' => $opt['Options']
), 'member'));
unset($opt['Options']);
}
return $this->authenticate('DescribeConfigurationOptions', $opt, $this->hostname);
}
/**
*
* Deletes the specified configuration template.
*
* When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the
* environment's copy of the template without affecting the running environment.
*
* @param string $application_name (Required) The name of the application to delete the configuration template from.
* @param string $template_name (Required) The name of the configuration template to delete.
* @param array $opt (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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function delete_configuration_template($application_name, $template_name, $opt = null)
{
if (!$opt) $opt = array();
$opt['ApplicationName'] = $application_name;
$opt['TemplateName'] = $template_name;
return $this->authenticate('DeleteConfigurationTemplate', $opt, $this->hostname);
}
/**
*
* Launches an environment for the specified application using the specified configuration.
*
* @param string $application_name (Required) The name of the application that contains the version to be deployed. If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.
* @param string $environment_name (Required) A unique name for the deployment environment. Used in the application URL. Constraint: Must be from 4 to 23 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique in your account. If the specified name already exists, AWS Elastic Beanstalk returns an InvalidParameterValue error. Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* VersionLabel - string - Optional - The name of the application version to deploy. If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error. Default: If not specified, AWS Elastic Beanstalk attempts to launch the most recently created application version. TemplateName - string - Optional - The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error. Conditional: You must specify either this parameter or a SolutionStackName, 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. SolutionStackName - string - Optional - This is an alternative to specifying a configuration name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack. 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 a MissingRequiredParameter error. CNAMEPrefix - string - Optional - If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the environment uses the environment name. Description - string - Optional - Describes this environment. OptionSettings - array - Optional - If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.
* x - array - 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. Value - string - Optional - The current value for the configuration option.
OptionsToRemove - array - Optional - A list of custom user-defined configuration options to remove from the configuration set for this new environment.
* x - array - 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function create_environment($application_name, $environment_name, $opt = null)
{
if (!$opt) $opt = array();
$opt['ApplicationName'] = $application_name;
$opt['EnvironmentName'] = $environment_name;
// Optional parameter
if (isset($opt['OptionSettings']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'OptionSettings' => $opt['OptionSettings']
), 'member'));
unset($opt['OptionSettings']);
}
// Optional parameter
if (isset($opt['OptionsToRemove']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'OptionsToRemove' => $opt['OptionsToRemove']
), 'member'));
unset($opt['OptionsToRemove']);
}
return $this->authenticate('CreateEnvironment', $opt, $this->hostname);
}
/**
*
* Creates the Amazon S3 storage location for the account.
*
* This location is used to store user log files.
*
* @param array $opt (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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function create_storage_location($opt = null)
{
if (!$opt) $opt = array();
return $this->authenticate('CreateStorageLocation', $opt, $this->hostname);
}
/**
*
* Initiates a request to compile the specified type of information of the deployed environment.
*
* Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2
* instance in your environment. Use RetrieveEnvironmentInfo to access the compiled information.
*
* Related Topics
*
*
*
* - RetrieveEnvironmentInfo
*
*
*
* @param string $info_type (Required) The type of information to request. [Allowed values: tail]
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* EnvironmentId - string - Optional - The ID of the environment of the requested data. If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error. EnvironmentName - string - Optional - The name of the environment of the requested data. If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function request_environment_info($info_type, $opt = null)
{
if (!$opt) $opt = array();
$opt['InfoType'] = $info_type;
return $this->authenticate('RequestEnvironmentInfo', $opt, $this->hostname);
}
/**
*
* Creates an application version for the specified application.
*
* Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you
* change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.
*
* @param string $application_name (Required) The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error.
* @param string $version_label (Required) A label identifying this version. Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an InvalidParameterValue error.
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* Description - string - Optional - Describes this version. SourceBundle - array - Optional - The Amazon S3 bucket and key that identify the location of the source bundle for this version. If data found at the Amazon S3 location exceeds the maximum allowed source bundle size, AWS Elastic Beanstalk returns an InvalidParameterValue error. Default: If not specified, AWS Elastic Beanstalk uses a sample application. If only partially specified (for example, a bucket is provided but not the key) or if no data is found at the Amazon S3 location, AWS Elastic Beanstalk returns an InvalidParameterCombination error.
* S3Bucket - string - Optional - The Amazon S3 bucket where the data is located. S3Key - string - Optional - The Amazon S3 key where the data is located.
AutoCreateApplication - boolean - Optional - Determines how the system behaves if the specified application for this version does not already exist: true: Automatically creates the specified application for this version if it does not already exist. false: Returns an InvalidParameterValue if the specified application for this version does not already exist. -
true : Automatically creates the specified application for this release if it does not already exist. -
false : Throws an InvalidParameterValue if the specified application for this release does not already exist.
Default: false Valid Values: true | false 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function create_application_version($application_name, $version_label, $opt = null)
{
if (!$opt) $opt = array();
$opt['ApplicationName'] = $application_name;
$opt['VersionLabel'] = $version_label;
// Optional parameter
if (isset($opt['SourceBundle']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'SourceBundle' => $opt['SourceBundle']
), 'member'));
unset($opt['SourceBundle']);
}
return $this->authenticate('CreateApplicationVersion', $opt, $this->hostname);
}
/**
*
* Deletes the specified version from the specified application.
*
* You cannot delete an application version that is associated with a running environment.
*
* @param string $application_name (Required) The name of the application to delete releases from.
* @param string $version_label (Required) The label of the version to delete.
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* DeleteSourceBundle - boolean - Optional - Indicates whether to delete the associated source bundle from Amazon S3: -
true: An attempt is made to delete the associated Amazon S3 source bundle specified at time of creation. -
false: No action is taken on the Amazon S3 source bundle specified at time of creation.
Valid Values: true | false 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function delete_application_version($application_name, $version_label, $opt = null)
{
if (!$opt) $opt = array();
$opt['ApplicationName'] = $application_name;
$opt['VersionLabel'] = $version_label;
return $this->authenticate('DeleteApplicationVersion', $opt, $this->hostname);
}
/**
*
* Returns descriptions for existing application versions.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* ApplicationName - string - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include ones that are associated with the specified application. VersionLabels - string|array - Optional - If specified, restricts the returned descriptions to only include ones that have the specified version labels. Pass a string for a single value, or an indexed array for multiple values. 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function describe_application_versions($opt = null)
{
if (!$opt) $opt = array();
// Optional parameter
if (isset($opt['VersionLabels']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'VersionLabels' => (is_array($opt['VersionLabels']) ? $opt['VersionLabels'] : array($opt['VersionLabels']))
), 'member'));
unset($opt['VersionLabels']);
}
return $this->authenticate('DescribeApplicationVersions', $opt, $this->hostname);
}
/**
*
* Deletes the specified application along with all associated versions and configurations.
*
* You cannot delete an application that has a running environment.
*
* @param string $application_name (Required) The name of the application to delete.
* @param array $opt (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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function delete_application($application_name, $opt = null)
{
if (!$opt) $opt = array();
$opt['ApplicationName'] = $application_name;
return $this->authenticate('DeleteApplication', $opt, $this->hostname);
}
/**
*
* Updates the specified application version to have the specified properties.
*
* If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty
* string.
*
* @param string $application_name (Required) The name of the application associated with this version. If no application is found with this name, UpdateApplication returns an InvalidParameterValue error.
* @param string $version_label (Required) The name of the version to update. If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error.
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* Description - string - Optional - A new description for this release. 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function update_application_version($application_name, $version_label, $opt = null)
{
if (!$opt) $opt = array();
$opt['ApplicationName'] = $application_name;
$opt['VersionLabel'] = $version_label;
return $this->authenticate('UpdateApplicationVersion', $opt, $this->hostname);
}
/**
*
* Creates an application that has one configuration template named default and no application versions.
*
* The default configuration template is for a 32-bit version of the Amazon Linux operating system running the Tomcat 6
* application container.
*
* @param string $application_name (Required) The name of the application. Constraint: This name must be unique within your account. If the specified name already exists, the action returns an InvalidParameterValue error.
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* Description - string - Optional - Describes the application. 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function create_application($application_name, $opt = null)
{
if (!$opt) $opt = array();
$opt['ApplicationName'] = $application_name;
return $this->authenticate('CreateApplication', $opt, $this->hostname);
}
/**
*
* Swaps the CNAMEs of two environments.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* SourceEnvironmentId - string - Optional - The ID of the source environment. Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentId, you must specify the DestinationEnvironmentId. SourceEnvironmentName - string - Optional - The name of the source environment. Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentName, you must specify the DestinationEnvironmentName. DestinationEnvironmentId - string - Optional - The ID of the destination environment. Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentId with the DestinationEnvironmentId. DestinationEnvironmentName - string - Optional - The name of the destination environment. Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentName with the DestinationEnvironmentName. 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function swap_environment_cnames($opt = null)
{
if (!$opt) $opt = array();
return $this->authenticate('SwapEnvironmentCNAMEs', $opt, $this->hostname);
}
/**
*
* Updates the specified configuration template to have the specified properties or configuration option values.
*
* If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify
* an empty string.
*
* Related Topics
*
* - DescribeConfigurationOptions
*
*
*
* @param string $application_name (Required) The name of the application associated with the configuration template to update. If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.
* @param string $template_name (Required) The name of the configuration template to update. If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* Description - string - Optional - A new description for the configuration. OptionSettings - array - Optional - A list of configuration option settings to update with the new specified option value.
* x - array - 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. Value - string - Optional - The current value for the configuration option.
OptionsToRemove - array - Optional - A list of configuration options to remove from the configuration set. Constraint: You can remove only UserDefined configuration options.
* x - array - 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function update_configuration_template($application_name, $template_name, $opt = null)
{
if (!$opt) $opt = array();
$opt['ApplicationName'] = $application_name;
$opt['TemplateName'] = $template_name;
// Optional parameter
if (isset($opt['OptionSettings']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'OptionSettings' => $opt['OptionSettings']
), 'member'));
unset($opt['OptionSettings']);
}
// Optional parameter
if (isset($opt['OptionsToRemove']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'OptionsToRemove' => $opt['OptionsToRemove']
), 'member'));
unset($opt['OptionsToRemove']);
}
return $this->authenticate('UpdateConfigurationTemplate', $opt, $this->hostname);
}
/**
*
* Retrieves the compiled information from a RequestEnvironmentInfo request.
*
* Related Topics
*
*
*
* - RequestEnvironmentInfo
*
*
*
* @param string $info_type (Required) The type of information to retrieve. [Allowed values: tail]
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* EnvironmentId - string - Optional - The ID of the data's environment. If no such environment is found, returns an InvalidParameterValue error. EnvironmentName - string - Optional - The name of the data's environment. If no such environment is found, returns an InvalidParameterValue 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function retrieve_environment_info($info_type, $opt = null)
{
if (!$opt) $opt = array();
$opt['InfoType'] = $info_type;
return $this->authenticate('RetrieveEnvironmentInfo', $opt, $this->hostname);
}
/**
*
* Returns a list of the available solution stack names.
*
* @param array $opt (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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function list_available_solution_stacks($opt = null)
{
if (!$opt) $opt = array();
return $this->authenticate('ListAvailableSolutionStacks', $opt, $this->hostname);
}
/**
*
* Updates the specified application to have the specified properties.
*
* If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an
* empty string.
*
* @param string $application_name (Required) The name of the application to update. If no such application is found, UpdateApplication returns an InvalidParameterValue error.
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* Description - string - Optional - A new description for the application. Default: If not specified, AWS Elastic Beanstalk does not update the description. 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function update_application($application_name, $opt = null)
{
if (!$opt) $opt = array();
$opt['ApplicationName'] = $application_name;
return $this->authenticate('UpdateApplication', $opt, $this->hostname);
}
/**
*
* Returns descriptions for existing environments.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* ApplicationName - string - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application. VersionLabel - string - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version. EnvironmentIds - string|array - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs. Pass a string for a single value, or an indexed array for multiple values. EnvironmentNames - string|array - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names. Pass a string for a single value, or an indexed array for multiple values. IncludeDeleted - boolean - Optional - Indicates whether to include deleted environments: true: Environments that have been deleted after IncludedDeletedBackTo are displayed. false: Do not include deleted environments. IncludedDeletedBackTo - string - Optional - If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed. May be passed as a number of seconds since UNIX Epoch, or any string compatible with .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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function describe_environments($opt = null)
{
if (!$opt) $opt = array();
// Optional parameter
if (isset($opt['EnvironmentIds']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'EnvironmentIds' => (is_array($opt['EnvironmentIds']) ? $opt['EnvironmentIds'] : array($opt['EnvironmentIds']))
), 'member'));
unset($opt['EnvironmentIds']);
}
// Optional parameter
if (isset($opt['EnvironmentNames']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'EnvironmentNames' => (is_array($opt['EnvironmentNames']) ? $opt['EnvironmentNames'] : array($opt['EnvironmentNames']))
), 'member'));
unset($opt['EnvironmentNames']);
}
// Optional parameter
if (isset($opt['IncludedDeletedBackTo']))
{
$opt['IncludedDeletedBackTo'] = $this->util->convert_date_to_iso8601($opt['IncludedDeletedBackTo']);
}
return $this->authenticate('DescribeEnvironments', $opt, $this->hostname);
}
/**
*
* Returns AWS resources for this environment.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* EnvironmentId - string - Optional - The ID of the environment to retrieve AWS resource usage data. EnvironmentName - string - Optional - The name of the environment to retrieve AWS resource usage data. 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function describe_environment_resources($opt = null)
{
if (!$opt) $opt = array();
return $this->authenticate('DescribeEnvironmentResources', $opt, $this->hostname);
}
/**
*
* Terminates the specified environment.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* EnvironmentId - string - Optional - The ID of the environment to terminate. EnvironmentName - string - Optional - The name of the environment to terminate. TerminateResources - boolean - Optional - Indicates whether the associated AWS resources should shut down when the environment is terminated: true: (default) The user AWS resources (for example, the Auto Scaling group, LoadBalancer, etc.) are terminated along with the environment. false: The environment is removed from the AWS Elastic Beanstalk but the AWS resources continue to operate. -
true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated. -
false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.
For more information, see the AWS Elastic Beanstalk User Guide. Default: true Valid Values: true | false 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function terminate_environment($opt = null)
{
if (!$opt) $opt = array();
return $this->authenticate('TerminateEnvironment', $opt, $this->hostname);
}
/**
*
* Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.
*
* This action returns a list of messages indicating any errors or warnings associated with the selection of option values.
*
* @param string $application_name (Required) The name of the application that the configuration template or environment belongs to.
* @param array $option_settings (Required) A list of the options and desired values to evaluate.
* x - array - 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. Value - string - Optional - The current value for the configuration option.
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* TemplateName - string - Optional - The name of the configuration template to validate the settings against. Condition: You cannot specify both this and an environment name. EnvironmentName - string - Optional - The name of the environment to validate the settings against. Condition: You cannot specify both this and a configuration template name. 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function validate_configuration_settings($application_name, $option_settings, $opt = null)
{
if (!$opt) $opt = array();
$opt['ApplicationName'] = $application_name;
// Required parameter
$opt = array_merge($opt, CFComplexType::map(array(
'OptionSettings' => (is_array($option_settings) ? $option_settings : array($option_settings))
), 'member'));
return $this->authenticate('ValidateConfigurationSettings', $opt, $this->hostname);
}
/**
*
* Causes the environment to restart the application container server running on each Amazon EC2 instance.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* EnvironmentId - string - Optional - The ID of the environment to restart the server for. EnvironmentName - string - Optional - The name of the environment to restart the server for. 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function restart_app_server($opt = null)
{
if (!$opt) $opt = array();
return $this->authenticate('RestartAppServer', $opt, $this->hostname);
}
/**
*
* 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.
*
* @param string $application_name (Required) The name of the application the environment is associated with.
* @param string $environment_name (Required) The name of the environment to delete the draft configuration from.
* @param array $opt (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.
* @return CFResponse A object containing a parsed HTTP response.
*/
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, $this->hostname);
}
/**
*
* Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration
* template, or updates select configuration option values in the running environment.
*
* Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an
* InvalidParameterCombination error.
*
* When updating the configuration settings to a new template or individual settings, a draft configuration is created and
* DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* EnvironmentId - string - Optional - The ID of the environment to update. If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error. EnvironmentName - string - Optional - The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error. VersionLabel - string - Optional - If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error. TemplateName - string - Optional - If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error. Description - string - Optional - If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment. OptionSettings - array - Optional - If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.
* x - array - 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. Value - string - Optional - The current value for the configuration option.
OptionsToRemove - array - Optional - A list of custom user-defined configuration options to remove from the configuration set for this environment.
* x - array - 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function update_environment($opt = null)
{
if (!$opt) $opt = array();
// Optional parameter
if (isset($opt['OptionSettings']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'OptionSettings' => $opt['OptionSettings']
), 'member'));
unset($opt['OptionSettings']);
}
// Optional parameter
if (isset($opt['OptionsToRemove']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'OptionsToRemove' => $opt['OptionsToRemove']
), 'member'));
unset($opt['OptionsToRemove']);
}
return $this->authenticate('UpdateEnvironment', $opt, $this->hostname);
}
/**
*
* Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the
* application with the same configuration settings.
*
* Related Topics
*
*
*
* - DescribeConfigurationOptions
*
* - DescribeConfigurationSettings
*
* - ListAvailableSolutionStacks
*
*
*
* @param string $application_name (Required) The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.
* @param string $template_name (Required) The name of the configuration template. Constraint: This name must be unique per application. Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* SolutionStackName - string - Optional - The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values. Use ListAvailableSolutionStacks to obtain a list of available solution stacks. Default: If the SolutionStackName is not specified and the source configuration parameter is blank, AWS Elastic Beanstalk uses the default solution stack. If not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template. SourceConfiguration - array - Optional - If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration. Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration. If no configuration template is found, returns an InvalidParameterValue error. Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error.
* ApplicationName - string - Optional - The name of the application associated with the configuration. TemplateName - string - Optional - The name of the configuration template.
EnvironmentId - string - Optional - The ID of the environment used with this configuration template. Description - string - Optional - Describes this configuration. OptionSettings - array - Optional - If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.
* x - array - 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. Value - string - Optional - The current value for 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function create_configuration_template($application_name, $template_name, $opt = null)
{
if (!$opt) $opt = array();
$opt['ApplicationName'] = $application_name;
$opt['TemplateName'] = $template_name;
// Optional parameter
if (isset($opt['SourceConfiguration']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'SourceConfiguration' => $opt['SourceConfiguration']
), 'member'));
unset($opt['SourceConfiguration']);
}
// Optional parameter
if (isset($opt['OptionSettings']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'OptionSettings' => $opt['OptionSettings']
), 'member'));
unset($opt['OptionSettings']);
}
return $this->authenticate('CreateConfigurationTemplate', $opt, $this->hostname);
}
/**
*
* 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
*
*
*
* @param string $application_name (Required) The application for the environment or configuration template.
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* TemplateName - string - Optional - The name of the configuration template to describe. EnvironmentName - string - Optional - The name of the environment to describe. 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function describe_configuration_settings($application_name, $opt = null)
{
if (!$opt) $opt = array();
$opt['ApplicationName'] = $application_name;
return $this->authenticate('DescribeConfigurationSettings', $opt, $this->hostname);
}
/**
*
* Returns the descriptions of existing applications.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* ApplicationNames - string|array - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names. Pass a string for a single value, or an indexed array for multiple values. 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function describe_applications($opt = null)
{
if (!$opt) $opt = array();
// Optional parameter
if (isset($opt['ApplicationNames']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'ApplicationNames' => (is_array($opt['ApplicationNames']) ? $opt['ApplicationNames'] : array($opt['ApplicationNames']))
), 'member'));
unset($opt['ApplicationNames']);
}
return $this->authenticate('DescribeApplications', $opt, $this->hostname);
}
/**
*
* Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and
* forces a restart.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* EnvironmentId - string - Optional - The ID of the environment to rebuild. EnvironmentName - string - Optional - The name of the environment to rebuild. 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function rebuild_environment($opt = null)
{
if (!$opt) $opt = array();
return $this->authenticate('RebuildEnvironment', $opt, $this->hostname);
}
/**
*
* Returns list of event descriptions matching criteria up to the last 6 weeks.
*
* This action returns the most recent 1,000 events from the specified NextToken.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys:
* ApplicationName - string - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application. VersionLabel - string - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version. TemplateName - string - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration. EnvironmentId - string - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment. EnvironmentName - string - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment. RequestId - string - Optional - If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID. Severity - string - Optional - If specified, limits the events returned from this call to include only those with the specified severity or higher. [Allowed values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL]StartTime - string - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time. May be passed as a number of seconds since UNIX Epoch, or any string compatible with .EndTime - string - Optional - If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime. May be passed as a number of seconds since UNIX Epoch, or any string compatible with .NextToken - string - Optional - Pagination token. If specified, the events return the next batch of results. 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.
* @return CFResponse A object containing a parsed HTTP response.
*/
public function describe_events($opt = null)
{
if (!$opt) $opt = array();
// Optional parameter
if (isset($opt['StartTime']))
{
$opt['StartTime'] = $this->util->convert_date_to_iso8601($opt['StartTime']);
}
// Optional parameter
if (isset($opt['EndTime']))
{
$opt['EndTime'] = $this->util->convert_date_to_iso8601($opt['EndTime']);
}
return $this->authenticate('DescribeEvents', $opt, $this->hostname);
}
}
/*%******************************************************************************************%*/
// EXCEPTIONS
/**
* Default Elastic Beanstalk Exception.
*/
class ElasticBeanstalk_Exception extends Exception {}