File: //home/httpd/mech_ftp/baretube.com/admin/aws-sdk-for-php/services/cloudformation.class.php
<?php
/*
* Copyright 2010-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/**
* AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably
* and repeatedly. AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS,
* Amazon SNS, ELB, and Auto Scaling to build highly-reliable, highly scalable, cost effective
* applications without worrying about creating and configuring the underlying the AWS
* infrastructure.
*
* With AWS CloudFormation, you declare all of your resources and dependencies in a template file.
* The template defines a collection of resources as a single unit called a stack. AWS
* CloudFormation creates and deletes all member resources of the stack together and manages all
* dependencies between the resources for you.
*
* For more information about this product, go to the <a href=
* "http://aws.amazon.com/cloudformation/">CloudFormation Product Page</a>.
*
* Amazon CloudFormation makes use of other AWS products. If you need additional technical
* information about a specific AWS product, you can find the product's technical documentation at
* <a href="http://aws.amazon.com/documentation/">http://aws.amazon.com/documentation/</a>.
*
* @version 2013.02.27
* @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/cloudformation/ AWS CloudFormation
* @link http://aws.amazon.com/cloudformation/documentation/ AWS CloudFormation documentation
*/
class AmazonCloudFormation extends CFRuntime
{
/*%******************************************************************************************%*/
// CLASS CONSTANTS
/**
* Specify the queue URL for the United States East (Northern Virginia) Region.
*/
const REGION_US_E1 = 'cloudformation.us-east-1.amazonaws.com';
/**
* Specify the queue URL for the United States East (Northern Virginia) Region.
*/
const REGION_VIRGINIA = self::REGION_US_E1;
/**
* Specify the queue URL for the United States West (Northern California) Region.
*/
const REGION_US_W1 = 'cloudformation.us-west-1.amazonaws.com';
/**
* Specify the queue URL for the United States West (Northern California) Region.
*/
const REGION_CALIFORNIA = self::REGION_US_W1;
/**
* Specify the queue URL for the United States West (Oregon) Region.
*/
const REGION_US_W2 = 'cloudformation.us-west-2.amazonaws.com';
/**
* Specify the queue URL for the United States West (Oregon) Region.
*/
const REGION_OREGON = self::REGION_US_W2;
/**
* Specify the queue URL for the Europe West (Ireland) Region.
*/
const REGION_EU_W1 = 'cloudformation.eu-west-1.amazonaws.com';
/**
* Specify the queue URL for the Europe West (Ireland) Region.
*/
const REGION_IRELAND = self::REGION_EU_W1;
/**
* Specify the queue URL for the Asia Pacific Southeast (Singapore) Region.
*/
const REGION_APAC_SE1 = 'cloudformation.ap-southeast-1.amazonaws.com';
/**
* Specify the queue URL for the Asia Pacific Southeast (Singapore) Region.
*/
const REGION_SINGAPORE = self::REGION_APAC_SE1;
/**
* Specify the queue URL for the Asia Pacific Southeast (Singapore) Region.
*/
const REGION_APAC_SE2 = 'cloudformation.ap-southeast-2.amazonaws.com';
/**
* Specify the queue URL for the Asia Pacific Southeast (Singapore) Region.
*/
const REGION_SYDNEY = self::REGION_APAC_SE2;
/**
* Specify the queue URL for the Asia Pacific Northeast (Tokyo) Region.
*/
const REGION_APAC_NE1 = 'cloudformation.ap-northeast-1.amazonaws.com';
/**
* Specify the queue URL for the Asia Pacific Northeast (Tokyo) Region.
*/
const REGION_TOKYO = self::REGION_APAC_NE1;
/**
* Specify the queue URL for the South America (Sao Paulo) Region.
*/
const REGION_SA_E1 = 'cloudformation.sa-east-1.amazonaws.com';
/**
* Specify the queue URL for the South America (Sao Paulo) Region.
*/
const REGION_SAO_PAULO = self::REGION_SA_E1;
/**
* Default service endpoint.
*/
const DEFAULT_URL = self::REGION_US_E1;
/*%******************************************************************************************%*/
// CONSTRUCTOR
/**
* Constructs a new instance of <AmazonCloudFormation>.
*
* @param array $options (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>certificate_authority</code> - <code>boolean</code> - Optional - Determines which Cerificate Authority file to use. A value of boolean <code>false</code> will use the Certificate Authority file available on the system. A value of boolean <code>true</code> will use the Certificate Authority provided by the SDK. Passing a file system path to a Certificate Authority file (chmodded to <code>0755</code>) will use that. Leave this set to <code>false</code> if you're not sure.</li>
* <li><code>credentials</code> - <code>string</code> - Optional - The name of the credential set to use for authentication.</li>
* <li><code>default_cache_config</code> - <code>string</code> - Optional - This option allows a preferred storage type to be configured for long-term caching. This can be changed later using the <set_cache_config()> method. Valid values are: <code>apc</code>, <code>xcache</code>, or a file system path such as <code>./cache</code> or <code>/tmp/cache/</code>.</li>
* <li><code>key</code> - <code>string</code> - Optional - Your AWS key, or a session key. If blank, the default credential set will be used.</li>
* <li><code>secret</code> - <code>string</code> - Optional - Your AWS secret key, or a session secret key. If blank, the default credential set will be used.</li>
* <li><code>token</code> - <code>string</code> - Optional - An AWS session token.</li></ul>
* @return void
*/
public function __construct(array $options = array())
{
$this->api_version = '2010-05-15';
$this->hostname = self::DEFAULT_URL;
$this->auth_class = 'AuthV4Query';
return parent::__construct($options);
}
/*%******************************************************************************************%*/
// 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 <REGION_US_E1>, <REGION_US_W1>, <REGION_US_W2>, <REGION_EU_W1>, <REGION_APAC_SE1>, <REGION_APAC_SE2>, <REGION_APAC_NE1>, <REGION_SA_E1>.
* @return $this A reference to the current instance.
*/
public function set_region($region)
{
// @codeCoverageIgnoreStart
$this->set_hostname($region);
return $this;
// @codeCoverageIgnoreEnd
}
/*%******************************************************************************************%*/
// SERVICE METHODS
/**
* Cancels an update on the specified stack. If the call completes successfully, the stack will
* roll back the update and revert to the previous stack configuration.
*
* <p class="note">
* Only stacks that are in the UPDATE_IN_PROGRESS state can be canceled.
* </p>
*
* @param string $stack_name (Required) The name or the unique identifier associated with the stack.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function cancel_update_stack($stack_name, $opt = null)
{
if (!$opt) $opt = array();
$opt['StackName'] = $stack_name;
return $this->authenticate('CancelUpdateStack', $opt);
}
/**
* Creates a stack as specified in the template. After the call completes successfully, the stack
* creation starts. You can check the status of the stack via the <code>DescribeStacks</code> API.
*
* <p class="note">
* Currently, the limit for stacks is 20 stacks per account per region.
* </p>
*
* @param string $stack_name (Required) The name associated with the stack. The name must be unique within your AWS account. <p class="note">Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.</p>
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>TemplateBody</code> - <code>string</code> - Optional - Structure containing the template body. (For more information, go to the <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide">AWS CloudFormation User Guide</a>.) Conditional: You must pass <code>TemplateBody</code> or <code>TemplateURL</code>. If both are passed, only <code>TemplateBody</code> is used.</li>
* <li><code>TemplateURL</code> - <code>string</code> - Optional - Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes) located in an S3 bucket in the same region as the stack. For more information, go to the <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide">AWS CloudFormation User Guide</a>. Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</li>
* <li><code>Parameters</code> - <code>array</code> - Optional - A list of <code>Parameter</code> structures that specify input parameters for the stack. <ul>
* <li><code>x</code> - <code>array</code> - Optional - This represents a simple array index. <ul>
* <li><code>ParameterKey</code> - <code>string</code> - Optional - The key associated with the parameter.</li>
* <li><code>ParameterValue</code> - <code>string</code> - Optional - The value associated with the parameter.</li>
* </ul></li>
* </ul></li>
* <li><code>DisableRollback</code> - <code>boolean</code> - Optional - Set to <code>true</code> to disable rollback of the stack if stack creation failed. You can specify either <code>DisableRollback</code> or <code>OnFailure</code>, but not both. Default: <code>false</code></li>
* <li><code>TimeoutInMinutes</code> - <code>integer</code> - Optional - The amount of time that can pass before the stack status becomes CREATE_FAILED; if <code>DisableRollback</code> is not set or is set to <code>false</code>, the stack will be rolled back.</li>
* <li><code>NotificationARNs</code> - <code>string|array</code> - Optional - The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the <a href="http://console.aws.amazon.com/sns">SNS console</a> or your Command Line Interface (CLI). Pass a string for a single value, or an indexed array for multiple values.</li>
* <li><code>Capabilities</code> - <code>string|array</code> - Optional - The list of capabilities that you want to allow in the stack. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities error. IAM resources are the following: <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html">AWS::IAM::AccessKey</a>, <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html">AWS::IAM::Group</a>, <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html">AWS::IAM::Policy</a>, <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html">AWS::IAM::User</a>, and <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">AWS::IAM::UserToGroupAddition</a>. Pass a string for a single value, or an indexed array for multiple values.</li>
* <li><code>OnFailure</code> - <code>string</code> - Optional - Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either <code>OnFailure</code> or <code>DisableRollback</code>, but not both. Default: <code>ROLLBACK</code> [Allowed values: <code>DO_NOTHING</code>, <code>ROLLBACK</code>, <code>DELETE</code>]</li>
* <li><code>Tags</code> - <code>array</code> - Optional - A set of user-defined <code>Tags</code> to associate with this stack, represented by key/value pairs. Tags defined for the stack are propogated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can be specified. <ul>
* <li><code>x</code> - <code>array</code> - Optional - This represents a simple array index. <ul>
* <li><code>Key</code> - <code>string</code> - Optional - <em>Required</em>. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: <code>aws:</code>.</li>
* <li><code>Value</code> - <code>string</code> - Optional - <em>Required</em>. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.</li>
* </ul></li>
* </ul></li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function create_stack($stack_name, $opt = null)
{
if (!$opt) $opt = array();
$opt['StackName'] = $stack_name;
// Optional list + map
if (isset($opt['Parameters']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Parameters' => $opt['Parameters']
), 'member'));
unset($opt['Parameters']);
}
// Optional list (non-map)
if (isset($opt['NotificationARNs']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'NotificationARNs' => (is_array($opt['NotificationARNs']) ? $opt['NotificationARNs'] : array($opt['NotificationARNs']))
), 'member'));
unset($opt['NotificationARNs']);
}
// Optional list (non-map)
if (isset($opt['Capabilities']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Capabilities' => (is_array($opt['Capabilities']) ? $opt['Capabilities'] : array($opt['Capabilities']))
), 'member'));
unset($opt['Capabilities']);
}
// Optional list + map
if (isset($opt['Tags']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Tags' => $opt['Tags']
), 'member'));
unset($opt['Tags']);
}
return $this->authenticate('CreateStack', $opt);
}
/**
* Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted
* stacks do not show up in the <code>DescribeStacks</code> API if the deletion has been completed
* successfully.
*
* @param string $stack_name (Required) The name or the unique identifier associated with the stack.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function delete_stack($stack_name, $opt = null)
{
if (!$opt) $opt = array();
$opt['StackName'] = $stack_name;
return $this->authenticate('DeleteStack', $opt);
}
/**
* Returns all the stack related events for the AWS account. If <code>StackName</code> is
* specified, returns events related to all the stacks with the given name. If
* <code>StackName</code> is not specified, returns all the events for the account. For more
* information about a stack's event history, go to the <a href=
* "http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide">AWS CloudFormation User
* Guide</a>.
*
* <p class="note">
* Events are returned, even if the stack never existed or has been successfully deleted.
* </p>
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>StackName</code> - <code>string</code> - Optional - The name or the unique identifier associated with the stack. Default: There is no default value.</li>
* <li><code>NextToken</code> - <code>string</code> - Optional - String that identifies the start of the next list of events, if there is one. Default: There is no default value.</li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function describe_stack_events($opt = null)
{
if (!$opt) $opt = array();
return $this->authenticate('DescribeStackEvents', $opt);
}
/**
* Returns a description of the specified resource in the specified stack.
*
* For deleted stacks, DescribeStackResource returns resource information for up to 90 days after
* the stack has been deleted.
*
* @param string $stack_name (Required) The name or the unique identifier associated with the stack. Default: There is no default value.
* @param string $logical_resource_id (Required) The logical name of the resource as specified in the template. Default: There is no default value.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function describe_stack_resource($stack_name, $logical_resource_id, $opt = null)
{
if (!$opt) $opt = array();
$opt['StackName'] = $stack_name;
$opt['LogicalResourceId'] = $logical_resource_id;
return $this->authenticate('DescribeStackResource', $opt);
}
/**
* Returns AWS resource descriptions for running and deleted stacks. If <code>StackName</code> is
* specified, all the associated resources that are part of the stack are returned. If
* <code>PhysicalResourceId</code> is specified, the associated resources of the stack that the
* resource belongs to are returned.
*
* <p class="note">
* Only the first 100 resources will be returned. If your stack has more resources than this, you
* should use <code>ListStackResources</code> instead.
* </p>
* For deleted stacks, <code>DescribeStackResources</code> returns resource information for up to
* 90 days after the stack has been deleted.
*
* You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but not
* both. In addition, you can specify <code>LogicalResourceId</code> to filter the returned
* result. For more information about resources, the <code>LogicalResourceId</code> and
* <code>PhysicalResourceId</code>, go to the <a href=
* "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide">AWS CloudFormation User
* Guide</a>.
*
* <p class="note">
* A <code>ValidationError</code> is returned if you specify both <code>StackName</code> and
* <code>PhysicalResourceId</code> in the same request.
* </p>
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>StackName</code> - <code>string</code> - Optional - The name or the unique identifier associated with the stack. Required: Conditional. If you do not specify <code>StackName</code>, you must specify <code>PhysicalResourceId</code>. Default: There is no default value.</li>
* <li><code>LogicalResourceId</code> - <code>string</code> - Optional - The logical name of the resource as specified in the template. Default: There is no default value.</li>
* <li><code>PhysicalResourceId</code> - <code>string</code> - Optional - The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. For example, for an Amazon Elastic Compute Cloud (EC2) instance, <code>PhysicalResourceId</code> corresponds to the <code>InstanceId</code>. You can pass the EC2 <code>InstanceId</code> to <code>DescribeStackResources</code> to find which stack the instance belongs to and what other resources are part of the stack. Required: Conditional. If you do not specify <code>PhysicalResourceId</code>, you must specify <code>StackName</code>. Default: There is no default value.</li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function describe_stack_resources($opt = null)
{
if (!$opt) $opt = array();
return $this->authenticate('DescribeStackResources', $opt);
}
/**
* Returns the description for the specified stack; if no stack name was specified, then it
* returns the description for all the stacks created.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>StackName</code> - <code>string</code> - Optional - The name or the unique identifier associated with the stack. Default: There is no default value.</li>
* <li><code>NextToken</code> - <code>string</code> - Optional - </li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function describe_stacks($opt = null)
{
if (!$opt) $opt = array();
return $this->authenticate('DescribeStacks', $opt);
}
/**
* Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly
* Calculator URL with a query string that describes the resources required to run the template.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>TemplateBody</code> - <code>string</code> - Optional - Structure containing the template body. (For more information, go to the <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide">AWS CloudFormation User Guide</a>.) Conditional: You must pass <code>TemplateBody</code> or <code>TemplateURL</code>. If both are passed, only <code>TemplateBody</code> is used.</li>
* <li><code>TemplateURL</code> - <code>string</code> - Optional - Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For more information, go to the <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide">AWS CloudFormation User Guide</a>. Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</li>
* <li><code>Parameters</code> - <code>array</code> - Optional - A list of <code>Parameter</code> structures that specify input parameters. <ul>
* <li><code>x</code> - <code>array</code> - Optional - This represents a simple array index. <ul>
* <li><code>ParameterKey</code> - <code>string</code> - Optional - The key associated with the parameter.</li>
* <li><code>ParameterValue</code> - <code>string</code> - Optional - The value associated with the parameter.</li>
* </ul></li>
* </ul></li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function estimate_template_cost($opt = null)
{
if (!$opt) $opt = array();
// Optional list + map
if (isset($opt['Parameters']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Parameters' => $opt['Parameters']
), 'member'));
unset($opt['Parameters']);
}
return $this->authenticate('EstimateTemplateCost', $opt);
}
/**
* Returns the template body for a specified stack name. You can get the template for running or
* deleted stacks.
*
* For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been
* deleted.
*
* <p class="note">
* If the template does not exist, a <code>ValidationError</code> is returned.
* </p>
*
* @param string $stack_name (Required) The name or the unique identifier associated with the stack.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function get_template($stack_name, $opt = null)
{
if (!$opt) $opt = array();
$opt['StackName'] = $stack_name;
return $this->authenticate('GetTemplate', $opt);
}
/**
* Returns descriptions of all resources of the specified stack.
*
* For deleted stacks, ListStackResources returns resource information for up to 90 days after the
* stack has been deleted.
*
* @param string $stack_name (Required) The name or the unique identifier associated with the stack. Default: There is no default value.
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>NextToken</code> - <code>string</code> - Optional - String that identifies the start of the next list of stack resource summaries, if there is one. Default: There is no default value.</li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function list_stack_resources($stack_name, $opt = null)
{
if (!$opt) $opt = array();
$opt['StackName'] = $stack_name;
return $this->authenticate('ListStackResources', $opt);
}
/**
* Returns the summary information for stacks whose status matches the specified
* StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days
* after the stack is deleted. If no StackStatusFilter is specified, summary information for all
* stacks is returned (including existing stacks and stacks that have been deleted).
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>NextToken</code> - <code>string</code> - Optional - String that identifies the start of the next list of stacks, if there is one. Default: There is no default value.</li>
* <li><code>StackStatusFilter</code> - <code>string|array</code> - Optional - Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the <code>StackStatus</code> parameter of the <code>Stack</code> data type. Pass a string for a single value, or an indexed array for multiple values.</li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function list_stacks($opt = null)
{
if (!$opt) $opt = array();
// Optional list (non-map)
if (isset($opt['StackStatusFilter']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'StackStatusFilter' => (is_array($opt['StackStatusFilter']) ? $opt['StackStatusFilter'] : array($opt['StackStatusFilter']))
), 'member'));
unset($opt['StackStatusFilter']);
}
return $this->authenticate('ListStacks', $opt);
}
/**
* Updates a stack as specified in the template. After the call completes successfully, the stack
* update starts. You can check the status of the stack via the <code>DescribeStacks</code>
* action.
*
* To get a copy of the template for an existing stack, you can use the <code>GetTemplate</code>
* action.
*
* Tags that were associated with this stack during creation time will still be associated with
* the stack after an <code>UpdateStack</code> operation.
*
* For more information about creating an update template, updating a stack, and monitoring the
* progress of the update, see <a href=
* "http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html">
* Updating a Stack</a>.
*
* @param string $stack_name (Required) The name or stack ID of the stack to update. <p class="note">Must contain only alphanumeric characters (case sensitive) and start with an alpha character. Maximum length of the name is 255 characters.</p>
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>TemplateBody</code> - <code>string</code> - Optional - Structure containing the template body. (For more information, go to the <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide">AWS CloudFormation User Guide</a>.) Conditional: You must pass <code>TemplateBody</code> or <code>TemplateURL</code>. If both are passed, only <code>TemplateBody</code> is used.</li>
* <li><code>TemplateURL</code> - <code>string</code> - Optional - Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For more information, go to the <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide">AWS CloudFormation User Guide</a>. Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</li>
* <li><code>Parameters</code> - <code>array</code> - Optional - A list of <code>Parameter</code> structures that specify input parameters for the stack. <ul>
* <li><code>x</code> - <code>array</code> - Optional - This represents a simple array index. <ul>
* <li><code>ParameterKey</code> - <code>string</code> - Optional - The key associated with the parameter.</li>
* <li><code>ParameterValue</code> - <code>string</code> - Optional - The value associated with the parameter.</li>
* </ul></li>
* </ul></li>
* <li><code>Capabilities</code> - <code>string|array</code> - Optional - The list of capabilities that you want to allow in the stack. If your stack contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter; otherwise, this action returns an InsufficientCapabilities error. IAM resources are the following: <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html">AWS::IAM::AccessKey</a>, <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html">AWS::IAM::Group</a>, <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html">AWS::IAM::Policy</a>, <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html">AWS::IAM::User</a>, and <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html">AWS::IAM::UserToGroupAddition</a>. Pass a string for a single value, or an indexed array for multiple values.</li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function update_stack($stack_name, $opt = null)
{
if (!$opt) $opt = array();
$opt['StackName'] = $stack_name;
// Optional list + map
if (isset($opt['Parameters']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Parameters' => $opt['Parameters']
), 'member'));
unset($opt['Parameters']);
}
// Optional list (non-map)
if (isset($opt['Capabilities']))
{
$opt = array_merge($opt, CFComplexType::map(array(
'Capabilities' => (is_array($opt['Capabilities']) ? $opt['Capabilities'] : array($opt['Capabilities']))
), 'member'));
unset($opt['Capabilities']);
}
return $this->authenticate('UpdateStack', $opt);
}
/**
* Validates a specified template.
*
* @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
* <li><code>TemplateBody</code> - <code>string</code> - Optional - String containing the template body. (For more information, go to the <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide">AWS CloudFormation User Guide</a>.) Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</li>
* <li><code>TemplateURL</code> - <code>string</code> - Optional - Location of file containing the template body. The URL must point to a template (max size: 307,200 bytes) located in an S3 bucket in the same region as the stack. For more information, go to the <a href="http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide">AWS CloudFormation User Guide</a>. Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</li>
* <li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
* <li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
* @return CFResponse A <CFResponse> object containing a parsed HTTP response.
*/
public function validate_template($opt = null)
{
if (!$opt) $opt = array();
return $this->authenticate('ValidateTemplate', $opt);
}
}
/*%******************************************************************************************%*/
// EXCEPTIONS
class CloudFormation_Exception extends Exception {}