check_dns_availability ( $cnameprefix, $opt )

Checks if the specified CNAME is available.

Access

public

Parameters

Parameter

Type

Required

Description

$cnameprefix

string

Required

The prefix used when this CNAME is reserved.

$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

Creates a new running environment.

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

// Check that preferred DNS is available
$dns = $bean->check_dns_availability('my-app');

if ((string) $dns->body->CheckDNSAvailabilityResult->Available === 'true')
{
	$response = $bean->create_environment('my-application', 'my-environment', array(
		'VersionLabel' => '1.0',
		'TemplateName' => 'my-template',
		'CNAMEPrefix' => 'my-app',
		'Description' => 'This is the production 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 check_dns_availability($cnameprefix, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['CNAMEPrefix'] = $cnameprefix;
    
    return $this->authenticate('CheckDNSAvailability', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback