openstack/openstack-manuals
Code Issues Proposed changes

Merge "Rebuild the hot-ref with new IDs"

Browse Source
This commit is contained in:
Jenkins 2014-10-13 18:33:09 +00:00 committed by Gerrit Code Review
commit ccf326217d
3 changed files with 522 additions and 522 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

272
doc/hot-reference/generated/cfn.xml
View File

@ -10,14 +10,14 @@ distributed under the License 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.-->
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="cfn_cloudformation-compatible-resource-types">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="cloudformation-compatible-resource-types">
<!--WARNING: This file is automatically generated. Do not edit it.-->
<title>CloudFormation Compatible Resource Types</title>
<section xml:id="cfn_AWS__AutoScaling__AutoScalingGroup">
<section xml:id="AWS__AutoScaling__AutoScalingGroup">
<?dbhtml stop-chunking?>
<title>AWS::AutoScaling::AutoScalingGroup</title>
<para>Available since 2014.1 (Icehouse).</para>
<section xml:id="cfn_AWS__AutoScaling__AutoScalingGroup-props">
<section xml:id="AWS__AutoScaling__AutoScalingGroup-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -154,7 +154,7 @@ under the License.-->
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__AutoScaling__AutoScalingGroup-attrs">
<section xml:id="AWS__AutoScaling__AutoScalingGroup-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
@ -165,7 +165,7 @@ under the License.-->
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__AutoScaling__AutoScalingGroup-hot">
<section xml:id="AWS__AutoScaling__AutoScalingGroup-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -184,7 +184,7 @@ resources:
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
VPCZoneIdentifier: [String, String, ...]</programlisting>
</section>
<section xml:id="cfn_AWS__AutoScaling__AutoScalingGroup-yaml">
<section xml:id="AWS__AutoScaling__AutoScalingGroup-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -203,7 +203,7 @@ Resources:
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
VPCZoneIdentifier: [String, String, ...]</programlisting>
</section>
<section xml:id="cfn_AWS__AutoScaling__AutoScalingGroup-json">
<section xml:id="AWS__AutoScaling__AutoScalingGroup-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -227,10 +227,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__AutoScaling__LaunchConfiguration">
<section xml:id="AWS__AutoScaling__LaunchConfiguration">
<?dbhtml stop-chunking?>
<title>AWS::AutoScaling::LaunchConfiguration</title>
<section xml:id="cfn_AWS__AutoScaling__LaunchConfiguration-props">
<section xml:id="AWS__AutoScaling__LaunchConfiguration-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -434,7 +434,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__AutoScaling__LaunchConfiguration-hot">
<section xml:id="AWS__AutoScaling__LaunchConfiguration-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -451,7 +451,7 @@ resources:
SecurityGroups: [Value, Value, ...]
UserData: String</programlisting>
</section>
<section xml:id="cfn_AWS__AutoScaling__LaunchConfiguration-yaml">
<section xml:id="AWS__AutoScaling__LaunchConfiguration-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -468,7 +468,7 @@ Resources:
SecurityGroups: [Value, Value, ...]
UserData: String</programlisting>
</section>
<section xml:id="cfn_AWS__AutoScaling__LaunchConfiguration-json">
<section xml:id="AWS__AutoScaling__LaunchConfiguration-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -490,10 +490,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__AutoScaling__ScalingPolicy">
<section xml:id="AWS__AutoScaling__ScalingPolicy">
<?dbhtml stop-chunking?>
<title>AWS::AutoScaling::ScalingPolicy</title>
<section xml:id="cfn_AWS__AutoScaling__ScalingPolicy-props">
<section xml:id="AWS__AutoScaling__ScalingPolicy-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -531,7 +531,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__AutoScaling__ScalingPolicy-attrs">
<section xml:id="AWS__AutoScaling__ScalingPolicy-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
@ -542,7 +542,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__AutoScaling__ScalingPolicy-hot">
<section xml:id="AWS__AutoScaling__ScalingPolicy-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -556,7 +556,7 @@ resources:
Cooldown: Number
ScalingAdjustment: Number</programlisting>
</section>
<section xml:id="cfn_AWS__AutoScaling__ScalingPolicy-yaml">
<section xml:id="AWS__AutoScaling__ScalingPolicy-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -570,7 +570,7 @@ Resources:
Cooldown: Number
ScalingAdjustment: Number</programlisting>
</section>
<section xml:id="cfn_AWS__AutoScaling__ScalingPolicy-json">
<section xml:id="AWS__AutoScaling__ScalingPolicy-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -589,11 +589,11 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__CloudFormation__Stack">
<section xml:id="AWS__CloudFormation__Stack">
<?dbhtml stop-chunking?>
<title>AWS::CloudFormation::Stack</title>
<para>A Resource representing a child stack to allow composition of templates.</para>
<section xml:id="cfn_AWS__CloudFormation__Stack-props">
<section xml:id="AWS__CloudFormation__Stack-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -622,7 +622,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__CloudFormation__Stack-hot">
<section xml:id="AWS__CloudFormation__Stack-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -635,7 +635,7 @@ resources:
TemplateURL: String
TimeoutInMinutes: Number</programlisting>
</section>
<section xml:id="cfn_AWS__CloudFormation__Stack-yaml">
<section xml:id="AWS__CloudFormation__Stack-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -648,7 +648,7 @@ Resources:
TemplateURL: String
TimeoutInMinutes: Number</programlisting>
</section>
<section xml:id="cfn_AWS__CloudFormation__Stack-json">
<section xml:id="AWS__CloudFormation__Stack-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -666,11 +666,11 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__CloudFormation__WaitCondition">
<section xml:id="AWS__CloudFormation__WaitCondition">
<?dbhtml stop-chunking?>
<title>AWS::CloudFormation::WaitCondition</title>
<para>Available since 2014.2 (Juno).</para>
<section xml:id="cfn_AWS__CloudFormation__WaitCondition-props">
<section xml:id="AWS__CloudFormation__WaitCondition-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -701,7 +701,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__CloudFormation__WaitCondition-attrs">
<section xml:id="AWS__CloudFormation__WaitCondition-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
@ -712,7 +712,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__CloudFormation__WaitCondition-hot">
<section xml:id="AWS__CloudFormation__WaitCondition-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -725,7 +725,7 @@ resources:
Handle: String
Timeout: Number</programlisting>
</section>
<section xml:id="cfn_AWS__CloudFormation__WaitCondition-yaml">
<section xml:id="AWS__CloudFormation__WaitCondition-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -738,7 +738,7 @@ Resources:
Handle: String
Timeout: Number</programlisting>
</section>
<section xml:id="cfn_AWS__CloudFormation__WaitCondition-json">
<section xml:id="AWS__CloudFormation__WaitCondition-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -756,7 +756,7 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__CloudFormation__WaitConditionHandle">
<section xml:id="AWS__CloudFormation__WaitConditionHandle">
<?dbhtml stop-chunking?>
<title>AWS::CloudFormation::WaitConditionHandle</title>
<para>the main point of this class is to :
@ -765,7 +765,7 @@ generate a unique url (to be returned in the reference)
then the cfn-signal will use this url to post to and
WaitCondition will poll it to see if has been written to.</para>
<para>Available since 2014.2 (Juno).</para>
<section xml:id="cfn_AWS__CloudFormation__WaitConditionHandle-hot">
<section xml:id="AWS__CloudFormation__WaitConditionHandle-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -774,7 +774,7 @@ resources:
the_resource:
type: AWS::CloudFormation::WaitConditionHandle</programlisting>
</section>
<section xml:id="cfn_AWS__CloudFormation__WaitConditionHandle-yaml">
<section xml:id="AWS__CloudFormation__WaitConditionHandle-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -783,7 +783,7 @@ Resources:
TheResource:
Type: AWS::CloudFormation::WaitConditionHandle</programlisting>
</section>
<section xml:id="cfn_AWS__CloudFormation__WaitConditionHandle-json">
<section xml:id="AWS__CloudFormation__WaitConditionHandle-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -796,10 +796,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__CloudWatch__Alarm">
<section xml:id="AWS__CloudWatch__Alarm">
<?dbhtml stop-chunking?>
<title>AWS::CloudWatch::Alarm</title>
<section xml:id="cfn_AWS__CloudWatch__Alarm-props">
<section xml:id="AWS__CloudWatch__Alarm-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -898,7 +898,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__CloudWatch__Alarm-hot">
<section xml:id="AWS__CloudWatch__Alarm-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -921,7 +921,7 @@ resources:
Threshold: String
Units: String</programlisting>
</section>
<section xml:id="cfn_AWS__CloudWatch__Alarm-yaml">
<section xml:id="AWS__CloudWatch__Alarm-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -944,7 +944,7 @@ Resources:
Threshold: String
Units: String</programlisting>
</section>
<section xml:id="cfn_AWS__CloudWatch__Alarm-json">
<section xml:id="AWS__CloudWatch__Alarm-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -972,10 +972,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__EC2__EIP">
<section xml:id="AWS__EC2__EIP">
<?dbhtml stop-chunking?>
<title>AWS::EC2::EIP</title>
<section xml:id="cfn_AWS__EC2__EIP-props">
<section xml:id="AWS__EC2__EIP-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -997,7 +997,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__EC2__EIP-attrs">
<section xml:id="AWS__EC2__EIP-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
@ -1008,7 +1008,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__EC2__EIP-hot">
<section xml:id="AWS__EC2__EIP-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -1020,7 +1020,7 @@ resources:
Domain: String
InstanceId: String</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__EIP-yaml">
<section xml:id="AWS__EC2__EIP-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -1032,7 +1032,7 @@ Resources:
Domain: String
InstanceId: String</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__EIP-json">
<section xml:id="AWS__EC2__EIP-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -1049,10 +1049,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__EC2__EIPAssociation">
<section xml:id="AWS__EC2__EIPAssociation">
<?dbhtml stop-chunking?>
<title>AWS::EC2::EIPAssociation</title>
<section xml:id="cfn_AWS__EC2__EIPAssociation-props">
<section xml:id="AWS__EC2__EIPAssociation-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -1089,7 +1089,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__EC2__EIPAssociation-hot">
<section xml:id="AWS__EC2__EIPAssociation-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -1103,7 +1103,7 @@ resources:
InstanceId: String
NetworkInterfaceId: String</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__EIPAssociation-yaml">
<section xml:id="AWS__EC2__EIPAssociation-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -1117,7 +1117,7 @@ Resources:
InstanceId: String
NetworkInterfaceId: String</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__EIPAssociation-json">
<section xml:id="AWS__EC2__EIPAssociation-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -1136,10 +1136,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__EC2__Instance">
<section xml:id="AWS__EC2__Instance">
<?dbhtml stop-chunking?>
<title>AWS::EC2::Instance</title>
<section xml:id="cfn_AWS__EC2__Instance-props">
<section xml:id="AWS__EC2__Instance-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -1503,7 +1503,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__EC2__Instance-attrs">
<section xml:id="AWS__EC2__Instance-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
@ -1538,7 +1538,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__EC2__Instance-hot">
<section xml:id="AWS__EC2__Instance-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -1561,7 +1561,7 @@ resources:
UserData: String
Volumes: [{"Device": String, "VolumeId": String}, {"Device": String, "VolumeId": String}, ...]</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__Instance-yaml">
<section xml:id="AWS__EC2__Instance-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -1584,7 +1584,7 @@ Resources:
UserData: String
Volumes: [{"Device": String, "VolumeId": String}, {"Device": String, "VolumeId": String}, ...]</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__Instance-json">
<section xml:id="AWS__EC2__Instance-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -1612,10 +1612,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__EC2__InternetGateway">
<section xml:id="AWS__EC2__InternetGateway">
<?dbhtml stop-chunking?>
<title>AWS::EC2::InternetGateway</title>
<section xml:id="cfn_AWS__EC2__InternetGateway-props">
<section xml:id="AWS__EC2__InternetGateway-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -1640,7 +1640,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__EC2__InternetGateway-hot">
<section xml:id="AWS__EC2__InternetGateway-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -1651,7 +1651,7 @@ resources:
properties:
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__InternetGateway-yaml">
<section xml:id="AWS__EC2__InternetGateway-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -1662,7 +1662,7 @@ Resources:
Properties:
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__InternetGateway-json">
<section xml:id="AWS__EC2__InternetGateway-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -1678,10 +1678,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__EC2__NetworkInterface">
<section xml:id="AWS__EC2__NetworkInterface">
<?dbhtml stop-chunking?>
<title>AWS::EC2::NetworkInterface</title>
<section xml:id="cfn_AWS__EC2__NetworkInterface-props">
<section xml:id="AWS__EC2__NetworkInterface-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -1745,7 +1745,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__EC2__NetworkInterface-attrs">
<section xml:id="AWS__EC2__NetworkInterface-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
@ -1756,7 +1756,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__EC2__NetworkInterface-hot">
<section xml:id="AWS__EC2__NetworkInterface-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -1771,7 +1771,7 @@ resources:
SubnetId: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__NetworkInterface-yaml">
<section xml:id="AWS__EC2__NetworkInterface-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -1786,7 +1786,7 @@ Resources:
SubnetId: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__NetworkInterface-json">
<section xml:id="AWS__EC2__NetworkInterface-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -1806,11 +1806,11 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__EC2__RouteTable">
<section xml:id="AWS__EC2__RouteTable">
<?dbhtml stop-chunking?>
<title>AWS::EC2::RouteTable</title>
<para>Available since 2014.1 (Icehouse).</para>
<section xml:id="cfn_AWS__EC2__RouteTable-props">
<section xml:id="AWS__EC2__RouteTable-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -1843,7 +1843,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__EC2__RouteTable-hot">
<section xml:id="AWS__EC2__RouteTable-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -1855,7 +1855,7 @@ resources:
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
VpcId: String</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__RouteTable-yaml">
<section xml:id="AWS__EC2__RouteTable-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -1867,7 +1867,7 @@ Resources:
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
VpcId: String</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__RouteTable-json">
<section xml:id="AWS__EC2__RouteTable-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -1884,10 +1884,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__EC2__SecurityGroup">
<section xml:id="AWS__EC2__SecurityGroup">
<?dbhtml stop-chunking?>
<title>AWS::EC2::SecurityGroup</title>
<section xml:id="cfn_AWS__EC2__SecurityGroup-props">
<section xml:id="AWS__EC2__SecurityGroup-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -2058,7 +2058,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__EC2__SecurityGroup-hot">
<section xml:id="AWS__EC2__SecurityGroup-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -2072,7 +2072,7 @@ resources:
SecurityGroupIngress: [{"CidrIp": String, "SourceSecurityGroupId": String, "FromPort": String, "SourceSecurityGroupName": String, "ToPort": String, "IpProtocol": String}, {"CidrIp": String, "SourceSecurityGroupId": String, "FromPort": String, "SourceSecurityGroupName": String, "ToPort": String, "IpProtocol": String}, ...]
VpcId: String</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__SecurityGroup-yaml">
<section xml:id="AWS__EC2__SecurityGroup-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -2086,7 +2086,7 @@ Resources:
SecurityGroupIngress: [{"CidrIp": String, "SourceSecurityGroupId": String, "FromPort": String, "SourceSecurityGroupName": String, "ToPort": String, "IpProtocol": String}, {"CidrIp": String, "SourceSecurityGroupId": String, "FromPort": String, "SourceSecurityGroupName": String, "ToPort": String, "IpProtocol": String}, ...]
VpcId: String</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__SecurityGroup-json">
<section xml:id="AWS__EC2__SecurityGroup-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -2105,10 +2105,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__EC2__Subnet">
<section xml:id="AWS__EC2__Subnet">
<?dbhtml stop-chunking?>
<title>AWS::EC2::Subnet</title>
<section xml:id="cfn_AWS__EC2__Subnet-props">
<section xml:id="AWS__EC2__Subnet-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -2157,7 +2157,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__EC2__Subnet-attrs">
<section xml:id="AWS__EC2__Subnet-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
@ -2168,7 +2168,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__EC2__Subnet-hot">
<section xml:id="AWS__EC2__Subnet-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -2182,7 +2182,7 @@ resources:
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
VpcId: String</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__Subnet-yaml">
<section xml:id="AWS__EC2__Subnet-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -2196,7 +2196,7 @@ Resources:
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
VpcId: String</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__Subnet-json">
<section xml:id="AWS__EC2__Subnet-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -2215,10 +2215,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__EC2__SubnetRouteTableAssociation">
<section xml:id="AWS__EC2__SubnetRouteTableAssociation">
<?dbhtml stop-chunking?>
<title>AWS::EC2::SubnetRouteTableAssociation</title>
<section xml:id="cfn_AWS__EC2__SubnetRouteTableAssociation-props">
<section xml:id="AWS__EC2__SubnetRouteTableAssociation-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -2239,7 +2239,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__EC2__SubnetRouteTableAssociation-hot">
<section xml:id="AWS__EC2__SubnetRouteTableAssociation-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -2251,7 +2251,7 @@ resources:
RouteTableId: String
SubnetId: String</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__SubnetRouteTableAssociation-yaml">
<section xml:id="AWS__EC2__SubnetRouteTableAssociation-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -2263,7 +2263,7 @@ Resources:
RouteTableId: String
SubnetId: String</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__SubnetRouteTableAssociation-json">
<section xml:id="AWS__EC2__SubnetRouteTableAssociation-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -2280,10 +2280,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__EC2__VPC">
<section xml:id="AWS__EC2__VPC">
<?dbhtml stop-chunking?>
<title>AWS::EC2::VPC</title>
<section xml:id="cfn_AWS__EC2__VPC-props">
<section xml:id="AWS__EC2__VPC-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -2324,7 +2324,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__EC2__VPC-hot">
<section xml:id="AWS__EC2__VPC-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -2336,7 +2336,7 @@ resources:
CidrBlock: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__VPC-yaml">
<section xml:id="AWS__EC2__VPC-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -2348,7 +2348,7 @@ Resources:
CidrBlock: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__VPC-json">
<section xml:id="AWS__EC2__VPC-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -2365,10 +2365,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__EC2__VPCGatewayAttachment">
<section xml:id="AWS__EC2__VPCGatewayAttachment">
<?dbhtml stop-chunking?>
<title>AWS::EC2::VPCGatewayAttachment</title>
<section xml:id="cfn_AWS__EC2__VPCGatewayAttachment-props">
<section xml:id="AWS__EC2__VPCGatewayAttachment-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -2397,7 +2397,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__EC2__VPCGatewayAttachment-hot">
<section xml:id="AWS__EC2__VPCGatewayAttachment-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -2409,7 +2409,7 @@ resources:
InternetGatewayId: String
VpcId: String</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__VPCGatewayAttachment-yaml">
<section xml:id="AWS__EC2__VPCGatewayAttachment-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -2421,7 +2421,7 @@ Resources:
InternetGatewayId: String
VpcId: String</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__VPCGatewayAttachment-json">
<section xml:id="AWS__EC2__VPCGatewayAttachment-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -2438,10 +2438,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__EC2__Volume">
<section xml:id="AWS__EC2__Volume">
<?dbhtml stop-chunking?>
<title>AWS::EC2::Volume</title>
<section xml:id="cfn_AWS__EC2__Volume-props">
<section xml:id="AWS__EC2__Volume-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -2510,7 +2510,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__EC2__Volume-hot">
<section xml:id="AWS__EC2__Volume-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -2524,7 +2524,7 @@ resources:
SnapshotId: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__Volume-yaml">
<section xml:id="AWS__EC2__Volume-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -2538,7 +2538,7 @@ Resources:
SnapshotId: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__Volume-json">
<section xml:id="AWS__EC2__Volume-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -2557,10 +2557,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__EC2__VolumeAttachment">
<section xml:id="AWS__EC2__VolumeAttachment">
<?dbhtml stop-chunking?>
<title>AWS::EC2::VolumeAttachment</title>
<section xml:id="cfn_AWS__EC2__VolumeAttachment-props">
<section xml:id="AWS__EC2__VolumeAttachment-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -2590,7 +2590,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__EC2__VolumeAttachment-hot">
<section xml:id="AWS__EC2__VolumeAttachment-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -2603,7 +2603,7 @@ resources:
InstanceId: String
VolumeId: String</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__VolumeAttachment-yaml">
<section xml:id="AWS__EC2__VolumeAttachment-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -2616,7 +2616,7 @@ Resources:
InstanceId: String
VolumeId: String</programlisting>
</section>
<section xml:id="cfn_AWS__EC2__VolumeAttachment-json">
<section xml:id="AWS__EC2__VolumeAttachment-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -2634,10 +2634,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__ElasticLoadBalancing__LoadBalancer">
<section xml:id="AWS__ElasticLoadBalancing__LoadBalancer">
<?dbhtml stop-chunking?>
<title>AWS::ElasticLoadBalancing::LoadBalancer</title>
<section xml:id="cfn_AWS__ElasticLoadBalancing__LoadBalancer-props">
<section xml:id="AWS__ElasticLoadBalancing__LoadBalancer-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -2809,7 +2809,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__ElasticLoadBalancing__LoadBalancer-attrs">
<section xml:id="AWS__ElasticLoadBalancing__LoadBalancer-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
@ -2844,7 +2844,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__ElasticLoadBalancing__LoadBalancer-hot">
<section xml:id="AWS__ElasticLoadBalancing__LoadBalancer-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -2858,7 +2858,7 @@ resources:
Instances: [Value, Value, ...]
Listeners: [{"InstancePort": Number, "LoadBalancerPort": Number, "Protocol": String}, {"InstancePort": Number, "LoadBalancerPort": Number, "Protocol": String}, ...]</programlisting>
</section>
<section xml:id="cfn_AWS__ElasticLoadBalancing__LoadBalancer-yaml">
<section xml:id="AWS__ElasticLoadBalancing__LoadBalancer-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -2872,7 +2872,7 @@ Resources:
Instances: [Value, Value, ...]
Listeners: [{"InstancePort": Number, "LoadBalancerPort": Number, "Protocol": String}, {"InstancePort": Number, "LoadBalancerPort": Number, "Protocol": String}, ...]</programlisting>
</section>
<section xml:id="cfn_AWS__ElasticLoadBalancing__LoadBalancer-json">
<section xml:id="AWS__ElasticLoadBalancing__LoadBalancer-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -2891,10 +2891,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__IAM__AccessKey">
<section xml:id="AWS__IAM__AccessKey">
<?dbhtml stop-chunking?>
<title>AWS::IAM::AccessKey</title>
<section xml:id="cfn_AWS__IAM__AccessKey-props">
<section xml:id="AWS__IAM__AccessKey-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -2923,7 +2923,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__IAM__AccessKey-attrs">
<section xml:id="AWS__IAM__AccessKey-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
@ -2940,7 +2940,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__IAM__AccessKey-hot">
<section xml:id="AWS__IAM__AccessKey-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -2951,7 +2951,7 @@ resources:
properties:
UserName: String</programlisting>
</section>
<section xml:id="cfn_AWS__IAM__AccessKey-yaml">
<section xml:id="AWS__IAM__AccessKey-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -2962,7 +2962,7 @@ Resources:
Properties:
UserName: String</programlisting>
</section>
<section xml:id="cfn_AWS__IAM__AccessKey-json">
<section xml:id="AWS__IAM__AccessKey-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -2978,10 +2978,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__IAM__User">
<section xml:id="AWS__IAM__User">
<?dbhtml stop-chunking?>
<title>AWS::IAM::User</title>
<section xml:id="cfn_AWS__IAM__User-props">
<section xml:id="AWS__IAM__User-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -3030,7 +3030,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__IAM__User-hot">
<section xml:id="AWS__IAM__User-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -3044,7 +3044,7 @@ resources:
Path: String
Policies: [Value, Value, ...]</programlisting>
</section>
<section xml:id="cfn_AWS__IAM__User-yaml">
<section xml:id="AWS__IAM__User-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -3058,7 +3058,7 @@ Resources:
Path: String
Policies: [Value, Value, ...]</programlisting>
</section>
<section xml:id="cfn_AWS__IAM__User-json">
<section xml:id="AWS__IAM__User-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -3077,10 +3077,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__RDS__DBInstance">
<section xml:id="AWS__RDS__DBInstance">
<?dbhtml stop-chunking?>
<title>AWS::RDS::DBInstance</title>
<section xml:id="cfn_AWS__RDS__DBInstance-props">
<section xml:id="AWS__RDS__DBInstance-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -3149,7 +3149,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__RDS__DBInstance-attrs">
<section xml:id="AWS__RDS__DBInstance-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
@ -3166,7 +3166,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__RDS__DBInstance-hot">
<section xml:id="AWS__RDS__DBInstance-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -3185,7 +3185,7 @@ resources:
MasterUsername: String
Port: String</programlisting>
</section>
<section xml:id="cfn_AWS__RDS__DBInstance-yaml">
<section xml:id="AWS__RDS__DBInstance-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -3204,7 +3204,7 @@ Resources:
MasterUsername: String
Port: String</programlisting>
</section>
<section xml:id="cfn_AWS__RDS__DBInstance-json">
<section xml:id="AWS__RDS__DBInstance-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
@ -3228,10 +3228,10 @@ Resources:
}</programlisting>
</section>
</section>
<section xml:id="cfn_AWS__S3__Bucket">
<section xml:id="AWS__S3__Bucket">
<?dbhtml stop-chunking?>
<title>AWS::S3::Bucket</title>
<section xml:id="cfn_AWS__S3__Bucket-props">
<section xml:id="AWS__S3__Bucket-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
@ -3315,7 +3315,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__S3__Bucket-attrs">
<section xml:id="AWS__S3__Bucket-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
@ -3332,7 +3332,7 @@ Resources:
</varlistentry>
</variablelist>
</section>
<section xml:id="cfn_AWS__S3__Bucket-hot">
<section xml:id="AWS__S3__Bucket-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
@ -3345,7 +3345,7 @@ resources:
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
WebsiteConfiguration: {"IndexDocument": String, "ErrorDocument": String}</programlisting>
</section>
<section xml:id="cfn_AWS__S3__Bucket-yaml">
<section xml:id="AWS__S3__Bucket-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
@ -3358,7 +3358,7 @@ Resources:
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
WebsiteConfiguration: {"IndexDocument": String, "ErrorDocument": String}</programlisting>
</section>
<section xml:id="cfn_AWS__S3__Bucket-json">
<section xml:id="AWS__S3__Bucket-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",

72
doc/hot-reference/generated/functions.xml
View File

@ -10,17 +10,17 @@ distributed under the License 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.-->
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="functions_cloudformation-compatible-functions">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="cloudformation-compatible-functions">
<!--WARNING: This file is automatically generated. Do not edit it.-->
<title>CloudFormation Compatible Functions</title>
<para>There are a number of functions that you can use to help you write
CloudFormation compatible templates.</para>
<para>All of these functions (except <emphasis>Ref</emphasis>) start with <emphasis>Fn::</emphasis>.</para>
<section xml:id="functions_ref">
<section xml:id="ref">
<?dbhtml stop-chunking?>
<title>Ref</title>
<para>Returns the value of the named parameter or resource.</para>
<section xml:id="functions_parameters">
<section xml:id="parameters">
<title>Parameters</title>
<variablelist role="definition_list">
<varlistentry>
@ -31,17 +31,17 @@ CloudFormation compatible templates.</para>
</varlistentry>
</variablelist>
</section>
<section xml:id="functions_usage">
<section xml:id="usage">
<title>Usage</title>
<programlisting>{Ref: my_server}</programlisting>
<para>Returns the nova instance ID. For example, <literal>d8093de0-850f-4513-b202-7979de6c0d55</literal>.</para>
</section>
</section>
<section xml:id="functions_fn-base64">
<section xml:id="fn-base64">
<?dbhtml stop-chunking?>
<title>Fn::Base64</title>
<para>This returns the Base64 representation of the input string.</para>
<section xml:id="functions_id1">
<section xml:id="id1">
<title>Parameters</title>
<variablelist role="definition_list">
<varlistentry>
@ -52,18 +52,18 @@ CloudFormation compatible templates.</para>
</varlistentry>
</variablelist>
</section>
<section xml:id="functions_id2">
<section xml:id="id2">
<title>Usage</title>
<programlisting>{Base64: "convert this string please."}</programlisting>
<para>Returns the Base64 of the input string.</para>
</section>
</section>
<section xml:id="functions_fn-findinmap">
<section xml:id="fn-findinmap">
<?dbhtml stop-chunking?>
<title>Fn::FindInMap</title>
<para>Returns the value corresponding to keys into a two-level map declared in the
Mappings section.</para>
<section xml:id="functions_id3">
<section xml:id="id3">
<title>Parameters</title>
<variablelist role="definition_list">
<varlistentry>
@ -88,7 +88,7 @@ assigned to top_level_key.</para>
</varlistentry>
</variablelist>
</section>
<section xml:id="functions_id4">
<section xml:id="id4">
<title>Usage</title>
<programlisting>Mapping:
MyContacts:
@ -99,11 +99,11 @@ assigned to top_level_key.</para>
<para>Returns <literal>908</literal>.</para>
</section>
</section>
<section xml:id="functions_fn-getatt">
<section xml:id="fn-getatt">
<?dbhtml stop-chunking?>
<title>Fn::GetAtt</title>
<para>Returns an attribute of a resource within the template.</para>
<section xml:id="functions_id5">
<section xml:id="id5">
<title>Parameters</title>
<variablelist role="definition_list">
<varlistentry>
@ -120,20 +120,20 @@ assigned to top_level_key.</para>
</varlistentry>
</variablelist>
</section>
<section xml:id="functions_id6">
<section xml:id="id6">
<title>Usage</title>
<programlisting>{Fn::GetAtt: [my_server, PublicIp]}</programlisting>
<para>Returns an IP address such as <literal>10.0.0.2</literal>.</para>
</section>
</section>
<section xml:id="functions_fn-getazs">
<section xml:id="fn-getazs">
<?dbhtml stop-chunking?>
<title>Fn::GetAZs</title>
<para>Returns the Availability Zones within the given region.</para>
<para>
<emphasis>Note: AZ's and regions are not fully implemented in Heat.</emphasis>
</para>
<section xml:id="functions_id7">
<section xml:id="id7">
<title>Parameters</title>
<variablelist role="definition_list">
<varlistentry>
@ -144,17 +144,17 @@ assigned to top_level_key.</para>
</varlistentry>
</variablelist>
</section>
<section xml:id="functions_id8">
<section xml:id="id8">
<title>Usage</title>
<programlisting>{Fn::GetAZs: ""}</programlisting>
<para>Returns the list provided by <literal>nova availability-zone-list</literal>.</para>
</section>
</section>
<section xml:id="functions_fn-join">
<section xml:id="fn-join">
<?dbhtml stop-chunking?>
<title>Fn::Join</title>
<para>Like python join, it joins a list of strings with the given delimiter.</para>
<section xml:id="functions_id9">
<section xml:id="id9">
<title>Parameters</title>
<variablelist role="definition_list">
<varlistentry>
@ -171,20 +171,20 @@ assigned to top_level_key.</para>
</varlistentry>
</variablelist>
</section>
<section xml:id="functions_id10">
<section xml:id="id10">
<title>Usage</title>
<programlisting>{Fn::Join: [",", ["beer", "wine", "more beer"]]}</programlisting>
<para>Returns <literal>beer, wine, more beer</literal>.</para>
</section>
</section>
<section xml:id="functions_fn-select">
<section xml:id="fn-select">
<?dbhtml stop-chunking?>
<title>Fn::Select</title>
<para>Select an item from a list.</para>
<para>
<emphasis>Heat extension: Select an item from a map</emphasis>
</para>
<section xml:id="functions_id11">
<section xml:id="id11">
<title>Parameters</title>
<variablelist role="definition_list">
<varlistentry>
@ -201,7 +201,7 @@ assigned to top_level_key.</para>
</varlistentry>
</variablelist>
</section>
<section xml:id="functions_id12">
<section xml:id="id12">
<title>Usage</title>
<para>For a list lookup:</para>
<programlisting>{ "Fn::Select" : [ "2", [ "apples", "grapes", "mangoes" ] ] }</programlisting>
@ -211,12 +211,12 @@ assigned to top_level_key.</para>
<para>Returns <literal>a</literal>.</para>
</section>
</section>
<section xml:id="functions_fn-split">
<section xml:id="fn-split">
<?dbhtml stop-chunking?>
<title>Fn::Split</title>
<para>This is the reverse of Join. Convert a string into a list based on the
delimiter.</para>
<section xml:id="functions_id13">
<section xml:id="id13">
<title>Parameters</title>
<variablelist role="definition_list">
<varlistentry>
@ -233,17 +233,17 @@ delimiter.</para>
</varlistentry>
</variablelist>
</section>
<section xml:id="functions_id14">
<section xml:id="id14">
<title>Usage</title>
<programlisting>{ "Fn::Split" : [ ",", "str1,str2,str3,str4"]}</programlisting>
<para>Returns <literal>{["str1", "str2", "str3", "str4"]}</literal>.</para>
</section>
</section>
<section xml:id="functions_fn-replace">
<section xml:id="fn-replace">
<?dbhtml stop-chunking?>
<title>Fn::Replace</title>
<para>Find and replace one string with another.</para>
<section xml:id="functions_id15">
<section xml:id="id15">
<title>Parameters</title>
<variablelist role="definition_list">
<varlistentry>
@ -260,7 +260,7 @@ delimiter.</para>
</varlistentry>
</variablelist>
</section>
<section xml:id="functions_id16">
<section xml:id="id16">
<title>Usage</title>
<programlisting>{"Fn::Replace": [
{'$var1': 'foo', '%var2%': 'bar'},
@ -269,7 +269,7 @@ delimiter.</para>
<para>Returns <literal>"foo is bar"</literal>.</para>
</section>
</section>
<section xml:id="functions_fn-resourcefacade">
<section xml:id="fn-resourcefacade">
<?dbhtml stop-chunking?>
<title>Fn::ResourceFacade</title>
<variablelist role="definition_list">
@ -288,7 +288,7 @@ the facade.</para>
</listitem>
</varlistentry>
</variablelist>
<section xml:id="functions_id17">
<section xml:id="id17">
<title>Parameters</title>
<variablelist role="definition_list">
<varlistentry>
@ -299,13 +299,13 @@ the facade.</para>
</varlistentry>
</variablelist>
</section>
<section xml:id="functions_id18">
<section xml:id="id18">
<title>Usage</title>
<programlisting>{'Fn::ResourceFacade': 'Metadata'}
{'Fn::ResourceFacade': 'DeletionPolicy'}
{'Fn::ResourceFacade': 'UpdatePolicy'}</programlisting>
</section>
<section xml:id="functions_example">
<section xml:id="example">
<title>Example</title>
<para>Here is a top level template <literal>top.yaml</literal></para>
<programlisting>resources:
@ -327,15 +327,15 @@ the facade.</para>
<para>To use it</para>
<programlisting>$ heat stack-create -f top.yaml -e env.yaml</programlisting>
<para>What happened is the metadata in <literal>top.yaml</literal> (key: value, some: more
stuff) gets passed into the resource template via the <link linkend="functions_fn-resourcefacade">Fn::ResourceFacade</link>
stuff) gets passed into the resource template via the <link linkend="fn-resourcefacade">Fn::ResourceFacade</link>
function.</para>
</section>
</section>
<section xml:id="functions_fn-memberlisttomap">
<section xml:id="fn-memberlisttomap">
<?dbhtml stop-chunking?>
<title>Fn::MemberListToMap</title>
<para>Convert an AWS style member list into a map.</para>
<section xml:id="functions_id19">
<section xml:id="id19">
<title>Parameters</title>
<variablelist role="definition_list">
<varlistentry>
@ -358,7 +358,7 @@ function.</para>
</varlistentry>
</variablelist>
</section>
<section xml:id="functions_id20">
<section xml:id="id20">
<title>Usage</title>
<programlisting>{'Fn::MemberListToMap': ['Name', 'Value', ['.member.0.Name=key',
'.member.0.Value=door',

700
doc/hot-reference/generated/openstack.xml
View File

File diff suppressed because it is too large Load Diff