openstack/openstack-manuals
Code Issues Proposed changes
bcce6ce360
openstack-manuals/doc/hot-reference/generated/cfn.xml
Gauvain Pocentek bcce6ce360 Automated update of the HOT ref 
Change-Id: I7dbf6b71fb8329ee40598d8eba1efaf337ded609
2015-04-30 15:46:00 +02:00

3436 lines
124 KiB
XML
Raw Blame History

<?xml version='1.0' encoding='UTF-8'?>
<!--Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
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="cloudformation-compatible-resource-types">
<!--WARNING: This file is automatically generated. Do not edit it.-->
<title>CloudFormation Compatible Resource Types</title>
<section xml:id="AWS__AutoScaling__AutoScalingGroup">
<?dbhtml stop-chunking?>
<title>AWS::AutoScaling::AutoScalingGroup</title>
<note>
<para>Available since 2014.1 (Icehouse)</para>
</note>
<section xml:id="AWS__AutoScaling__AutoScalingGroup-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="List">AvailabilityZones</term>
<listitem>
<para>Not Implemented.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Number">Cooldown</term>
<listitem>
<para>Cooldown period, in seconds.</para>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Integer">DesiredCapacity</term>
<listitem>
<para>Desired initial number of instances.</para>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Integer">HealthCheckGracePeriod</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">HealthCheckType</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">InstanceId</term>
<listitem>
<para>The ID of an existing instance to use to create the Auto Scaling group. If specify this property, will create the group use an existing instance instead of a launch configuration.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>Value must be of type nova.server</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">LaunchConfigurationName</term>
<listitem>
<para>The reference to a LaunchConfiguration resource.</para>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">LoadBalancerNames</term>
<listitem>
<para>List of LoadBalancer resources.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Integer">MaxSize</term>
<listitem>
<para>Maximum number of instances in the group.</para>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Integer">MinSize</term>
<listitem>
<para>Minimum number of instances in the group.</para>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">Tags</term>
<listitem>
<para>Tags to attach to this group.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">*</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>Map properties:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="String">Key</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Value</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">VPCZoneIdentifier</term>
<listitem>
<para>Use only with Neutron, to list the internal subnet to which the instance will be attached; needed only if multiple exist; list length must be exactly 1.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="String">*</term>
<listitem>
<para>UUID of the internal subnet to which the instance will be attached.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__AutoScaling__AutoScalingGroup-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
<term>InstanceList</term>
<listitem>
<para>A comma-delimited list of server ip addresses. (Heat extension).</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__AutoScaling__AutoScalingGroup-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::AutoScaling::AutoScalingGroup
properties:
AvailabilityZones: [Value, Value, ...]
Cooldown: Number
DesiredCapacity: Integer
InstanceId: String
LaunchConfigurationName: String
LoadBalancerNames: [Value, Value, ...]
MaxSize: Integer
MinSize: Integer
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
VPCZoneIdentifier: [String, String, ...]</programlisting>
</section>
<section xml:id="AWS__AutoScaling__AutoScalingGroup-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::AutoScaling::AutoScalingGroup
Properties:
AvailabilityZones: [Value, Value, ...]
Cooldown: Number
DesiredCapacity: Integer
InstanceId: String
LaunchConfigurationName: String
LoadBalancerNames: [Value, Value, ...]
MaxSize: Integer
MinSize: Integer
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
VPCZoneIdentifier: [String, String, ...]</programlisting>
</section>
<section xml:id="AWS__AutoScaling__AutoScalingGroup-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::AutoScaling::AutoScalingGroup",
"Properties": {
"AvailabilityZones": [Value, Value, ...],
"Cooldown": Number,
"DesiredCapacity": Integer,
"InstanceId": String,
"LaunchConfigurationName": String,
"LoadBalancerNames": [Value, Value, ...],
"MaxSize": Integer,
"MinSize": Integer,
"Tags": [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...],
"VPCZoneIdentifier": [String, String, ...]
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__AutoScaling__LaunchConfiguration">
<?dbhtml stop-chunking?>
<title>AWS::AutoScaling::LaunchConfiguration</title>
<section xml:id="AWS__AutoScaling__LaunchConfiguration-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="List">BlockDeviceMappings</term>
<listitem>
<para>Block device mappings to attach to instance.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">*</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>Map properties:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="String">DeviceName</term>
<listitem>
<para>A device name where the volume will be attached in the system at /dev/device_name.e.g. vdb</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Map">Ebs</term>
<listitem>
<para>The ebs volume to attach to the instance.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>Map properties:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Boolean">DeleteOnTermination</term>
<listitem>
<para>Indicate whether the volume should be deleted when the instance is terminated.</para>
<para>Updates cause replacement.</para>
<para>Optional property, defaults to "True".</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Number">Iops</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">SnapshotId</term>
<listitem>
<para>The ID of the snapshot to create a volume from.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>Value must be of type cinder.snapshot</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">VolumeSize</term>
<listitem>
<para>The size of the volume, in GB. Must be equal or greater than the size of the snapshot. It is safe to leave this blank and have the Compute service infer the size.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">VolumeType</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term role="Map">NoDevice</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">VirtualName</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">ImageId</term>
<listitem>
<para>Glance image ID or name.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>Value must be of type glance.image</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">InstanceId</term>
<listitem>
<para>The ID of an existing instance you want to use to create the launch configuration. All properties are derived from the instance with the exception of BlockDeviceMapping.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>Value must be of type nova.server</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">InstanceType</term>
<listitem>
<para>Nova instance type (flavor).</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>Value must be of type nova.flavor</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">KernelId</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">KeyName</term>
<listitem>
<para>Optional Nova keypair name.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>Value must be of type nova.keypair</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">NovaSchedulerHints</term>
<listitem>
<para>Scheduler hints to pass to Nova (Heat extension).</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">*</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>Map properties:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="String">Key</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Value</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">RamDiskId</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">SecurityGroups</term>
<listitem>
<para>Security group names to assign.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">UserData</term>
<listitem>
<para>User data to pass to instance.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__AutoScaling__LaunchConfiguration-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::AutoScaling::LaunchConfiguration
properties:
BlockDeviceMappings: [{"DeviceName": String, "Ebs": {"DeleteOnTermination": Boolean, "VolumeSize": String, "SnapshotId": String}}, {"DeviceName": String, "Ebs": {"DeleteOnTermination": Boolean, "VolumeSize": String, "SnapshotId": String}}, ...]
ImageId: String
InstanceId: String
InstanceType: String
KeyName: String
NovaSchedulerHints: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
SecurityGroups: [Value, Value, ...]
UserData: String</programlisting>
</section>
<section xml:id="AWS__AutoScaling__LaunchConfiguration-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::AutoScaling::LaunchConfiguration
Properties:
BlockDeviceMappings: [{"DeviceName": String, "Ebs": {"DeleteOnTermination": Boolean, "VolumeSize": String, "SnapshotId": String}}, {"DeviceName": String, "Ebs": {"DeleteOnTermination": Boolean, "VolumeSize": String, "SnapshotId": String}}, ...]
ImageId: String
InstanceId: String
InstanceType: String
KeyName: String
NovaSchedulerHints: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
SecurityGroups: [Value, Value, ...]
UserData: String</programlisting>
</section>
<section xml:id="AWS__AutoScaling__LaunchConfiguration-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::AutoScaling::LaunchConfiguration",
"Properties": {
"BlockDeviceMappings": [{"DeviceName": String, "Ebs": {"DeleteOnTermination": Boolean, "VolumeSize": String, "SnapshotId": String}}, {"DeviceName": String, "Ebs": {"DeleteOnTermination": Boolean, "VolumeSize": String, "SnapshotId": String}}, ...],
"ImageId": String,
"InstanceId": String,
"InstanceType": String,
"KeyName": String,
"NovaSchedulerHints": [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...],
"SecurityGroups": [Value, Value, ...],
"UserData": String
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__AutoScaling__ScalingPolicy">
<?dbhtml stop-chunking?>
<title>AWS::AutoScaling::ScalingPolicy</title>
<section xml:id="AWS__AutoScaling__ScalingPolicy-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="String">AdjustmentType</term>
<listitem>
<para>Type of adjustment (absolute or percentage).</para>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
<para>Allowed values: ChangeInCapacity, ExactCapacity, PercentChangeInCapacity</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">AutoScalingGroupName</term>
<listitem>
<para>AutoScaling group name to apply policy to.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Number">Cooldown</term>
<listitem>
<para>Cooldown period, in seconds.</para>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Number">ScalingAdjustment</term>
<listitem>
<para>Size of adjustment.</para>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__AutoScaling__ScalingPolicy-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
<term>AlarmUrl</term>
<listitem>
<para>A signed url to handle the alarm. (Heat extension).</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__AutoScaling__ScalingPolicy-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::AutoScaling::ScalingPolicy
properties:
AdjustmentType: String
AutoScalingGroupName: String
Cooldown: Number
ScalingAdjustment: Number</programlisting>
</section>
<section xml:id="AWS__AutoScaling__ScalingPolicy-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::AutoScaling::ScalingPolicy
Properties:
AdjustmentType: String
AutoScalingGroupName: String
Cooldown: Number
ScalingAdjustment: Number</programlisting>
</section>
<section xml:id="AWS__AutoScaling__ScalingPolicy-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::AutoScaling::ScalingPolicy",
"Properties": {
"AdjustmentType": String,
"AutoScalingGroupName": String,
"Cooldown": Number,
"ScalingAdjustment": Number
}
}
}
}</programlisting>
</section>
</section>
<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="AWS__CloudFormation__Stack-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">Parameters</term>
<listitem>
<para>The set of parameters passed to this nested stack.</para>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">TemplateURL</term>
<listitem>
<para>The URL of a template that specifies the stack to be created as a resource.</para>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Number">TimeoutInMinutes</term>
<listitem>
<para>The length of time, in minutes, to wait for the nested stack creation.</para>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__CloudFormation__Stack-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::CloudFormation::Stack
properties:
Parameters: {...}
TemplateURL: String
TimeoutInMinutes: Number</programlisting>
</section>
<section xml:id="AWS__CloudFormation__Stack-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::CloudFormation::Stack
Properties:
Parameters: {...}
TemplateURL: String
TimeoutInMinutes: Number</programlisting>
</section>
<section xml:id="AWS__CloudFormation__Stack-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::CloudFormation::Stack",
"Properties": {
"Parameters": {...},
"TemplateURL": String,
"TimeoutInMinutes": Number
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__CloudFormation__WaitCondition">
<?dbhtml stop-chunking?>
<title>AWS::CloudFormation::WaitCondition</title>
<note>
<para>Available since 2014.1 (Icehouse)</para>
</note>
<section xml:id="AWS__CloudFormation__WaitCondition-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="Number">Count</term>
<listitem>
<para>The number of success signals that must be received before the stack creation process continues.</para>
<para>Can be updated without replacement.</para>
<para>Optional property, defaults to "1".</para>
<para>The value must be at least 1.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Handle</term>
<listitem>
<para>A reference to the wait condition handle used to signal this wait condition.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Number">Timeout</term>
<listitem>
<para>The number of seconds to wait for the correct number of signals to arrive.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
<para>The value must be in the range 1 to 43200.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__CloudFormation__WaitCondition-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
<term>Data</term>
<listitem>
<para>JSON serialized dict containing data associated with wait condition signals sent to the handle.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__CloudFormation__WaitCondition-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::CloudFormation::WaitCondition
properties:
Count: Number
Handle: String
Timeout: Number</programlisting>
</section>
<section xml:id="AWS__CloudFormation__WaitCondition-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::CloudFormation::WaitCondition
Properties:
Count: Number
Handle: String
Timeout: Number</programlisting>
</section>
<section xml:id="AWS__CloudFormation__WaitCondition-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::CloudFormation::WaitCondition",
"Properties": {
"Count": Number,
"Handle": String,
"Timeout": Number
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__CloudFormation__WaitConditionHandle">
<?dbhtml stop-chunking?>
<title>AWS::CloudFormation::WaitConditionHandle</title>
<note>
<para>Available since 2014.1 (Icehouse)</para>
</note>
<para>the main point of this class is to :
have no dependencies (so the instance can reference it)
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>
<section xml:id="AWS__CloudFormation__WaitConditionHandle-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::CloudFormation::WaitConditionHandle</programlisting>
</section>
<section xml:id="AWS__CloudFormation__WaitConditionHandle-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::CloudFormation::WaitConditionHandle</programlisting>
</section>
<section xml:id="AWS__CloudFormation__WaitConditionHandle-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::CloudFormation::WaitConditionHandle"
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__CloudWatch__Alarm">
<?dbhtml stop-chunking?>
<title>AWS::CloudWatch::Alarm</title>
<section xml:id="AWS__CloudWatch__Alarm-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="List">AlarmActions</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">AlarmDescription</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">ComparisonOperator</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
<para>Allowed values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">Dimensions</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">EvaluationPeriods</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">InsufficientDataActions</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">MetricName</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Namespace</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">OKActions</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Period</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Statistic</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
<para>Allowed values: SampleCount, Average, Sum, Minimum, Maximum</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Threshold</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Units</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
<para>Allowed values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__CloudWatch__Alarm-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::CloudWatch::Alarm
properties:
AlarmActions: [Value, Value, ...]
AlarmDescription: String
ComparisonOperator: String
Dimensions: [Value, Value, ...]
EvaluationPeriods: String
InsufficientDataActions: [Value, Value, ...]
MetricName: String
Namespace: String
OKActions: [Value, Value, ...]
Period: String
Statistic: String
Threshold: String
Units: String</programlisting>
</section>
<section xml:id="AWS__CloudWatch__Alarm-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::CloudWatch::Alarm
Properties:
AlarmActions: [Value, Value, ...]
AlarmDescription: String
ComparisonOperator: String
Dimensions: [Value, Value, ...]
EvaluationPeriods: String
InsufficientDataActions: [Value, Value, ...]
MetricName: String
Namespace: String
OKActions: [Value, Value, ...]
Period: String
Statistic: String
Threshold: String
Units: String</programlisting>
</section>
<section xml:id="AWS__CloudWatch__Alarm-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::CloudWatch::Alarm",
"Properties": {
"AlarmActions": [Value, Value, ...],
"AlarmDescription": String,
"ComparisonOperator": String,
"Dimensions": [Value, Value, ...],
"EvaluationPeriods": String,
"InsufficientDataActions": [Value, Value, ...],
"MetricName": String,
"Namespace": String,
"OKActions": [Value, Value, ...],
"Period": String,
"Statistic": String,
"Threshold": String,
"Units": String
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__EC2__EIP">
<?dbhtml stop-chunking?>
<title>AWS::EC2::EIP</title>
<section xml:id="AWS__EC2__EIP-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="String">Domain</term>
<listitem>
<para>Set to "vpc" to have IP address allocation associated to your VPC.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>Allowed values: vpc</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">InstanceId</term>
<listitem>
<para>Instance ID to associate with EIP.</para>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
<para>Value must be of type nova.server</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__EC2__EIP-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
<term>AllocationId</term>
<listitem>
<para>ID that AWS assigns to represent the allocation of the address for use with Amazon VPC. Returned only for VPC elastic IP addresses.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__EC2__EIP-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::EC2::EIP
properties:
Domain: String
InstanceId: String</programlisting>
</section>
<section xml:id="AWS__EC2__EIP-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::EC2::EIP
Properties:
Domain: String
InstanceId: String</programlisting>
</section>
<section xml:id="AWS__EC2__EIP-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::EC2::EIP",
"Properties": {
"Domain": String,
"InstanceId": String
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__EC2__EIPAssociation">
<?dbhtml stop-chunking?>
<title>AWS::EC2::EIPAssociation</title>
<section xml:id="AWS__EC2__EIPAssociation-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="String">AllocationId</term>
<listitem>
<para>Allocation ID for VPC EIP address.</para>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">EIP</term>
<listitem>
<para>EIP address to associate with instance.</para>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">InstanceId</term>
<listitem>
<para>Instance ID to associate with EIP specified by EIP property.</para>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
<para>Value must be of type nova.server</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">NetworkInterfaceId</term>
<listitem>
<para>Network interface ID to associate with EIP.</para>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__EC2__EIPAssociation-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::EC2::EIPAssociation
properties:
AllocationId: String
EIP: String
InstanceId: String
NetworkInterfaceId: String</programlisting>
</section>
<section xml:id="AWS__EC2__EIPAssociation-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::EC2::EIPAssociation
Properties:
AllocationId: String
EIP: String
InstanceId: String
NetworkInterfaceId: String</programlisting>
</section>
<section xml:id="AWS__EC2__EIPAssociation-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::EC2::EIPAssociation",
"Properties": {
"AllocationId": String,
"EIP": String,
"InstanceId": String,
"NetworkInterfaceId": String
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__EC2__Instance">
<?dbhtml stop-chunking?>
<title>AWS::EC2::Instance</title>
<section xml:id="AWS__EC2__Instance-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="String">AvailabilityZone</term>
<listitem>
<para>Availability zone to launch the instance in.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">BlockDeviceMappings</term>
<listitem>
<para>Block device mappings to attach to instance.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">*</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>Map properties:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="String">DeviceName</term>
<listitem>
<para>A device name where the volume will be attached in the system at /dev/device_name.e.g. vdb</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Map">Ebs</term>
<listitem>
<para>The ebs volume to attach to the instance.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>Map properties:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Boolean">DeleteOnTermination</term>
<listitem>
<para>Indicate whether the volume should be deleted when the instance is terminated.</para>
<para>Updates cause replacement.</para>
<para>Optional property, defaults to "True".</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Number">Iops</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">SnapshotId</term>
<listitem>
<para>The ID of the snapshot to create a volume from.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>Value must be of type cinder.snapshot</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">VolumeSize</term>
<listitem>
<para>The size of the volume, in GB. Must be equal or greater than the size of the snapshot. It is safe to leave this blank and have the Compute service infer the size.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">VolumeType</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term role="Map">NoDevice</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">VirtualName</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">DisableApiTermination</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">ImageId</term>
<listitem>
<para>Glance image ID or name.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
<para>Value must be of type glance.image</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">InstanceType</term>
<listitem>
<para>Nova instance type (flavor).</para>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
<para>Value must be of type nova.flavor</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">KernelId</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">KeyName</term>
<listitem>
<para>Optional Nova keypair name.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>Value must be of type nova.keypair</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Boolean">Monitoring</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">NetworkInterfaces</term>
<listitem>
<para>Network interfaces to associate with instance.</para>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">NovaSchedulerHints</term>
<listitem>
<para>Scheduler hints to pass to Nova (Heat extension).</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">*</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>Map properties:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="String">Key</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Value</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">PlacementGroupName</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">PrivateIpAddress</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">RamDiskId</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">SecurityGroupIds</term>
<listitem>
<para>Security group IDs to assign.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">SecurityGroups</term>
<listitem>
<para>Security group names to assign.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Boolean">SourceDestCheck</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">SubnetId</term>
<listitem>
<para>Subnet ID to launch instance in.</para>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">Tags</term>
<listitem>
<para>Tags to attach to instance.</para>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">*</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>Map properties:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="String">Key</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Value</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Tenancy</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">UserData</term>
<listitem>
<para>User data to pass to instance.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">Volumes</term>
<listitem>
<para>Volumes to attach to instance.</para>
<para>Updates cause replacement.</para>
<para>Optional property, defaults to "[]".</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">*</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>Map properties:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="String">Device</term>
<listitem>
<para>The device where the volume is exposed on the instance. This assignment may not be honored and it is advised that the path /dev/disk/by-id/virtio-&lt;VolumeId&gt; be used instead.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">VolumeId</term>
<listitem>
<para>The ID of the volume to be attached.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
<para>Value must be of type cinder.volume</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__EC2__Instance-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
<term>AvailabilityZone</term>
<listitem>
<para>The Availability Zone where the specified instance is launched.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PrivateDnsName</term>
<listitem>
<para>Private DNS name of the specified instance.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PrivateIp</term>
<listitem>
<para>Private IP address of the specified instance.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PublicDnsName</term>
<listitem>
<para>Public DNS name of the specified instance.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PublicIp</term>
<listitem>
<para>Public IP address of the specified instance.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__EC2__Instance-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::EC2::Instance
properties:
AvailabilityZone: String
BlockDeviceMappings: [{"DeviceName": String, "Ebs": {"DeleteOnTermination": Boolean, "VolumeSize": String, "SnapshotId": String}}, {"DeviceName": String, "Ebs": {"DeleteOnTermination": Boolean, "VolumeSize": String, "SnapshotId": String}}, ...]
ImageId: String
InstanceType: String
KeyName: String
NetworkInterfaces: [Value, Value, ...]
NovaSchedulerHints: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
SecurityGroupIds: [Value, Value, ...]
SecurityGroups: [Value, Value, ...]
SubnetId: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
UserData: String
Volumes: [{"Device": String, "VolumeId": String}, {"Device": String, "VolumeId": String}, ...]</programlisting>
</section>
<section xml:id="AWS__EC2__Instance-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::EC2::Instance
Properties:
AvailabilityZone: String
BlockDeviceMappings: [{"DeviceName": String, "Ebs": {"DeleteOnTermination": Boolean, "VolumeSize": String, "SnapshotId": String}}, {"DeviceName": String, "Ebs": {"DeleteOnTermination": Boolean, "VolumeSize": String, "SnapshotId": String}}, ...]
ImageId: String
InstanceType: String
KeyName: String
NetworkInterfaces: [Value, Value, ...]
NovaSchedulerHints: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
SecurityGroupIds: [Value, Value, ...]
SecurityGroups: [Value, Value, ...]
SubnetId: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
UserData: String
Volumes: [{"Device": String, "VolumeId": String}, {"Device": String, "VolumeId": String}, ...]</programlisting>
</section>
<section xml:id="AWS__EC2__Instance-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::EC2::Instance",
"Properties": {
"AvailabilityZone": String,
"BlockDeviceMappings": [{"DeviceName": String, "Ebs": {"DeleteOnTermination": Boolean, "VolumeSize": String, "SnapshotId": String}}, {"DeviceName": String, "Ebs": {"DeleteOnTermination": Boolean, "VolumeSize": String, "SnapshotId": String}}, ...],
"ImageId": String,
"InstanceType": String,
"KeyName": String,
"NetworkInterfaces": [Value, Value, ...],
"NovaSchedulerHints": [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...],
"SecurityGroupIds": [Value, Value, ...],
"SecurityGroups": [Value, Value, ...],
"SubnetId": String,
"Tags": [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...],
"UserData": String,
"Volumes": [{"Device": String, "VolumeId": String}, {"Device": String, "VolumeId": String}, ...]
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__EC2__InternetGateway">
<?dbhtml stop-chunking?>
<title>AWS::EC2::InternetGateway</title>
<section xml:id="AWS__EC2__InternetGateway-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="List">Tags</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">*</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__EC2__InternetGateway-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::EC2::InternetGateway
properties:
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
</section>
<section xml:id="AWS__EC2__InternetGateway-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::EC2::InternetGateway
Properties:
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
</section>
<section xml:id="AWS__EC2__InternetGateway-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::EC2::InternetGateway",
"Properties": {
"Tags": [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__EC2__NetworkInterface">
<?dbhtml stop-chunking?>
<title>AWS::EC2::NetworkInterface</title>
<section xml:id="AWS__EC2__NetworkInterface-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="String">Description</term>
<listitem>
<para>Description for this interface.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">GroupSet</term>
<listitem>
<para>List of security group IDs associated with this interface.</para>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">PrivateIpAddress</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Boolean">SourceDestCheck</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">SubnetId</term>
<listitem>
<para>Subnet ID to associate with this interface.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
<para>Value must be of type neutron.subnet</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">Tags</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">*</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__EC2__NetworkInterface-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
<term>PrivateIpAddress</term>
<listitem>
<para>Private IP address of the network interface.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__EC2__NetworkInterface-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::EC2::NetworkInterface
properties:
Description: String
GroupSet: [Value, Value, ...]
PrivateIpAddress: String
SubnetId: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
</section>
<section xml:id="AWS__EC2__NetworkInterface-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::EC2::NetworkInterface
Properties:
Description: String
GroupSet: [Value, Value, ...]
PrivateIpAddress: String
SubnetId: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
</section>
<section xml:id="AWS__EC2__NetworkInterface-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::EC2::NetworkInterface",
"Properties": {
"Description": String,
"GroupSet": [Value, Value, ...],
"PrivateIpAddress": String,
"SubnetId": String,
"Tags": [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__EC2__RouteTable">
<?dbhtml stop-chunking?>
<title>AWS::EC2::RouteTable</title>
<note>
<para>Available since 2014.1 (Icehouse)</para>
</note>
<section xml:id="AWS__EC2__RouteTable-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="List">Tags</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">*</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">VpcId</term>
<listitem>
<para>VPC ID for where the route table is created.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__EC2__RouteTable-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::EC2::RouteTable
properties:
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
VpcId: String</programlisting>
</section>
<section xml:id="AWS__EC2__RouteTable-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::EC2::RouteTable
Properties:
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
VpcId: String</programlisting>
</section>
<section xml:id="AWS__EC2__RouteTable-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::EC2::RouteTable",
"Properties": {
"Tags": [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...],
"VpcId": String
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__EC2__SecurityGroup">
<?dbhtml stop-chunking?>
<title>AWS::EC2::SecurityGroup</title>
<section xml:id="AWS__EC2__SecurityGroup-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="String">GroupDescription</term>
<listitem>
<para>Description of the security group.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">SecurityGroupEgress</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">*</term>
<listitem>
<para>List of security group egress rules.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>Map properties:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="String">CidrIp</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">FromPort</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">IpProtocol</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">SourceSecurityGroupId</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">SourceSecurityGroupName</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">SourceSecurityGroupOwnerId</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">ToPort</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">SecurityGroupIngress</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">*</term>
<listitem>
<para>List of security group ingress rules.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>Map properties:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="String">CidrIp</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">FromPort</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">IpProtocol</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">SourceSecurityGroupId</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">SourceSecurityGroupName</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">SourceSecurityGroupOwnerId</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">ToPort</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">VpcId</term>
<listitem>
<para>Physical ID of the VPC. Not implemented.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__EC2__SecurityGroup-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::EC2::SecurityGroup
properties:
GroupDescription: String
SecurityGroupEgress: [{"CidrIp": String, "SourceSecurityGroupId": String, "FromPort": String, "SourceSecurityGroupName": String, "ToPort": String, "IpProtocol": String}, {"CidrIp": String, "SourceSecurityGroupId": String, "FromPort": String, "SourceSecurityGroupName": String, "ToPort": String, "IpProtocol": String}, ...]
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="AWS__EC2__SecurityGroup-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::EC2::SecurityGroup
Properties:
GroupDescription: String
SecurityGroupEgress: [{"CidrIp": String, "SourceSecurityGroupId": String, "FromPort": String, "SourceSecurityGroupName": String, "ToPort": String, "IpProtocol": String}, {"CidrIp": String, "SourceSecurityGroupId": String, "FromPort": String, "SourceSecurityGroupName": String, "ToPort": String, "IpProtocol": String}, ...]
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="AWS__EC2__SecurityGroup-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::EC2::SecurityGroup",
"Properties": {
"GroupDescription": String,
"SecurityGroupEgress": [{"CidrIp": String, "SourceSecurityGroupId": String, "FromPort": String, "SourceSecurityGroupName": String, "ToPort": String, "IpProtocol": String}, {"CidrIp": String, "SourceSecurityGroupId": String, "FromPort": String, "SourceSecurityGroupName": String, "ToPort": String, "IpProtocol": String}, ...],
"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>
<section xml:id="AWS__EC2__Subnet">
<?dbhtml stop-chunking?>
<title>AWS::EC2::Subnet</title>
<section xml:id="AWS__EC2__Subnet-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="String">AvailabilityZone</term>
<listitem>
<para>Availability zone in which you want the subnet.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">CidrBlock</term>
<listitem>
<para>CIDR block to apply to subnet.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">Tags</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">*</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">VpcId</term>
<listitem>
<para>Ref structure that contains the ID of the VPC on which you want to create the subnet.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__EC2__Subnet-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
<term>AvailabilityZone</term>
<listitem>
<para>Availability Zone of the subnet.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__EC2__Subnet-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::EC2::Subnet
properties:
AvailabilityZone: String
CidrBlock: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
VpcId: String</programlisting>
</section>
<section xml:id="AWS__EC2__Subnet-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::EC2::Subnet
Properties:
AvailabilityZone: String
CidrBlock: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
VpcId: String</programlisting>
</section>
<section xml:id="AWS__EC2__Subnet-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::EC2::Subnet",
"Properties": {
"AvailabilityZone": String,
"CidrBlock": String,
"Tags": [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...],
"VpcId": String
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__EC2__SubnetRouteTableAssociation">
<?dbhtml stop-chunking?>
<title>AWS::EC2::SubnetRouteTableAssociation</title>
<section xml:id="AWS__EC2__SubnetRouteTableAssociation-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="String">RouteTableId</term>
<listitem>
<para>Route table ID.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">SubnetId</term>
<listitem>
<para>Subnet ID.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
<para>Value must be of type neutron.subnet</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__EC2__SubnetRouteTableAssociation-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::EC2::SubnetRouteTableAssociation
properties:
RouteTableId: String
SubnetId: String</programlisting>
</section>
<section xml:id="AWS__EC2__SubnetRouteTableAssociation-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::EC2::SubnetRouteTableAssociation
Properties:
RouteTableId: String
SubnetId: String</programlisting>
</section>
<section xml:id="AWS__EC2__SubnetRouteTableAssociation-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::EC2::SubnetRouteTableAssociation",
"Properties": {
"RouteTableId": String,
"SubnetId": String
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__EC2__VPC">
<?dbhtml stop-chunking?>
<title>AWS::EC2::VPC</title>
<section xml:id="AWS__EC2__VPC-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="String">CidrBlock</term>
<listitem>
<para>CIDR block to apply to the VPC.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">InstanceTenancy</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">Tags</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">*</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__EC2__VPC-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::EC2::VPC
properties:
CidrBlock: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
</section>
<section xml:id="AWS__EC2__VPC-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::EC2::VPC
Properties:
CidrBlock: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
</section>
<section xml:id="AWS__EC2__VPC-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::EC2::VPC",
"Properties": {
"CidrBlock": String,
"Tags": [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__EC2__VPCGatewayAttachment">
<?dbhtml stop-chunking?>
<title>AWS::EC2::VPCGatewayAttachment</title>
<section xml:id="AWS__EC2__VPCGatewayAttachment-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="String">InternetGatewayId</term>
<listitem>
<para>ID of the InternetGateway.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">VpcId</term>
<listitem>
<para>VPC ID for this gateway association.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">VpnGatewayId</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__EC2__VPCGatewayAttachment-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::EC2::VPCGatewayAttachment
properties:
InternetGatewayId: String
VpcId: String</programlisting>
</section>
<section xml:id="AWS__EC2__VPCGatewayAttachment-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::EC2::VPCGatewayAttachment
Properties:
InternetGatewayId: String
VpcId: String</programlisting>
</section>
<section xml:id="AWS__EC2__VPCGatewayAttachment-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::EC2::VPCGatewayAttachment",
"Properties": {
"InternetGatewayId": String,
"VpcId": String
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__EC2__Volume">
<?dbhtml stop-chunking?>
<title>AWS::EC2::Volume</title>
<section xml:id="AWS__EC2__Volume-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="String">AvailabilityZone</term>
<listitem>
<para>The availability zone in which the volume will be created.</para>
<para>Updates are not supported. Resource update will fail on any attempt to update this property.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Integer">Size</term>
<listitem>
<para>The size of the volume in GB.</para>
<para>Updates are not supported. Resource update will fail on any attempt to update this property.</para>
<para>Optional property.</para>
<para>The value must be at least 1.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">SnapshotId</term>
<listitem>
<para>If specified, the backup used as the source to create the volume.</para>
<para>Updates are not supported. Resource update will fail on any attempt to update this property.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">Tags</term>
<listitem>
<para>The list of tags to associate with the volume.</para>
<para>Updates are not supported. Resource update will fail on any attempt to update this property.</para>
<para>Optional property.</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">*</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>Map properties:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="String">Key</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Value</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__EC2__Volume-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::EC2::Volume
properties:
AvailabilityZone: String
Size: Integer
SnapshotId: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
</section>
<section xml:id="AWS__EC2__Volume-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::EC2::Volume
Properties:
AvailabilityZone: String
Size: Integer
SnapshotId: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
</section>
<section xml:id="AWS__EC2__Volume-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::EC2::Volume",
"Properties": {
"AvailabilityZone": String,
"Size": Integer,
"SnapshotId": String,
"Tags": [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__EC2__VolumeAttachment">
<?dbhtml stop-chunking?>
<title>AWS::EC2::VolumeAttachment</title>
<section xml:id="AWS__EC2__VolumeAttachment-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="String">Device</term>
<listitem>
<para>The device where the volume is exposed on the instance. This assignment may not be honored and it is advised that the path /dev/disk/by-id/virtio-&lt;VolumeId&gt; be used instead.</para>
<para>Updates are not supported. Resource update will fail on any attempt to update this property.</para>
<para>Required property.</para>
<para>Value must match pattern: /dev/vd[b-z]</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">InstanceId</term>
<listitem>
<para>The ID of the instance to which the volume attaches.</para>
<para>Updates are not supported. Resource update will fail on any attempt to update this property.</para>
<para>Required property.</para>
<para>Value must be of type nova.server</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">VolumeId</term>
<listitem>
<para>The ID of the volume to be attached.</para>
<para>Updates are not supported. Resource update will fail on any attempt to update this property.</para>
<para>Required property.</para>
<para>Value must be of type cinder.volume</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__EC2__VolumeAttachment-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::EC2::VolumeAttachment
properties:
Device: String
InstanceId: String
VolumeId: String</programlisting>
</section>
<section xml:id="AWS__EC2__VolumeAttachment-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::EC2::VolumeAttachment
Properties:
Device: String
InstanceId: String
VolumeId: String</programlisting>
</section>
<section xml:id="AWS__EC2__VolumeAttachment-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::EC2::VolumeAttachment",
"Properties": {
"Device": String,
"InstanceId": String,
"VolumeId": String
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__ElasticLoadBalancing__LoadBalancer">
<?dbhtml stop-chunking?>
<title>AWS::ElasticLoadBalancing::LoadBalancer</title>
<para>Implements a HAProxy-bearing instance as a nested stack.</para>
<para>The template for the nested stack can be redefined with
<literal>loadbalancer_template</literal> option in <literal>heat.conf</literal>.</para>
<para>Generally the image used for the instance must have the following
packages installed or available for installation at runtime:</para>
<programlisting>- heat-cfntools and its dependencies like python-psutil
- cronie
- socat
- haproxy</programlisting>
<para>Current default builtin template uses Fedora 21 x86_64 base cloud image
(<link xlink:href="https://getfedora.org/cloud/download/">https://getfedora.org/cloud/download/</link>)
and apart from installing packages goes through some hoops
around SELinux due to pecularities of heat-cfntools.</para>
<section xml:id="AWS__ElasticLoadBalancing__LoadBalancer-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="String">AppCookieStickinessPolicy</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">AvailabilityZones</term>
<listitem>
<para>The Availability Zones in which to create the load balancer.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Map">HealthCheck</term>
<listitem>
<para>An application health check for the instances.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>Map properties:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Number">HealthyThreshold</term>
<listitem>
<para>The number of consecutive health probe successes required before moving the instance to the healthy state.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Number">Interval</term>
<listitem>
<para>The approximate interval, in seconds, between health checks of an individual instance.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Target</term>
<listitem>
<para>The port being checked.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Number">Timeout</term>
<listitem>
<para>Health probe timeout, in seconds.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Number">UnhealthyThreshold</term>
<listitem>
<para>The number of consecutive health probe failures required before moving the instance to the unhealthy state</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">Instances</term>
<listitem>
<para>The list of instance IDs load balanced.</para>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">LBCookieStickinessPolicy</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">Listeners</term>
<listitem>
<para>One or more listeners for this load balancer.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">*</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>Map properties:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Number">InstancePort</term>
<listitem>
<para>TCP port on which the instance server is listening.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Number">LoadBalancerPort</term>
<listitem>
<para>The external load balancer port number.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">PolicyNames</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Protocol</term>
<listitem>
<para>The load balancer transport protocol to use.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
<para>Allowed values: TCP, HTTP</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">SSLCertificateId</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">SecurityGroups</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">Subnets</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__ElasticLoadBalancing__LoadBalancer-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
<term>CanonicalHostedZoneName</term>
<listitem>
<para>The name of the hosted zone that is associated with the LoadBalancer.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>CanonicalHostedZoneNameID</term>
<listitem>
<para>The ID of the hosted zone name that is associated with the LoadBalancer.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>DNSName</term>
<listitem>
<para>The DNS name for the LoadBalancer.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>SourceSecurityGroup.GroupName</term>
<listitem>
<para>The security group that you can use as part of your inbound rules for your LoadBalancer's back-end instances.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>SourceSecurityGroup.OwnerAlias</term>
<listitem>
<para>Owner of the source security group.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__ElasticLoadBalancing__LoadBalancer-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::ElasticLoadBalancing::LoadBalancer
properties:
AvailabilityZones: [Value, Value, ...]
HealthCheck: {"HealthyThreshold": Number, "Interval": Number, "Target": String, "Timeout": Number, "UnhealthyThreshold": Number}
Instances: [Value, Value, ...]
Listeners: [{"InstancePort": Number, "LoadBalancerPort": Number, "Protocol": String}, {"InstancePort": Number, "LoadBalancerPort": Number, "Protocol": String}, ...]</programlisting>
</section>
<section xml:id="AWS__ElasticLoadBalancing__LoadBalancer-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::ElasticLoadBalancing::LoadBalancer
Properties:
AvailabilityZones: [Value, Value, ...]
HealthCheck: {"HealthyThreshold": Number, "Interval": Number, "Target": String, "Timeout": Number, "UnhealthyThreshold": Number}
Instances: [Value, Value, ...]
Listeners: [{"InstancePort": Number, "LoadBalancerPort": Number, "Protocol": String}, {"InstancePort": Number, "LoadBalancerPort": Number, "Protocol": String}, ...]</programlisting>
</section>
<section xml:id="AWS__ElasticLoadBalancing__LoadBalancer-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::ElasticLoadBalancing::LoadBalancer",
"Properties": {
"AvailabilityZones": [Value, Value, ...],
"HealthCheck": {"HealthyThreshold": Number, "Interval": Number, "Target": String, "Timeout": Number, "UnhealthyThreshold": Number},
"Instances": [Value, Value, ...],
"Listeners": [{"InstancePort": Number, "LoadBalancerPort": Number, "Protocol": String}, {"InstancePort": Number, "LoadBalancerPort": Number, "Protocol": String}, ...]
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__IAM__AccessKey">
<?dbhtml stop-chunking?>
<title>AWS::IAM::AccessKey</title>
<section xml:id="AWS__IAM__AccessKey-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="Integer">Serial</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Status</term>
<listitem>
<note>
<para>Not implemented.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">UserName</term>
<listitem>
<para>The name of the user that the new key will belong to.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__IAM__AccessKey-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
<term>SecretAccessKey</term>
<listitem>
<para>Keypair secret key.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>UserName</term>
<listitem>
<para>Username associated with the AccessKey.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__IAM__AccessKey-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::IAM::AccessKey
properties:
UserName: String</programlisting>
</section>
<section xml:id="AWS__IAM__AccessKey-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::IAM::AccessKey
Properties:
UserName: String</programlisting>
</section>
<section xml:id="AWS__IAM__AccessKey-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::IAM::AccessKey",
"Properties": {
"UserName": String
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__IAM__User">
<?dbhtml stop-chunking?>
<title>AWS::IAM::User</title>
<section xml:id="AWS__IAM__User-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="List">Groups</term>
<listitem>
<para>Not Implemented.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="Map">LoginProfile</term>
<listitem>
<para>A login profile for the user.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>Map properties:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="String">Password</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Path</term>
<listitem>
<para>Not Implemented.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">Policies</term>
<listitem>
<para>Access policies to apply to the user.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__IAM__User-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::IAM::User
properties:
Groups: [Value, Value, ...]
LoginProfile: {"Password": String}
Path: String
Policies: [Value, Value, ...]</programlisting>
</section>
<section xml:id="AWS__IAM__User-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::IAM::User
Properties:
Groups: [Value, Value, ...]
LoginProfile: {"Password": String}
Path: String
Policies: [Value, Value, ...]</programlisting>
</section>
<section xml:id="AWS__IAM__User-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::IAM::User",
"Properties": {
"Groups": [Value, Value, ...],
"LoginProfile": {"Password": String},
"Path": String,
"Policies": [Value, Value, ...]
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__RDS__DBInstance">
<?dbhtml stop-chunking?>
<title>AWS::RDS::DBInstance</title>
<section xml:id="AWS__RDS__DBInstance-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="String">AllocatedStorage</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">DBInstanceClass</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">DBName</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">DBSecurityGroups</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Engine</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
<para>Allowed values: MySQL</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">KeyName</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">MasterUserPassword</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">MasterUsername</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Port</term>
<listitem>
<para>Can be updated without replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__RDS__DBInstance-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
<term>Endpoint.Address</term>
<listitem>
<para>???</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Endpoint.Port</term>
<listitem>
<para>???</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__RDS__DBInstance-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::RDS::DBInstance
properties:
AllocatedStorage: String
DBInstanceClass: String
DBName: String
DBSecurityGroups: [Value, Value, ...]
Engine: String
KeyName: String
MasterUserPassword: String
MasterUsername: String
Port: String</programlisting>
</section>
<section xml:id="AWS__RDS__DBInstance-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::RDS::DBInstance
Properties:
AllocatedStorage: String
DBInstanceClass: String
DBName: String
DBSecurityGroups: [Value, Value, ...]
Engine: String
KeyName: String
MasterUserPassword: String
MasterUsername: String
Port: String</programlisting>
</section>
<section xml:id="AWS__RDS__DBInstance-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::RDS::DBInstance",
"Properties": {
"AllocatedStorage": String,
"DBInstanceClass": String,
"DBName": String,
"DBSecurityGroups": [Value, Value, ...],
"Engine": String,
"KeyName": String,
"MasterUserPassword": String,
"MasterUsername": String,
"Port": String
}
}
}
}</programlisting>
</section>
</section>
<section xml:id="AWS__S3__Bucket">
<?dbhtml stop-chunking?>
<title>AWS::S3::Bucket</title>
<section xml:id="AWS__S3__Bucket-props">
<title>Properties</title>
<variablelist role="definition_list">
<varlistentry>
<term role="String">AccessControl</term>
<listitem>
<para>A predefined access control list (ACL) that grants permissions on the bucket.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>Allowed values: Private, PublicRead, PublicReadWrite, AuthenticatedRead, BucketOwnerRead, BucketOwnerFullControl</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="List">Tags</term>
<listitem>
<para>Tags to attach to the bucket.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>List contents:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="Map">*</term>
<listitem>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>Map properties:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="String">Key</term>
<listitem>
<para>The tag key name.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">Value</term>
<listitem>
<para>The tag value.</para>
<para>Updates cause replacement.</para>
<para>Required property.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term role="Map">WebsiteConfiguration</term>
<listitem>
<para>Information used to configure the bucket as a static website.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
<para>
<emphasis>Map properties:</emphasis>
</para>
<variablelist role="definition_list">
<varlistentry>
<term role="String">ErrorDocument</term>
<listitem>
<para>The name of the error document.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
<varlistentry>
<term role="String">IndexDocument</term>
<listitem>
<para>The name of the index document.</para>
<para>Updates cause replacement.</para>
<para>Optional property.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__S3__Bucket-attrs">
<title>Attributes</title>
<variablelist role="definition_list">
<varlistentry>
<term>DomainName</term>
<listitem>
<para>The DNS name of the specified bucket.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>WebsiteURL</term>
<listitem>
<para>The website endpoint for the specified bucket.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="AWS__S3__Bucket-hot">
<title>HOT Syntax</title>
<programlisting language="hot">heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: AWS::S3::Bucket
properties:
AccessControl: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
WebsiteConfiguration: {"IndexDocument": String, "ErrorDocument": String}</programlisting>
</section>
<section xml:id="AWS__S3__Bucket-yaml">
<title>YAML Syntax</title>
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: AWS::S3::Bucket
Properties:
AccessControl: String
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
WebsiteConfiguration: {"IndexDocument": String, "ErrorDocument": String}</programlisting>
</section>
<section xml:id="AWS__S3__Bucket-json">
<title>JSON Syntax</title>
<programlisting language="json">{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "AWS::S3::Bucket",
"Properties": {
"AccessControl": String,
"Tags": [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...],
"WebsiteConfiguration": {"IndexDocument": String, "ErrorDocument": String}
}
}
}
}</programlisting>
</section>
</section>
</chapter>
View Git Blame Copy Permalink