A list of URLs (webhooks) to invoke when state transitions to alarm.
Can be updated without replacement.
Optional property.
Operator used to compare specified statistic with threshold.
Can be updated without replacement.
Optional property.
Allowed values: ge, gt, eq, ne, lt, le
Description for the alarm.
Can be updated without replacement.
Optional property.
True if alarm evaluation/actioning is enabled.
Can be updated without replacement.
Optional property, defaults to “true”.
Number of periods to evaluate over.
Can be updated without replacement.
Optional property.
A list of URLs (webhooks) to invoke when state transitions to insufficient-data.
Can be updated without replacement.
Optional property.
Meter should match this resource metadata (key=value) additionally to the meter_name.
Updates cause replacement.
Optional property.
Meter name watched by the alarm.
Updates cause replacement.
Required property.
A list of URLs (webhooks) to invoke when state transitions to ok.
Can be updated without replacement.
Optional property.
Period (seconds) to evaluate over.
Can be updated without replacement.
Optional property.
False to trigger actions when the threshold is reached AND the alarm’s state has changed. By default, actions are called each time the threshold is reached.
Can be updated without replacement.
Optional property, defaults to “true”.
Meter statistic to evaluate.
Can be updated without replacement.
Optional property.
Allowed values: count, avg, sum, min, max
Threshold to evaluate against.
Can be updated without replacement.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Ceilometer::Alarm
properties:
alarm_actions: [Value, Value, ...]
comparison_operator: String
description: String
enabled: Boolean
evaluation_periods: Integer
insufficient_data_actions: [Value, Value, ...]
matching_metadata: {...}
meter_name: String
ok_actions: [Value, Value, ...]
period: Integer
repeat_actions: Boolean
statistic: String
threshold: Number
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Ceilometer::Alarm
Properties:
alarm_actions: [Value, Value, ...]
comparison_operator: String
description: String
enabled: Boolean
evaluation_periods: Integer
insufficient_data_actions: [Value, Value, ...]
matching_metadata: {...}
meter_name: String
ok_actions: [Value, Value, ...]
period: Integer
repeat_actions: Boolean
statistic: String
threshold: Number
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Ceilometer::Alarm",
"Properties": {
"alarm_actions": [Value, Value, ...],
"comparison_operator": String,
"description": String,
"enabled": Boolean,
"evaluation_periods": Integer,
"insufficient_data_actions": [Value, Value, ...],
"matching_metadata": {...},
"meter_name": String,
"ok_actions": [Value, Value, ...],
"period": Integer,
"repeat_actions": Boolean,
"statistic": String,
"threshold": Number
}
}
}
}
A list of URLs (webhooks) to invoke when state transitions to alarm.
Can be updated without replacement.
Optional property.
List of alarm identifiers to combine.
Can be updated without replacement.
Required property.
The length must be at least 1.
Description for the alarm.
Can be updated without replacement.
Optional property.
True if alarm evaluation/actioning is enabled.
Can be updated without replacement.
Optional property, defaults to “true”.
A list of URLs (webhooks) to invoke when state transitions to insufficient-data.
Can be updated without replacement.
Optional property.
A list of URLs (webhooks) to invoke when state transitions to ok.
Can be updated without replacement.
Optional property.
Operator used to combine the alarms.
Can be updated without replacement.
Optional property.
Allowed values: and, or
False to trigger actions when the threshold is reached AND the alarm’s state has changed. By default, actions are called each time the threshold is reached.
Can be updated without replacement.
Optional property, defaults to “true”.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Ceilometer::CombinationAlarm
properties:
alarm_actions: [Value, Value, ...]
alarm_ids: [Value, Value, ...]
description: String
enabled: Boolean
insufficient_data_actions: [Value, Value, ...]
ok_actions: [Value, Value, ...]
operator: String
repeat_actions: Boolean
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Ceilometer::CombinationAlarm
Properties:
alarm_actions: [Value, Value, ...]
alarm_ids: [Value, Value, ...]
description: String
enabled: Boolean
insufficient_data_actions: [Value, Value, ...]
ok_actions: [Value, Value, ...]
operator: String
repeat_actions: Boolean
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Ceilometer::CombinationAlarm",
"Properties": {
"alarm_actions": [Value, Value, ...],
"alarm_ids": [Value, Value, ...],
"description": String,
"enabled": Boolean,
"insufficient_data_actions": [Value, Value, ...],
"ok_actions": [Value, Value, ...],
"operator": String,
"repeat_actions": Boolean
}
}
}
}
The availability zone in which the volume will be created.
Updates cause replacement.
Optional property.
If specified, the backup to create the volume from.
Updates cause replacement.
Optional property.
A description of the volume.
Updates cause replacement.
Optional property.
If specified, the name or ID of the image to create the volume from.
Updates cause replacement.
Optional property.
Value must be of type glance.image
Key/value pairs to associate with the volume.
Updates cause replacement.
Optional property.
A name used to distinguish the volume.
Updates cause replacement.
Optional property.
The size of the volume in GB.
Updates cause replacement.
Optional property.
The value must be at least 1.
If specified, the snapshot to create the volume from.
Updates cause replacement.
Optional property.
If specified, the volume to use as source.
Updates cause replacement.
Optional property.
If specified, the type of volume to use, mapping to a specific backend.
Updates cause replacement.
Optional property.
Note
DEPRECATED - Use property image.The ID of the image to create the volume from.
Updates cause replacement.
Optional property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Cinder::Volume
properties:
availability_zone: String
backup_id: String
description: String
image: String
metadata: {...}
name: String
size: Number
snapshot_id: String
source_volid: String
volume_type: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Cinder::Volume
Properties:
availability_zone: String
backup_id: String
description: String
image: String
metadata: {...}
name: String
size: Number
snapshot_id: String
source_volid: String
volume_type: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Cinder::Volume",
"Properties": {
"availability_zone": String,
"backup_id": String,
"description": String,
"image": String,
"metadata": {...},
"name": String,
"size": Number,
"snapshot_id": String,
"source_volid": String,
"volume_type": String
}
}
}
}
The ID of the server to which the volume attaches.
Can be updated without replacement.
Required property.
The location 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-<VolumeId> be used instead.
Can be updated without replacement.
Optional property.
The ID of the volume to be attached.
Can be updated without replacement.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Cinder::VolumeAttachment
properties:
instance_uuid: String
mountpoint: String
volume_id: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Cinder::VolumeAttachment
Properties:
instance_uuid: String
mountpoint: String
volume_id: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Cinder::VolumeAttachment",
"Properties": {
"instance_uuid": String,
"mountpoint": String,
"volume_id": String
}
}
}
}
Resources that users are allowed to access by the DescribeStackResource API.
Updates cause replacement.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Heat::AccessPolicy
properties:
AllowedResources: [Value, Value, ...]
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Heat::AccessPolicy
Properties:
AllowedResources: [Value, Value, ...]
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Heat::AccessPolicy",
"Properties": {
"AllowedResources": [Value, Value, ...]
}
}
}
}
An autoscaling group that can scale arbitrary resources.
Cooldown period, in seconds.
Can be updated without replacement.
Optional property.
Desired initial number of resources.
Can be updated without replacement.
Optional property.
Maximum number of resources in the group.
Can be updated without replacement.
Required property.
The value must be at least 0.
Minimum number of resources in the group.
Can be updated without replacement.
Required property.
The value must be at least 0.
Resource definition for the resources in the group, in HOT format. The value of this property is the definition of a resource just as if it had been declared in the template itself.
Updates cause replacement.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Heat::AutoScalingGroup
properties:
cooldown: Integer
desired_capacity: Integer
max_size: Integer
min_size: Integer
resource: {...}
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Heat::AutoScalingGroup
Properties:
cooldown: Integer
desired_capacity: Integer
max_size: Integer
min_size: Integer
resource: {...}
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Heat::AutoScalingGroup",
"Properties": {
"cooldown": Integer,
"desired_capacity": Integer,
"max_size": Integer,
"min_size": Integer,
"resource": {...}
}
}
}
}
A list of actions to execute when state transitions to alarm.
Can be updated without replacement.
Optional property.
Description for the alarm.
Can be updated without replacement.
Optional property.
Operator used to compare the specified Statistic with Threshold.
Can be updated without replacement.
Optional property.
Allowed values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
A list of dimensions (arbitrary name/value pairs) associated with the metric.
Updates cause replacement.
Optional property.
Number of periods to evaluate over.
Can be updated without replacement.
Optional property.
A list of actions to execute when state transitions to insufficient-data.
Can be updated without replacement.
Optional property.
Metric name watched by the alarm.
Updates cause replacement.
Optional property.
Namespace for the metric.
Updates cause replacement.
Optional property.
A list of actions to execute when state transitions to ok.
Can be updated without replacement.
Optional property.
Period (seconds) to evaluate over.
Can be updated without replacement.
Optional property.
Metric statistic to evaluate.
Can be updated without replacement.
Optional property.
Allowed values: SampleCount, Average, Sum, Minimum, Maximum
Threshold to evaluate against.
Can be updated without replacement.
Optional property.
Unit for the metric.
Can be updated without replacement.
Optional property.
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
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Heat::CWLiteAlarm
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
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Heat::CWLiteAlarm
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
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Heat::CWLiteAlarm",
"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
}
}
}
}
A configuration resource for representing cloud-init cloud-config. This resource allows cloud-config YAML to be defined and stored by the config API. Any intrinsic functions called in the config will be resolved before storing the result. This resource will generally be referenced by OS::Nova::Server user_data, or OS::Heat::MultipartMime parts config. Since cloud-config is boot-only configuration, any changes to the definition will result in the replacement of all servers which reference it.
Map representing the cloud-config data structure which will be formatted as YAML.
Updates cause replacement.
Optional property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Heat::CloudConfig
properties:
cloud_config: {...}
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Heat::CloudConfig
Properties:
cloud_config: {...}
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Heat::CloudConfig",
"Properties": {
"cloud_config": {...}
}
}
}
}
Instance ID to be restarted.
Updates cause replacement.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Heat::HARestarter
properties:
InstanceId: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Heat::HARestarter
Properties:
InstanceId: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Heat::HARestarter",
"Properties": {
"InstanceId": String
}
}
}
}
Not Implemented.
Updates cause replacement.
Required property.
Name of LaunchConfiguration resource.
Can be updated without replacement.
Required property.
List of LoadBalancer resources.
Updates cause replacement.
Optional property.
Desired number of instances.
Can be updated without replacement.
Required property.
Tags to attach to this group.
Updates cause replacement.
Optional property.
List contents:Updates cause replacement.
Optional property.
Map properties:Updates cause replacement.
Required property.
Updates cause replacement.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Heat::InstanceGroup
properties:
AvailabilityZones: [Value, Value, ...]
LaunchConfigurationName: String
LoadBalancerNames: [Value, Value, ...]
Size: Integer
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Heat::InstanceGroup
Properties:
AvailabilityZones: [Value, Value, ...]
LaunchConfigurationName: String
LoadBalancerNames: [Value, Value, ...]
Size: Integer
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Heat::InstanceGroup",
"Properties": {
"AvailabilityZones": [Value, Value, ...],
"LaunchConfigurationName": String,
"LoadBalancerNames": [Value, Value, ...],
"Size": Integer,
"Tags": [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
}
}
}
}
A resource which assembles a collection of software configurations as a multi-part mime message. Parts in the message can be populated with inline configuration or references to other config resources. If the referenced resource is itself a valid multi-part mime message, that will be broken into parts and those parts appended to this message. The resulting multi-part mime message will be stored by the configs API and can be referenced in properties such as OS::Nova::Server user_data. This resource is generally used to build a list of cloud-init configuration elements including scripts and cloud-config. Since cloud-init is boot-only configuration, any changes to the definition will result in the replacement of all servers which reference it.
Parts belonging to this messsage.
Updates cause replacement.
Optional property, defaults to “[]”.
List contents:Updates cause replacement.
Optional property.
Map properties:Content of part to attach, either inline or by referencing the ID of another software config resource
Updates cause replacement.
Required property.
Optional filename to associate with part.
Updates cause replacement.
Optional property.
Optional subtype to specify with the type.
Updates cause replacement.
Optional property.
Whether the part content is text or multipart.
Updates cause replacement.
Optional property, defaults to “text”.
Allowed values: text, multipart
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Heat::MultipartMime
properties:
parts: [{"type": String, "subtype": String, "config": String, "filename": String}, {"type": String, "subtype": String, "config": String, "filename": String}, ...]
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Heat::MultipartMime
Properties:
parts: [{"type": String, "subtype": String, "config": String, "filename": String}, {"type": String, "subtype": String, "config": String, "filename": String}, ...]
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Heat::MultipartMime",
"Properties": {
"parts": [{"type": String, "subtype": String, "config": String, "filename": String}, {"type": String, "subtype": String, "config": String, "filename": String}, ...]
}
}
}
}
A resource which generates a random string. This is useful for configuring passwords and secrets on services.
Length of the string to generate.
Updates cause replacement.
Optional property, defaults to “32”.
The value must be in the range 1 to 512.
Value which can be set or changed on stack update to trigger the resource for replacement with a new random string . The salt value itself is ignored by the random generator.
Updates cause replacement.
Optional property.
Sequence of characters to build the random string from.
Updates cause replacement.
Optional property, defaults to “lettersdigits”.
Allowed values: lettersdigits, letters, lowercase, uppercase, digits, hexdigits, octdigits
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Heat::RandomString
properties:
length: Integer
salt: String
sequence: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Heat::RandomString
Properties:
length: Integer
salt: String
sequence: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Heat::RandomString",
"Properties": {
"length": Integer,
"salt": String,
"sequence": String
}
}
}
}
A resource that creates one or more identically configured nested resources. In addition to the “refs” attribute, this resource implements synthetic attributes that mirror those of the resources in the group. When getting an attribute from this resource, however, a list of attribute values for each resource in the group is returned. To get attribute values for a single resource in the group, synthetic attributes of the form “resource.{resource index}.{attribute name}” can be used. The resource ID of a particular resource in the group can be obtained via the synthetic attribute “resource.{resource index}”.
The number of instances to create.
Can be updated without replacement.
Optional property, defaults to “1”.
The value must be at least 1.
Resource definition for the resources in the group. The value of this property is the definition of a resource just as if it had been declared in the template itself.
Updates cause replacement.
Required property.
Map properties:Property values for the resources in the group
Updates cause replacement.
Optional property.
The type of the resources in the group
Updates cause replacement.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Heat::ResourceGroup
properties:
count: Integer
resource_def: {"type": String, "properties": {...}}
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Heat::ResourceGroup
Properties:
count: Integer
resource_def: {"type": String, "properties": {...}}
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Heat::ResourceGroup",
"Properties": {
"count": Integer,
"resource_def": {"type": String, "properties": {...}}
}
}
}
}
A resource to manage scaling of `OS::Heat::AutoScalingGroup`. **Note** while it may incidentally support `AWS::AutoScaling::AutoScalingGroup` for now, please don’t use it for that purpose and use `AWS::AutoScaling::ScalingPolicy` instead.
Type of adjustment (absolute or percentage).
Can be updated without replacement.
Required property.
Allowed values: change_in_capacity, exact_capacity, percent_change_in_capacity
AutoScaling group ID to apply policy to.
Updates cause replacement.
Required property.
Cooldown period, in seconds.
Can be updated without replacement.
Optional property.
Size of adjustment.
Can be updated without replacement.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Heat::ScalingPolicy
properties:
adjustment_type: String
auto_scaling_group_id: String
cooldown: Number
scaling_adjustment: Number
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Heat::ScalingPolicy
Properties:
adjustment_type: String
auto_scaling_group_id: String
cooldown: Number
scaling_adjustment: Number
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Heat::ScalingPolicy",
"Properties": {
"adjustment_type": String,
"auto_scaling_group_id": String,
"cooldown": Number,
"scaling_adjustment": Number
}
}
}
}
A resource for describing and storing software configuration. The software_configs API which backs this resource creates immutable configs, so any change to the template resource definition will result in a new config being created, and the old one being deleted. Configs can be defined in the same template which uses them, or they can be created in one stack, and passed to another stack via a parameter. A config resource can be referenced in other resource properties which are config-aware. This includes the properties OS::Nova::Server user_data, OS::Heat::SoftwareDeployment config and OS::Heat::MultipartMime parts config. Along with the config script itself, this resource can define schemas for inputs and outputs which the config script is expected to consume and produce. Inputs and outputs are optional and will map to concepts which are specific to the configuration tool being used.
Configuration script or manifest which specifies what actual configuration is performed.
Updates cause replacement.
Optional property.
Namespace to group this software config by when delivered to a server. This may imply what configuration tool is going to perform the configuration.
Updates cause replacement.
Optional property, defaults to “Heat::Ungrouped”.
Schema representing the inputs that this software config is expecting.
Updates cause replacement.
Optional property.
List contents:Updates cause replacement.
Optional property.
Map properties:Default value for the input if none is specified.
Updates cause replacement.
Optional property.
Description of the input.
Updates cause replacement.
Optional property.
Name of the input.
Updates cause replacement.
Required property.
Type of the value of the input.
Updates cause replacement.
Optional property, defaults to “String”.
Allowed values: String, Number, CommaDelimitedList, Json
Map containing options specific to the configuration management tool used by this resource.
Updates cause replacement.
Optional property.
Schema representing the outputs that this software config will produce.
Updates cause replacement.
Optional property.
List contents:Updates cause replacement.
Optional property.
Map properties:Description of the output.
Updates cause replacement.
Optional property.
Denotes that the deployment is in an error state if this output has a value.
Updates cause replacement.
Optional property, defaults to “False”.
Name of the output.
Updates cause replacement.
Required property.
Type of the value of the output.
Updates cause replacement.
Optional property, defaults to “String”.
Allowed values: String, Number, CommaDelimitedList, Json
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Heat::SoftwareConfig
properties:
config: String
group: String
inputs: [{"default": String, "type": String, "name": String, "description": String}, {"default": String, "type": String, "name": String, "description": String}, ...]
options: {...}
outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Heat::SoftwareConfig
Properties:
config: String
group: String
inputs: [{"default": String, "type": String, "name": String, "description": String}, {"default": String, "type": String, "name": String, "description": String}, ...]
options: {...}
outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Heat::SoftwareConfig",
"Properties": {
"config": String,
"group": String,
"inputs": [{"default": String, "type": String, "name": String, "description": String}, {"default": String, "type": String, "name": String, "description": String}, ...],
"options": {...},
"outputs": [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]
}
}
}
}
This resource associates a server with some configuration which is to be deployed to that server. A deployment allows input values to be specified which map to the inputs schema defined in the config resource. These input values are interpreted by the configuration tool in a tool-specific manner. Whenever this resource goes to an IN_PROGRESS state, it creates an ephemeral config that includes the inputs values plus a number of extra inputs which have names prefixed with deploy_. The extra inputs relate to the current state of the stack, along with the information and credentials required to signal back the deployment results. Unless signal_transport=NO_SIGNAL, this resource will remain in an IN_PROGRESS state until the server signals it with the output values for that deployment. Those output values are then available as resource attributes, along with the default attributes deploy_stdout, deploy_stderr and deploy_status_code. Specifying actions other than the default CREATE and UPDATE will result in the deployment being triggered in those actions. For example this would allow cleanup configuration to be performed during actions SUSPEND and DELETE. A config could be designed to only work with some specific actions, or a config can read the value of the deploy_action input to allow conditional logic to perform different configuration for different actions.
Which stack actions will result in this deployment being triggered.
Can be updated without replacement.
Optional property, defaults to “[‘CREATE’, ‘UPDATE’]”.
Allowed values: CREATE, UPDATE, DELETE, SUSPEND, RESUME
ID of software configuration resource to execute when applying to the server.
Can be updated without replacement.
Optional property.
Input values to apply to the software configuration on this server.
Can be updated without replacement.
Optional property.
Name of the derived config associated with this deployment. This is used to apply a sort order to the list of configurations currently deployed to a server.
Updates cause replacement.
Optional property.
ID of Nova server to apply configuration to.
Updates cause replacement.
Optional property.
How the server should signal to heat with the deployment output values. CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL. HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal.
Updates cause replacement.
Optional property, defaults to “CFN_SIGNAL”.
Allowed values: CFN_SIGNAL, HEAT_SIGNAL, NO_SIGNAL
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Heat::SoftwareDeployment
properties:
actions: [Value, Value, ...]
config: String
input_values: {...}
name: String
server: String
signal_transport: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Heat::SoftwareDeployment
Properties:
actions: [Value, Value, ...]
config: String
input_values: {...}
name: String
server: String
signal_transport: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Heat::SoftwareDeployment",
"Properties": {
"actions": [Value, Value, ...],
"config": String,
"input_values": {...},
"name": String,
"server": String,
"signal_transport": String
}
}
}
}
This resource is like OS::Heat::SoftwareConfig except that the config property is represented by a Map rather than a String. This is useful for configuration tools which use YAML or JSON as their configuration syntax. The resulting configuration is transferred, stored and returned by the software_configs API as parsed JSON.
Map representing the configuration data structure which will be serialized to the chosen format.
Updates cause replacement.
Optional property.
Namespace to group this software config by when delivered to a server. This may imply what configuration tool is going to perform the configuration.
Updates cause replacement.
Optional property, defaults to “Heat::Ungrouped”.
Schema representing the inputs that this software config is expecting.
Updates cause replacement.
Optional property.
List contents:Updates cause replacement.
Optional property.
Map properties:Default value for the input if none is specified.
Updates cause replacement.
Optional property.
Description of the input.
Updates cause replacement.
Optional property.
Name of the input.
Updates cause replacement.
Required property.
Type of the value of the input.
Updates cause replacement.
Optional property, defaults to “String”.
Allowed values: String, Number, CommaDelimitedList, Json
Map containing options specific to the configuration management tool used by this resource.
Updates cause replacement.
Optional property.
Schema representing the outputs that this software config will produce.
Updates cause replacement.
Optional property.
List contents:Updates cause replacement.
Optional property.
Map properties:Description of the output.
Updates cause replacement.
Optional property.
Denotes that the deployment is in an error state if this output has a value.
Updates cause replacement.
Optional property, defaults to “False”.
Name of the output.
Updates cause replacement.
Required property.
Type of the value of the output.
Updates cause replacement.
Optional property, defaults to “String”.
Allowed values: String, Number, CommaDelimitedList, Json
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Heat::StructuredConfig
properties:
config: {...}
group: String
inputs: [{"default": String, "type": String, "name": String, "description": String}, {"default": String, "type": String, "name": String, "description": String}, ...]
options: {...}
outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Heat::StructuredConfig
Properties:
config: {...}
group: String
inputs: [{"default": String, "type": String, "name": String, "description": String}, {"default": String, "type": String, "name": String, "description": String}, ...]
options: {...}
outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Heat::StructuredConfig",
"Properties": {
"config": {...},
"group": String,
"inputs": [{"default": String, "type": String, "name": String, "description": String}, {"default": String, "type": String, "name": String, "description": String}, ...],
"options": {...},
"outputs": [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]
}
}
}
}
A deployment resource like OS::Heat::SoftwareDeployment, but which performs input value substitution on the config defined by a OS::Heat::StructuredConfig resource. Some configuration tools have no concept of inputs, so the input value substitution needs to occur in the deployment resource. An example of this is the JSON metadata consumed by the cfn-init tool. Where the config contains {get_input: input_name} this will be substituted with the value of input_name in this resource’s input_values. If get_input needs to be passed through to the substituted configuration then a different input_key property value can be specified.
Which stack actions will result in this deployment being triggered.
Can be updated without replacement.
Optional property, defaults to “[‘CREATE’, ‘UPDATE’]”.
Allowed values: CREATE, UPDATE, DELETE, SUSPEND, RESUME
ID of software configuration resource to execute when applying to the server.
Can be updated without replacement.
Optional property.
Name of key to use for substituting inputs during deployment
Updates cause replacement.
Optional property, defaults to “get_input”.
Input values to apply to the software configuration on this server.
Can be updated without replacement.
Optional property.
Name of the derived config associated with this deployment. This is used to apply a sort order to the list of configurations currently deployed to a server.
Updates cause replacement.
Optional property.
ID of Nova server to apply configuration to.
Updates cause replacement.
Optional property.
How the server should signal to heat with the deployment output values. CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL. HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal.
Updates cause replacement.
Optional property, defaults to “CFN_SIGNAL”.
Allowed values: CFN_SIGNAL, HEAT_SIGNAL, NO_SIGNAL
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Heat::StructuredDeployment
properties:
actions: [Value, Value, ...]
config: String
input_key: String
input_values: {...}
name: String
server: String
signal_transport: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Heat::StructuredDeployment
Properties:
actions: [Value, Value, ...]
config: String
input_key: String
input_values: {...}
name: String
server: String
signal_transport: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Heat::StructuredDeployment",
"Properties": {
"actions": [Value, Value, ...],
"config": String,
"input_key": String,
"input_values": {...},
"name": String,
"server": String,
"signal_transport": String
}
}
}
}
This works identically to a regular WaitConditionHandle, except that on update it clears all signals received and changes the handle. Using this handle means that you must setup the signal senders to send their signals again any time the update handle changes. This allows us to roll out new configurations and be confident that they are rolled out once UPDATE COMPLETE is reached.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Heat::UpdateWaitConditionHandle
properties:
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Heat::UpdateWaitConditionHandle
Properties:
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Heat::UpdateWaitConditionHandle",
"Properties": {
}
}
}
}
Network in CIDR notation.
Updates cause replacement.
Required property.
Nexthop IP adddress.
Updates cause replacement.
Required property.
The router id.
Updates cause replacement.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::ExtraRoute
properties:
destination: String
nexthop: String
router_id: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::ExtraRoute
Properties:
destination: String
nexthop: String
router_id: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::ExtraRoute",
"Properties": {
"destination": String,
"nexthop": String,
"router_id": String
}
}
}
}
A resource for the Firewall resource in Neutron FWaaS.
Administrative state of the firewall. If false (down), firewall does not forward packets and will drop all traffic to/from VMs behind the firewall.
Can be updated without replacement.
Optional property, defaults to “True”.
Description for the firewall.
Can be updated without replacement.
Optional property.
The ID of the firewall policy that this firewall is associated with.
Can be updated without replacement.
Required property.
Name for the firewall.
Can be updated without replacement.
Optional property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::Firewall
properties:
admin_state_up: Boolean
description: String
firewall_policy_id: String
name: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::Firewall
Properties:
admin_state_up: Boolean
description: String
firewall_policy_id: String
name: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::Firewall",
"Properties": {
"admin_state_up": Boolean,
"description": String,
"firewall_policy_id": String,
"name": String
}
}
}
}
A resource for the FirewallPolicy resource in Neutron FWaaS.
Whether this policy should be audited. When set to True, each time the firewall policy or the associated firewall rules are changed, this attribute will be set to False and will have to be explicitly set to True through an update operation.
Can be updated without replacement.
Optional property, defaults to “False”.
Description for the firewall policy.
Can be updated without replacement.
Optional property.
An ordered list of firewall rules to apply to the firewall.
Can be updated without replacement.
Required property.
Name for the firewall policy.
Can be updated without replacement.
Optional property.
Whether this policy should be shared across all tenants.
Can be updated without replacement.
Optional property, defaults to “False”.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::FirewallPolicy
properties:
audited: Boolean
description: String
firewall_rules: [Value, Value, ...]
name: String
shared: Boolean
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::FirewallPolicy
Properties:
audited: Boolean
description: String
firewall_rules: [Value, Value, ...]
name: String
shared: Boolean
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::FirewallPolicy",
"Properties": {
"audited": Boolean,
"description": String,
"firewall_rules": [Value, Value, ...],
"name": String,
"shared": Boolean
}
}
}
}
A resource for the FirewallRule resource in Neutron FWaaS.
Action to be performed on the traffic matching the rule.
Can be updated without replacement.
Optional property, defaults to “deny”.
Allowed values: allow, deny
Description for the firewall rule.
Can be updated without replacement.
Optional property.
Destination IP address or CIDR.
Can be updated without replacement.
Optional property.
Destination port number or a range.
Can be updated without replacement.
Optional property.
Whether this rule should be enabled.
Can be updated without replacement.
Optional property, defaults to “True”.
Internet protocol version.
Can be updated without replacement.
Optional property, defaults to “4”.
Allowed values: 4, 6
Name for the firewall rule.
Can be updated without replacement.
Optional property.
Protocol for the firewall rule.
Can be updated without replacement.
Optional property.
Allowed values: tcp, udp, icmp, None
Whether this rule should be shared across all tenants.
Can be updated without replacement.
Optional property, defaults to “False”.
Source IP address or CIDR.
Can be updated without replacement.
Optional property.
Source port number or a range.
Can be updated without replacement.
Optional property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::FirewallRule
properties:
action: String
description: String
destination_ip_address: String
destination_port: String
enabled: Boolean
ip_version: String
name: String
protocol: String
shared: Boolean
source_ip_address: String
source_port: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::FirewallRule
Properties:
action: String
description: String
destination_ip_address: String
destination_port: String
enabled: Boolean
ip_version: String
name: String
protocol: String
shared: Boolean
source_ip_address: String
source_port: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::FirewallRule",
"Properties": {
"action": String,
"description": String,
"destination_ip_address": String,
"destination_port": String,
"enabled": Boolean,
"ip_version": String,
"name": String,
"protocol": String,
"shared": Boolean,
"source_ip_address": String,
"source_port": String
}
}
}
}
IP address to use if the port has multiple addresses.
Updates cause replacement.
Optional property.
ID of network to allocate floating IP from.
Updates cause replacement.
Required property.
ID of an existing port with at least one IP address to associate with this floating IP.
Updates cause replacement.
Optional property.
Extra parameters to include in the “floatingip” object in the creation request. Parameters are often specific to installed hardware or extensions.
Updates cause replacement.
Optional property, defaults to “{}”.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::FloatingIP
properties:
fixed_ip_address: String
floating_network_id: String
port_id: String
value_specs: {...}
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::FloatingIP
Properties:
fixed_ip_address: String
floating_network_id: String
port_id: String
value_specs: {...}
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::FloatingIP",
"Properties": {
"fixed_ip_address": String,
"floating_network_id": String,
"port_id": String,
"value_specs": {...}
}
}
}
}
IP address to use if the port has multiple addresses.
Updates cause replacement.
Optional property.
ID of the floating IP to associate.
Updates cause replacement.
Required property.
ID of an existing port with at least one IP address to associate with this floating IP.
Updates cause replacement.
Optional property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::FloatingIPAssociation
properties:
fixed_ip_address: String
floatingip_id: String
port_id: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::FloatingIPAssociation
Properties:
fixed_ip_address: String
floatingip_id: String
port_id: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::FloatingIPAssociation",
"Properties": {
"fixed_ip_address": String,
"floatingip_id": String,
"port_id": String
}
}
}
}
A resource for managing health monitors for load balancers in Neutron.
The administrative state of the health monitor.
Can be updated without replacement.
Optional property, defaults to “True”.
The minimum time in seconds between regular connections of the member.
Can be updated without replacement.
Required property.
The list of HTTP status codes expected in response from the member to declare it healthy.
Can be updated without replacement.
Optional property.
The HTTP method used for requests by the monitor of type HTTP.
Can be updated without replacement.
Optional property.
Number of permissible connection failures before changing the member status to INACTIVE.
Can be updated without replacement.
Required property.
Maximum number of seconds for a monitor to wait for a connection to be established before it times out.
Can be updated without replacement.
Required property.
One of predefined health monitor types.
Updates cause replacement.
Required property.
Allowed values: PING, TCP, HTTP, HTTPS
The HTTP path used in the HTTP request used by the monitor to test a member health.
Can be updated without replacement.
Optional property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::HealthMonitor
properties:
admin_state_up: Boolean
delay: Integer
expected_codes: String
http_method: String
max_retries: Integer
timeout: Integer
type: String
url_path: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::HealthMonitor
Properties:
admin_state_up: Boolean
delay: Integer
expected_codes: String
http_method: String
max_retries: Integer
timeout: Integer
type: String
url_path: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::HealthMonitor",
"Properties": {
"admin_state_up": Boolean,
"delay": Integer,
"expected_codes": String,
"http_method": String,
"max_retries": Integer,
"timeout": Integer,
"type": String,
"url_path": String
}
}
}
}
A resource for IKE policy in Neutron.
Authentication hash algorithm for the ike policy.
Updates cause replacement.
Optional property, defaults to “sha1”.
Allowed values: sha1
Description for the ike policy.
Can be updated without replacement.
Optional property.
Encryption algorithm for the ike policy.
Updates cause replacement.
Optional property, defaults to “aes-128”.
Allowed values: 3des, aes-128, aes-192, aes-256
Version for the ike policy.
Updates cause replacement.
Optional property, defaults to “v1”.
Allowed values: v1, v2
Safety assessment lifetime configuration for the ike policy.
Updates cause replacement.
Optional property.
Map properties:Safety assessment lifetime units.
Updates cause replacement.
Optional property, defaults to “seconds”.
Allowed values: seconds, kilobytes
Safety assessment lifetime value in specified units.
Updates cause replacement.
Optional property, defaults to “3600”.
Name for the ike policy.
Can be updated without replacement.
Optional property.
Perfect forward secrecy in lowercase for the ike policy.
Updates cause replacement.
Optional property, defaults to “group5”.
Allowed values: group2, group5, group14
Negotiation mode for the ike policy.
Updates cause replacement.
Optional property, defaults to “main”.
Allowed values: main
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::IKEPolicy
properties:
auth_algorithm: String
description: String
encryption_algorithm: String
ike_version: String
lifetime: {"units": String, "value": Integer}
name: String
pfs: String
phase1_negotiation_mode: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::IKEPolicy
Properties:
auth_algorithm: String
description: String
encryption_algorithm: String
ike_version: String
lifetime: {"units": String, "value": Integer}
name: String
pfs: String
phase1_negotiation_mode: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::IKEPolicy",
"Properties": {
"auth_algorithm": String,
"description": String,
"encryption_algorithm": String,
"ike_version": String,
"lifetime": {"units": String, "value": Integer},
"name": String,
"pfs": String,
"phase1_negotiation_mode": String
}
}
}
}
A resource for IPsec policy in Neutron.
Authentication hash algorithm for the ipsec policy.
Updates cause replacement.
Optional property, defaults to “sha1”.
Allowed values: sha1
Description for the ipsec policy.
Can be updated without replacement.
Optional property.
Encapsulation mode for the ipsec policy.
Updates cause replacement.
Optional property, defaults to “tunnel”.
Allowed values: tunnel, transport
Encryption algorithm for the ipsec policy.
Updates cause replacement.
Optional property, defaults to “aes-128”.
Allowed values: 3des, aes-128, aes-192, aes-256
Safety assessment lifetime configuration for the ipsec policy.
Updates cause replacement.
Optional property.
Map properties:Safety assessment lifetime units.
Updates cause replacement.
Optional property, defaults to “seconds”.
Allowed values: seconds, kilobytes
Safety assessment lifetime value in specified units.
Updates cause replacement.
Optional property, defaults to “3600”.
Name for the ipsec policy.
Can be updated without replacement.
Optional property.
Perfect forward secrecy for the ipsec policy.
Updates cause replacement.
Optional property, defaults to “group5”.
Allowed values: group2, group5, group14
Transform protocol for the ipsec policy.
Updates cause replacement.
Optional property, defaults to “esp”.
Allowed values: esp, ah, ah-esp
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::IPsecPolicy
properties:
auth_algorithm: String
description: String
encapsulation_mode: String
encryption_algorithm: String
lifetime: {"units": String, "value": Integer}
name: String
pfs: String
transform_protocol: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::IPsecPolicy
Properties:
auth_algorithm: String
description: String
encapsulation_mode: String
encryption_algorithm: String
lifetime: {"units": String, "value": Integer}
name: String
pfs: String
transform_protocol: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::IPsecPolicy",
"Properties": {
"auth_algorithm": String,
"description": String,
"encapsulation_mode": String,
"encryption_algorithm": String,
"lifetime": {"units": String, "value": Integer},
"name": String,
"pfs": String,
"transform_protocol": String
}
}
}
}
A resource for IPsec site connection in Neutron.
Administrative state for the ipsec site connection.
Can be updated without replacement.
Optional property, defaults to “True”.
Description for the ipsec site connection.
Can be updated without replacement.
Optional property.
Dead Peer Detection protocol configuration for the ipsec site connection.
Updates cause replacement.
Optional property.
Map properties:Controls DPD protocol mode.
Updates cause replacement.
Optional property, defaults to “hold”.
Allowed values: clear, disabled, hold, restart, restart-by-peer
Number of seconds for the DPD delay.
Updates cause replacement.
Optional property, defaults to “30”.
Number of seconds for the DPD timeout.
Updates cause replacement.
Optional property, defaults to “120”.
Unique identifier for the ike policy associated with the ipsec site connection.
Updates cause replacement.
Required property.
Initiator state in lowercase for the ipsec site connection.
Updates cause replacement.
Optional property, defaults to “bi-directional”.
Allowed values: bi-directional, response-only
Unique identifier for the ipsec policy associated with the ipsec site connection.
Updates cause replacement.
Required property.
Maximum transmission unit size (in bytes) for the ipsec site connection.
Updates cause replacement.
Optional property, defaults to “1500”.
Name for the ipsec site connection.
Can be updated without replacement.
Optional property.
Remote branch router public IPv4 address or IPv6 address or FQDN.
Updates cause replacement.
Required property.
Remote subnet(s) in CIDR format.
Updates cause replacement.
Required property.
Remote branch router identity.
Updates cause replacement.
Required property.
Pre-shared key string for the ipsec site connection.
Updates cause replacement.
Required property.
Unique identifier for the vpn service associated with the ipsec site connection.
Updates cause replacement.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::IPsecSiteConnection
properties:
admin_state_up: Boolean
description: String
dpd: {"interval": Integer, "timeout": Integer, "actions": String}
ikepolicy_id: String
initiator: String
ipsecpolicy_id: String
mtu: Integer
name: String
peer_address: String
peer_cidrs: [Value, Value, ...]
peer_id: String
psk: String
vpnservice_id: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::IPsecSiteConnection
Properties:
admin_state_up: Boolean
description: String
dpd: {"interval": Integer, "timeout": Integer, "actions": String}
ikepolicy_id: String
initiator: String
ipsecpolicy_id: String
mtu: Integer
name: String
peer_address: String
peer_cidrs: [Value, Value, ...]
peer_id: String
psk: String
vpnservice_id: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::IPsecSiteConnection",
"Properties": {
"admin_state_up": Boolean,
"description": String,
"dpd": {"interval": Integer, "timeout": Integer, "actions": String},
"ikepolicy_id": String,
"initiator": String,
"ipsecpolicy_id": String,
"mtu": Integer,
"name": String,
"peer_address": String,
"peer_cidrs": [Value, Value, ...],
"peer_id": String,
"psk": String,
"vpnservice_id": String
}
}
}
}
A resource to link a neutron pool with servers.
The list of Nova server IDs load balanced.
Can be updated without replacement.
Optional property, defaults to “[]”.
The ID of the load balancing pool.
Can be updated without replacement.
Required property.
Port number on which the servers are running on the members.
Updates cause replacement.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::LoadBalancer
properties:
members: [Value, Value, ...]
pool_id: String
protocol_port: Integer
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::LoadBalancer
Properties:
members: [Value, Value, ...]
pool_id: String
protocol_port: Integer
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::LoadBalancer",
"Properties": {
"members": [Value, Value, ...],
"pool_id": String,
"protocol_port": Integer
}
}
}
}
A resource for creating neutron metering label.
Description of the metering label.
Updates cause replacement.
Optional property.
Name of the metering label.
Updates cause replacement.
Optional property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::MeteringLabel
properties:
description: String
name: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::MeteringLabel
Properties:
description: String
name: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::MeteringLabel",
"Properties": {
"description": String,
"name": String
}
}
}
}
A resource to create rule for some label.
The direction in which metering rule is applied, either ingress or egress.
Updates cause replacement.
Optional property, defaults to “ingress”.
Allowed values: ingress, egress
Specify whether the remote_ip_prefix will be excluded or not from traffic counters of the metering label. For example to not count the traffic of a specific IP address of a range.
Updates cause replacement.
Optional property, defaults to “False”.
The metering label ID to associate with this metering rule.
Updates cause replacement.
Required property.
Indicates remote IP prefix to be associated with this metering rule.
Updates cause replacement.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::MeteringRule
properties:
direction: String
excluded: Boolean
metering_label_id: String
remote_ip_prefix: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::MeteringRule
Properties:
direction: String
excluded: Boolean
metering_label_id: String
remote_ip_prefix: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::MeteringRule",
"Properties": {
"direction": String,
"excluded": Boolean,
"metering_label_id": String,
"remote_ip_prefix": String
}
}
}
}
A boolean value specifying the administrative status of the network.
Can be updated without replacement.
Optional property, defaults to “True”.
The IDs of the DHCP agent to schedule the network. Note that the default policy setting in Neutron restricts usage of this property to administrative users only.
Can be updated without replacement.
Optional property.
A string specifying a symbolic name for the network, which is not required to be unique.
Can be updated without replacement.
Optional property.
Whether this network should be shared across all tenants. Note that the default policy setting restricts usage of this attribute to administrative users only.
Can be updated without replacement.
Optional property, defaults to “False”.
The ID of the tenant which will own the network. Only administrative users can set the tenant identifier; this cannot be changed using authorization policies.
Updates cause replacement.
Optional property.
Extra parameters to include in the “network” object in the creation request. Parameters are often specific to installed hardware or extensions.
Can be updated without replacement.
Optional property, defaults to “{}”.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::Net
properties:
admin_state_up: Boolean
dhcp_agent_ids: [Value, Value, ...]
name: String
shared: Boolean
tenant_id: String
value_specs: {...}
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::Net
Properties:
admin_state_up: Boolean
dhcp_agent_ids: [Value, Value, ...]
name: String
shared: Boolean
tenant_id: String
value_specs: {...}
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::Net",
"Properties": {
"admin_state_up": Boolean,
"dhcp_agent_ids": [Value, Value, ...],
"name": String,
"shared": Boolean,
"tenant_id": String,
"value_specs": {...}
}
}
}
}
A resource for the Network Gateway resource in Neutron Network Gateway.
Connection info for this network gateway.
Can be updated without replacement.
Optional property, defaults to “{}”.
List contents:Updates cause replacement.
Optional property.
Map properties:The id of internal network to connect on the network gateway.
Updates cause replacement.
Required property.
The id for L2 segment on the external side of the network gateway. Must be specified when using vlan.
Updates cause replacement.
Optional property.
The value must be in the range 0 to 4094.
L2 segmentation strategy on the external side of the network gateway.
Updates cause replacement.
Optional property, defaults to “flat”.
Allowed values: flat, vlan
Device info for this network gateway.
Can be updated without replacement.
Required property.
The length must be at least 1.
List contents:Updates cause replacement.
Optional property.
Map properties:The device id for the network gateway.
Updates cause replacement.
Required property.
The interface name for the network gateway.
Updates cause replacement.
Required property.
The name of the network gateway.
Can be updated without replacement.
Optional property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::NetworkGateway
properties:
connections: [{"network_id": String, "segmentation_id": Integer, "segmentation_type": String}, {"network_id": String, "segmentation_id": Integer, "segmentation_type": String}, ...]
devices: [{"interface_name": String, "id": String}, {"interface_name": String, "id": String}, ...]
name: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::NetworkGateway
Properties:
connections: [{"network_id": String, "segmentation_id": Integer, "segmentation_type": String}, {"network_id": String, "segmentation_id": Integer, "segmentation_type": String}, ...]
devices: [{"interface_name": String, "id": String}, {"interface_name": String, "id": String}, ...]
name: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::NetworkGateway",
"Properties": {
"connections": [{"network_id": String, "segmentation_id": Integer, "segmentation_type": String}, {"network_id": String, "segmentation_id": Integer, "segmentation_type": String}, ...],
"devices": [{"interface_name": String, "id": String}, {"interface_name": String, "id": String}, ...],
"name": String
}
}
}
}
A resource for managing load balancer pools in Neutron.
The administrative state of this pool.
Can be updated without replacement.
Optional property, defaults to “True”.
Description of the pool.
Can be updated without replacement.
Optional property.
The algorithm used to distribute load between the members of the pool.
Can be updated without replacement.
Required property.
Allowed values: ROUND_ROBIN, LEAST_CONNECTIONS, SOURCE_IP
List of health monitors associated with the pool.
Can be updated without replacement.
Optional property, defaults to “[]”.
Name of the pool.
Updates cause replacement.
Optional property.
Protocol for balancing.
Updates cause replacement.
Required property.
Allowed values: TCP, HTTP, HTTPS
The subnet for the port on which the members of the pool will be connected.
Updates cause replacement.
Required property.
IP address and port of the pool.
Updates cause replacement.
Required property.
Map properties:IP address of the vip.
Updates cause replacement.
Optional property.
The administrative state of this vip.
Updates cause replacement.
Optional property, defaults to “True”.
The maximum number of connections per second allowed for the vip.
Updates cause replacement.
Optional property.
Description of the vip.
Updates cause replacement.
Optional property.
Name of the vip.
Updates cause replacement.
Optional property.
TCP port on which to listen for client traffic that is associated with the vip address.
Updates cause replacement.
Required property.
Configuration of session persistence.
Updates cause replacement.
Optional property.
Map properties:Name of the cookie, required if type is APP_COOKIE.
Updates cause replacement.
Optional property.
Method of implementation of session persistence feature.
Updates cause replacement.
Required property.
Allowed values: SOURCE_IP, HTTP_COOKIE, APP_COOKIE
Subnet of the vip.
Updates cause replacement.
Optional property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::Pool
properties:
admin_state_up: Boolean
description: String
lb_method: String
monitors: [Value, Value, ...]
name: String
protocol: String
subnet_id: String
vip: {"session_persistence": {"cookie_name": String, "type": String}, "subnet": String, "name": String, "address": String, "protocol_port": Integer, "connection_limit": Integer, "admin_state_up": Boolean, "description": String}
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::Pool
Properties:
admin_state_up: Boolean
description: String
lb_method: String
monitors: [Value, Value, ...]
name: String
protocol: String
subnet_id: String
vip: {"session_persistence": {"cookie_name": String, "type": String}, "subnet": String, "name": String, "address": String, "protocol_port": Integer, "connection_limit": Integer, "admin_state_up": Boolean, "description": String}
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::Pool",
"Properties": {
"admin_state_up": Boolean,
"description": String,
"lb_method": String,
"monitors": [Value, Value, ...],
"name": String,
"protocol": String,
"subnet_id": String,
"vip": {"session_persistence": {"cookie_name": String, "type": String}, "subnet": String, "name": String, "address": String, "protocol_port": Integer, "connection_limit": Integer, "admin_state_up": Boolean, "description": String}
}
}
}
}
A resource to handle load balancer members.
IP address of the pool member on the pool network.
Updates cause replacement.
Required property.
The administrative state of the pool member.
Updates cause replacement.
Optional property, defaults to “True”.
The ID of the load balancing pool.
Can be updated without replacement.
Required property.
TCP port on which the pool member listens for requests or connections.
Updates cause replacement.
Required property.
The value must be in the range 0 to 65535.
Weight of pool member in the pool (default to 1).
Can be updated without replacement.
Optional property.
The value must be in the range 0 to 256.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::PoolMember
properties:
address: String
admin_state_up: Boolean
pool_id: String
protocol_port: Integer
weight: Integer
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::PoolMember
Properties:
address: String
admin_state_up: Boolean
pool_id: String
protocol_port: Integer
weight: Integer
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::PoolMember",
"Properties": {
"address": String,
"admin_state_up": Boolean,
"pool_id": String,
"protocol_port": Integer,
"weight": Integer
}
}
}
}
The administrative state of this port.
Can be updated without replacement.
Optional property, defaults to “True”.
Additional MAC/IP address pairs allowed to pass through the port.
Updates cause replacement.
Optional property.
List contents:Updates cause replacement.
Optional property.
Map properties:IP address to allow through this port.
Updates cause replacement.
Required property.
MAC address to allow through this port.
Updates cause replacement.
Optional property.
Device ID of this port.
Can be updated without replacement.
Optional property.
Name of the network owning the port. The value is typically network:floatingip or network:router_interface or network:dhcp
Can be updated without replacement.
Optional property.
Desired IPs for this port.
Can be updated without replacement.
Optional property, defaults to “[]”.
List contents:Updates cause replacement.
Optional property.
Map properties:IP address desired in the subnet for this port.
Updates cause replacement.
Optional property.
Subnet in which to allocate the IP address for this port.
Updates cause replacement.
Optional property.
MAC address to give to this port.
Updates cause replacement.
Optional property.
A symbolic name for this port.
Can be updated without replacement.
Optional property.
Network ID this port belongs to.
Updates cause replacement.
Required property.
Security group IDs to associate with this port.
Can be updated without replacement.
Optional property, defaults to “[]”.
Extra parameters to include in the “port” object in the creation request.
Updates cause replacement.
Optional property, defaults to “{}”.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::Port
properties:
admin_state_up: Boolean
allowed_address_pairs: [{"ip_address": String, "mac_address": String}, {"ip_address": String, "mac_address": String}, ...]
device_id: String
device_owner: String
fixed_ips: [{"subnet_id": String, "ip_address": String}, {"subnet_id": String, "ip_address": String}, ...]
mac_address: String
name: String
network_id: String
security_groups: [Value, Value, ...]
value_specs: {...}
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::Port
Properties:
admin_state_up: Boolean
allowed_address_pairs: [{"ip_address": String, "mac_address": String}, {"ip_address": String, "mac_address": String}, ...]
device_id: String
device_owner: String
fixed_ips: [{"subnet_id": String, "ip_address": String}, {"subnet_id": String, "ip_address": String}, ...]
mac_address: String
name: String
network_id: String
security_groups: [Value, Value, ...]
value_specs: {...}
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::Port",
"Properties": {
"admin_state_up": Boolean,
"allowed_address_pairs": [{"ip_address": String, "mac_address": String}, {"ip_address": String, "mac_address": String}, ...],
"device_id": String,
"device_owner": String,
"fixed_ips": [{"subnet_id": String, "ip_address": String}, {"subnet_id": String, "ip_address": String}, ...],
"mac_address": String,
"name": String,
"network_id": String,
"security_groups": [Value, Value, ...],
"value_specs": {...}
}
}
}
}
A boolean value specifying the administrative status of the network.
Can be updated without replacement.
Optional property, defaults to “True”.
A string specifying a symbolic name for the network, which is not required to be unique.
Can be updated without replacement.
Optional property.
A string specifying the provider network type for the network.
Can be updated without replacement.
Required property.
Allowed values: vlan, flat
A string specifying physical network mapping for the network.
Can be updated without replacement.
Required property.
A string specifying the segmentation id for the network.
Can be updated without replacement.
Optional property.
Whether this network should be shared across all tenants.
Can be updated without replacement.
Optional property, defaults to “True”.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::ProviderNet
properties:
admin_state_up: Boolean
name: String
network_type: String
physical_network: String
segmentation_id: String
shared: Boolean
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::ProviderNet
Properties:
admin_state_up: Boolean
name: String
network_type: String
physical_network: String
segmentation_id: String
shared: Boolean
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::ProviderNet",
"Properties": {
"admin_state_up": Boolean,
"name": String,
"network_type": String,
"physical_network": String,
"segmentation_id": String,
"shared": Boolean
}
}
}
}
The administrative state of the router.
Can be updated without replacement.
Optional property, defaults to “True”.
External network gateway configuration for a router.
Can be updated without replacement.
Optional property.
Map properties:Enables Source NAT on the router gateway. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only.
Can be updated without replacement.
Optional property.
ID or name of the external network for the gateway.
Can be updated without replacement.
Required property.
ID of the L3 agent. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only.
Can be updated without replacement.
Optional property.
The name of the router.
Can be updated without replacement.
Optional property.
Extra parameters to include in the creation request.
Can be updated without replacement.
Optional property, defaults to “{}”.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::Router
properties:
admin_state_up: Boolean
external_gateway_info: {"enable_snat": Boolean, "network": String}
l3_agent_id: String
name: String
value_specs: {...}
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::Router
Properties:
admin_state_up: Boolean
external_gateway_info: {"enable_snat": Boolean, "network": String}
l3_agent_id: String
name: String
value_specs: {...}
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::Router",
"Properties": {
"admin_state_up": Boolean,
"external_gateway_info": {"enable_snat": Boolean, "network": String},
"l3_agent_id": String,
"name": String,
"value_specs": {...}
}
}
}
}
Note
DEPRECATED - RouterGateway resource is deprecated and should not be used. Instead use the `external_gateway_info` property in the router resource to set up the gateway.ID of the external network for the gateway.
Updates cause replacement.
Required property.
ID of the router.
Updates cause replacement.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::RouterGateway
properties:
network_id: String
router_id: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::RouterGateway
Properties:
network_id: String
router_id: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::RouterGateway",
"Properties": {
"network_id": String,
"router_id": String
}
}
}
}
The port id, either subnet_id or port_id should be specified.
Updates cause replacement.
Optional property.
The router id.
Updates cause replacement.
Required property.
The subnet id, either subnet_id or port_id should be specified.
Updates cause replacement.
Optional property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::RouterInterface
properties:
port_id: String
router_id: String
subnet_id: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::RouterInterface
Properties:
port_id: String
router_id: String
subnet_id: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::RouterInterface",
"Properties": {
"port_id": String,
"router_id": String,
"subnet_id": String
}
}
}
}
Description of the security group.
Can be updated without replacement.
Optional property.
A string specifying a symbolic name for the security group, which is not required to be unique.
Can be updated without replacement.
Optional property.
List of security group rules.
Can be updated without replacement.
Optional property, defaults to “[]”.
List contents:Updates cause replacement.
Optional property.
Map properties:The direction in which the security group rule is applied. For a compute instance, an ingress security group rule matches traffic that is incoming (ingress) for that instance. An egress rule is applied to traffic leaving the instance.
Updates cause replacement.
Optional property, defaults to “ingress”.
Allowed values: ingress, egress
Ethertype of the traffic.
Updates cause replacement.
Optional property, defaults to “IPv4”.
Allowed values: IPv4, IPv6
The maximum port number in the range that is matched by the security group rule. The port_range_min attribute constrains the port_range_max attribute. If the protocol is ICMP, this value must be an ICMP type.
Updates cause replacement.
Optional property.
The minimum port number in the range that is matched by the security group rule. If the protocol is TCP or UDP, this value must be less than or equal to the value of the port_range_max attribute. If the protocol is ICMP, this value must be an ICMP type.
Updates cause replacement.
Optional property.
The protocol that is matched by the security group rule. Valid values include tcp, udp, and icmp.
Updates cause replacement.
Optional property.
The remote group ID to be associated with this security group rule. If no value is specified then this rule will use this security group for the remote_group_id.
Updates cause replacement.
Optional property.
The remote IP prefix (CIDR) to be associated with this security group rule.
Updates cause replacement.
Optional property.
Whether to specify a remote group or a remote IP prefix.
Updates cause replacement.
Optional property, defaults to “remote_ip_prefix”.
Allowed values: remote_ip_prefix, remote_group_id
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::SecurityGroup
properties:
description: String
name: String
rules: [{"remote_group_id": String, "direction": String, "remote_ip_prefix": String, "port_range_min": Integer, "remote_mode": String, "ethertype": String, "port_range_max": Integer, "protocol": String}, {"remote_group_id": String, "direction": String, "remote_ip_prefix": String, "port_range_min": Integer, "remote_mode": String, "ethertype": String, "port_range_max": Integer, "protocol": String}, ...]
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::SecurityGroup
Properties:
description: String
name: String
rules: [{"remote_group_id": String, "direction": String, "remote_ip_prefix": String, "port_range_min": Integer, "remote_mode": String, "ethertype": String, "port_range_max": Integer, "protocol": String}, {"remote_group_id": String, "direction": String, "remote_ip_prefix": String, "port_range_min": Integer, "remote_mode": String, "ethertype": String, "port_range_max": Integer, "protocol": String}, ...]
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::SecurityGroup",
"Properties": {
"description": String,
"name": String,
"rules": [{"remote_group_id": String, "direction": String, "remote_ip_prefix": String, "port_range_min": Integer, "remote_mode": String, "ethertype": String, "port_range_max": Integer, "protocol": String}, {"remote_group_id": String, "direction": String, "remote_ip_prefix": String, "port_range_min": Integer, "remote_mode": String, "ethertype": String, "port_range_max": Integer, "protocol": String}, ...]
}
}
}
}
The start and end addresses for the allocation pools.
Updates cause replacement.
Optional property.
List contents:Updates cause replacement.
Optional property.
Map properties:Updates cause replacement.
Required property.
Updates cause replacement.
Required property.
The CIDR.
Updates cause replacement.
Required property.
A specified set of DNS name servers to be used.
Can be updated without replacement.
Optional property, defaults to “[]”.
Set to true if DHCP is enabled and false if DHCP is disabled.
Can be updated without replacement.
Optional property, defaults to “True”.
The gateway IP address.
Can be updated without replacement.
Optional property.
Updates cause replacement.
Optional property.
List contents:Updates cause replacement.
Optional property.
Map properties:Updates cause replacement.
Required property.
Updates cause replacement.
Required property.
The IP version, which is 4 or 6.
Updates cause replacement.
Optional property, defaults to “4”.
Allowed values: 4, 6
The name of the subnet.
Can be updated without replacement.
Optional property.
The ID of the attached network.
Updates cause replacement.
Required property.
The ID of the tenant who owns the network. Only administrative users can specify a tenant ID other than their own.
Updates cause replacement.
Optional property.
Extra parameters to include in the creation request.
Can be updated without replacement.
Optional property, defaults to “{}”.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::Subnet
properties:
allocation_pools: [{"start": String, "end": String}, {"start": String, "end": String}, ...]
cidr: String
dns_nameservers: [Value, Value, ...]
enable_dhcp: Boolean
gateway_ip: String
host_routes: [{"nexthop": String, "destination": String}, {"nexthop": String, "destination": String}, ...]
ip_version: Integer
name: String
network_id: String
tenant_id: String
value_specs: {...}
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::Subnet
Properties:
allocation_pools: [{"start": String, "end": String}, {"start": String, "end": String}, ...]
cidr: String
dns_nameservers: [Value, Value, ...]
enable_dhcp: Boolean
gateway_ip: String
host_routes: [{"nexthop": String, "destination": String}, {"nexthop": String, "destination": String}, ...]
ip_version: Integer
name: String
network_id: String
tenant_id: String
value_specs: {...}
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::Subnet",
"Properties": {
"allocation_pools": [{"start": String, "end": String}, {"start": String, "end": String}, ...],
"cidr": String,
"dns_nameservers": [Value, Value, ...],
"enable_dhcp": Boolean,
"gateway_ip": String,
"host_routes": [{"nexthop": String, "destination": String}, {"nexthop": String, "destination": String}, ...],
"ip_version": Integer,
"name": String,
"network_id": String,
"tenant_id": String,
"value_specs": {...}
}
}
}
}
A resource for VPN service in Neutron.
Administrative state for the vpn service.
Can be updated without replacement.
Optional property, defaults to “True”.
Description for the vpn service.
Can be updated without replacement.
Optional property.
Name for the vpn service.
Can be updated without replacement.
Optional property.
Unique identifier for the router to which the vpn service will be inserted.
Updates cause replacement.
Required property.
Unique identifier for the subnet in which the vpn service will be created.
Updates cause replacement.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Neutron::VPNService
properties:
admin_state_up: Boolean
description: String
name: String
router_id: String
subnet_id: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Neutron::VPNService
Properties:
admin_state_up: Boolean
description: String
name: String
router_id: String
subnet_id: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Neutron::VPNService",
"Properties": {
"admin_state_up": Boolean,
"description": String,
"name": String,
"router_id": String,
"subnet_id": String
}
}
}
}
Allocate a floating IP from a given floating IP pool.
Updates cause replacement.
Optional property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Nova::FloatingIP
properties:
pool: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Nova::FloatingIP
Properties:
pool: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Nova::FloatingIP",
"Properties": {
"pool": String
}
}
}
}
ID of the floating IP to assign to the server.
Updates cause replacement.
Required property.
Server to assign floating IP to.
Updates cause replacement.
Required property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Nova::FloatingIPAssociation
properties:
floating_ip: String
server_id: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Nova::FloatingIPAssociation
Properties:
floating_ip: String
server_id: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Nova::FloatingIPAssociation",
"Properties": {
"floating_ip": String,
"server_id": String
}
}
}
}
A resource for creating Nova key pairs. **Note** that if a new key is generated setting `save_private_key` to `True` results in the system saving the private key which can then be retrieved via the `private_key` attribute of this resource. Setting the `public_key` property means that the `private_key` attribute of this resource will always return an empty string regardless of the `save_private_key` setting since there will be no private key data to save.
The name of the key pair.
Updates cause replacement.
Required property.
The optional public key. This allows users to supply the public key from a pre-existing key pair. If not supplied, a new key pair will be generated.
Updates cause replacement.
Optional property.
True if the system should remember a generated private key; False otherwise.
Updates cause replacement.
Optional property, defaults to “False”.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Nova::KeyPair
properties:
name: String
public_key: String
save_private_key: Boolean
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Nova::KeyPair
Properties:
name: String
public_key: String
save_private_key: Boolean
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Nova::KeyPair",
"Properties": {
"name": String,
"public_key": String,
"save_private_key": Boolean
}
}
}
}
The administrator password for the server.
Can be updated without replacement.
Optional property.
Name of the availability zone for server placement.
Updates cause replacement.
Optional property.
Block device mappings for this server.
Updates cause replacement.
Optional property.
List contents:Updates cause replacement.
Optional property.
Map properties:Indicate whether the volume should be deleted when the server is terminated.
Updates cause replacement.
Optional property.
A device name where the volume will be attached in the system at /dev/device_name. This value is typically vda.
Updates cause replacement.
Required property.
The ID of the snapshot to create a volume from.
Updates cause replacement.
Optional property.
The ID of the volume to boot from. Only one of volume_id or snapshot_id should be provided.
Updates cause replacement.
Optional property.
The size of the volume, in GB. It is safe to leave this blank and have the Compute service infer the size.
Updates cause replacement.
Optional property.
value for config drive either boolean, or volume-id.
Updates cause replacement.
Optional property.
Control how the disk is partitioned when the server is created.
Updates cause replacement.
Optional property.
Allowed values: AUTO, MANUAL
The ID or name of the flavor to boot onto.
Can be updated without replacement.
Required property.
Policy on how to apply a flavor update; either by requesting a server resize or by replacing the entire server.
Can be updated without replacement.
Optional property, defaults to “RESIZE”.
Allowed values: RESIZE, REPLACE
The ID or name of the image to boot with.
Can be updated without replacement.
Optional property.
Value must be of type glance.image
Policy on how to apply an image-id update; either by requesting a server rebuild or by replacing the entire server
Can be updated without replacement.
Optional property, defaults to “REPLACE”.
Allowed values: REBUILD, REPLACE, REBUILD_PRESERVE_EPHEMERAL
Name of keypair to inject into the server.
Updates cause replacement.
Optional property.
Value must be of type nova.keypair
Arbitrary key/value metadata to store for this server. Both keys and values must be 255 characters or less. Non-string values will be serialized to JSON (and the serialized string must be 255 characters or less).
Can be updated without replacement.
Optional property.
Server name.
Can be updated without replacement.
Optional property.
An ordered list of nics to be added to this server, with information about connected networks, fixed ips, port etc.
Can be updated without replacement.
Optional property.
List contents:Updates cause replacement.
Optional property.
Map properties:Fixed IP address to specify for the port created on the requested network.
Updates cause replacement.
Optional property.
Name or ID of network to create a port on.
Updates cause replacement.
Optional property.
ID of an existing port to associate with this server.
Updates cause replacement.
Optional property.
Note
DEPRECATED - Use property network.ID of network to create a port on.
Updates cause replacement.
Optional property.
A map of files to create/overwrite on the server upon boot. Keys are file names and values are the file contents.
Updates cause replacement.
Optional property, defaults to “{}”.
A UUID for the set of servers being requested.
Updates cause replacement.
Optional property.
Arbitrary key-value pairs specified by the client to help boot a server.
Updates cause replacement.
Optional property.
List of security group names or IDs. Cannot be used if neutron ports are associated with this server; assign security groups to the ports instead.
Updates cause replacement.
Optional property, defaults to “[]”.
How the server should receive the metadata required for software configuration. POLL_SERVER_CFN will allow calls to the cfn API action DescribeStackResource authenticated with the provided keypair. POLL_SERVER_HEAT will allow calls to the Heat API resource-show using the provided keystone credentials.
Updates cause replacement.
Optional property, defaults to “POLL_SERVER_CFN”.
Allowed values: POLL_SERVER_CFN, POLL_SERVER_HEAT
User data script to be executed by cloud-init.
Updates cause replacement.
Optional property, defaults to “”.
How the user_data should be formatted for the server. For HEAT_CFNTOOLS, the user_data is bundled as part of the heat-cfntools cloud-init boot configuration data. For RAW the user_data is passed to Nova unmodified. For SOFTWARE_CONFIG user_data is bundled as part of the software config data, and metadata is derived from any associated SoftwareDeployment resources.
Updates cause replacement.
Optional property, defaults to “HEAT_CFNTOOLS”.
Allowed values: HEAT_CFNTOOLS, RAW, SOFTWARE_CONFIG
Note
DEPRECATEDName of the administrative user to use on the server. This property will be removed from Juno in favor of the default cloud-init user set up for each image (e.g. “ubuntu” for Ubuntu 12.04+, “fedora” for Fedora 19+ and “cloud-user” for CentOS/RHEL 6.5).
Updates cause replacement.
Optional property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Nova::Server
properties:
admin_pass: String
availability_zone: String
block_device_mapping: [{"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, {"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, ...]
config_drive: String
diskConfig: String
flavor: String
flavor_update_policy: String
image: String
image_update_policy: String
key_name: String
metadata: {...}
name: String
networks: [{"port": String, "fixed_ip": String, "uuid": String, "network": String}, {"port": String, "fixed_ip": String, "uuid": String, "network": String}, ...]
personality: {...}
reservation_id: String
scheduler_hints: {...}
security_groups: [Value, Value, ...]
software_config_transport: String
user_data: String
user_data_format: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Nova::Server
Properties:
admin_pass: String
availability_zone: String
block_device_mapping: [{"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, {"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, ...]
config_drive: String
diskConfig: String
flavor: String
flavor_update_policy: String
image: String
image_update_policy: String
key_name: String
metadata: {...}
name: String
networks: [{"port": String, "fixed_ip": String, "uuid": String, "network": String}, {"port": String, "fixed_ip": String, "uuid": String, "network": String}, ...]
personality: {...}
reservation_id: String
scheduler_hints: {...}
security_groups: [Value, Value, ...]
software_config_transport: String
user_data: String
user_data_format: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Nova::Server",
"Properties": {
"admin_pass": String,
"availability_zone": String,
"block_device_mapping": [{"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, {"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, ...],
"config_drive": String,
"diskConfig": String,
"flavor": String,
"flavor_update_policy": String,
"image": String,
"image_update_policy": String,
"key_name": String,
"metadata": {...},
"name": String,
"networks": [{"port": String, "fixed_ip": String, "uuid": String, "network": String}, {"port": String, "fixed_ip": String, "uuid": String, "network": String}, ...],
"personality": {...},
"reservation_id": String,
"scheduler_hints": {...},
"security_groups": [Value, Value, ...],
"software_config_transport": String,
"user_data": String,
"user_data_format": String
}
}
}
}
A map of user-defined meta data to associate with the account. Each key in the map will set the header X-Account-Meta-{key} with the corresponding value.
Updates cause replacement.
Optional property, defaults to “{}”.
A map of user-defined meta data to associate with the container. Each key in the map will set the header X-Container-Meta-{key} with the corresponding value.
Updates cause replacement.
Optional property, defaults to “{}”.
Specify the ACL permissions on who can read objects in the container.
Updates cause replacement.
Optional property.
Specify the ACL permissions on who can write objects to the container.
Updates cause replacement.
Optional property.
Name for the container. If not specified, a unique name will be generated.
Updates cause replacement.
Optional property.
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Swift::Container
properties:
X-Account-Meta: {...}
X-Container-Meta: {...}
X-Container-Read: String
X-Container-Write: String
name: String
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Swift::Container
Properties:
X-Account-Meta: {...}
X-Container-Meta: {...}
X-Container-Read: String
X-Container-Write: String
name: String
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Swift::Container",
"Properties": {
"X-Account-Meta": {...},
"X-Container-Meta": {...},
"X-Container-Read": String,
"X-Container-Write": String,
"name": String
}
}
}
}
OpenStack cloud database instance resource.
Name of the availability zone for DB instance.
Updates cause replacement.
Optional property.
List of databases to be created on DB instance creation.
Updates cause replacement.
Optional property, defaults to “[]”.
List contents:Updates cause replacement.
Optional property.
Map properties:Set of symbols and encodings.
Updates cause replacement.
Optional property, defaults to “utf8”.
Set of rules for comparing characters in a character set.
Updates cause replacement.
Optional property, defaults to “utf8_general_ci”.
Specifies database names for creating databases on instance creation.
Updates cause replacement.
Required property.
The length must be no greater than 64.
Value must match pattern: [a-zA-Z0-9_]+[a-zA-Z0-9_@?#\s]*[a-zA-Z0-9_]+
Reference to a flavor for creating DB instance.
Updates cause replacement.
Required property.
Name of the DB instance to create.
Updates cause replacement.
Required property.
The length must be no greater than 255.
DB instance restore point.
Updates cause replacement.
Optional property.
Database volume size in GB.
Updates cause replacement.
Required property.
The value must be in the range 1 to 150.
List of users to be created on DB instance creation.
Updates cause replacement.
Optional property, defaults to “[]”.
List contents:Updates cause replacement.
Optional property.
Map properties:Names of databases that those users can access on instance creation.
Updates cause replacement.
Required property.
List contents:Updates cause replacement.
Optional property.
The host from which a user is allowed to connect to the database.
Updates cause replacement.
Optional property, defaults to “%”.
User name to create a user on instance creation.
Updates cause replacement.
Required property.
The length must be no greater than 16.
Value must match pattern: [a-zA-Z0-9_]+[a-zA-Z0-9_@?#\s]*[a-zA-Z0-9_]+
Password for those users on instance creation.
Updates cause replacement.
Required property.
Value must match pattern: [a-zA-Z0-9_]+[a-zA-Z0-9_@?#\s]*[a-zA-Z0-9_]+
heat_template_version: 2013-05-23
...
resources:
...
the_resource:
type: OS::Trove::Instance
properties:
availability_zone: String
databases: [{"character_set": String, "name": String, "collate": String}, {"character_set": String, "name": String, "collate": String}, ...]
flavor: String
name: String
restore_point: String
size: Integer
users: [{"host": String, "password": String, "name": String, "databases": [String, String, ...]}, {"host": String, "password": String, "name": String, "databases": [String, String, ...]}, ...]
HeatTemplateFormatVersion: '2012-12-12'
...
Resources:
...
TheResource:
Type: OS::Trove::Instance
Properties:
availability_zone: String
databases: [{"character_set": String, "name": String, "collate": String}, {"character_set": String, "name": String, "collate": String}, ...]
flavor: String
name: String
restore_point: String
size: Integer
users: [{"host": String, "password": String, "name": String, "databases": [String, String, ...]}, {"host": String, "password": String, "name": String, "databases": [String, String, ...]}, ...]
{
"AWSTemplateFormatVersion" : "2010-09-09",
...
"Resources" : {
"TheResource": {
"Type": "OS::Trove::Instance",
"Properties": {
"availability_zone": String,
"databases": [{"character_set": String, "name": String, "collate": String}, {"character_set": String, "name": String, "collate": String}, ...],
"flavor": String,
"name": String,
"restore_point": String,
"size": Integer,
"users": [{"host": String, "password": String, "name": String, "databases": [String, String, ...]}, {"host": String, "password": String, "name": String, "databases": [String, String, ...]}, ...]
}
}
}
}