The algorithm type used to generate the secret.
Updates cause replacement.
Optional property, defaults to “aes”.
Allowed values: aes
The bit-length of the secret.
Updates cause replacement.
Optional property.
Allowed values: 128, 196, 256
The expiration date for the secret in ISO-8601 format.
Updates cause replacement.
Optional property.
Value must be of type iso_8601
The type/mode of the algorithm associated with the secret information.
Updates cause replacement.
Optional property, defaults to “cbc”.
Allowed values: cbc
Human readable name for the secret.
Updates cause replacement.
Optional property.
The type/format the secret data is provided in.
Updates cause replacement.
Optional property, defaults to “application/octet-stream”.
Allowed values: application/octet-stream
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Barbican::Order properties: algorithm: String bit_length: Number expiration: String mode: String name: String payload_content_type: String
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Barbican::Order Properties: algorithm: String bit_length: Number expiration: String mode: String name: String payload_content_type: String
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Barbican::Order", "Properties": { "algorithm": String, "bit_length": Number, "expiration": String, "mode": String, "name": String, "payload_content_type": String } } } }
The algorithm type used to generate the secret.
Updates cause replacement.
Optional property.
The bit-length of the secret.
Updates cause replacement.
Optional property.
The value must be at least 0.
The expiration date for the secret in ISO-8601 format.
Updates cause replacement.
Optional property.
Value must be of type iso_8601
The type/mode of the algorithm associated with the secret information.
Updates cause replacement.
Optional property.
Human readable name for the secret.
Updates cause replacement.
Optional property.
The unencrypted plain text of the secret.
Updates cause replacement.
Optional property.
The encoding format used to provide the payload data.
Updates cause replacement.
Optional property.
Allowed values: base64
The type/format the secret data is provided in.
Updates cause replacement.
Optional property.
Allowed values: text/plain, application/octet-stream
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Barbican::Secret properties: algorithm: String bit_length: Number expiration: String mode: String name: String payload: String payload_content_encoding: String payload_content_type: String
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Barbican::Secret Properties: algorithm: String bit_length: Number expiration: String mode: String name: String payload: String payload_content_encoding: String payload_content_type: String
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Barbican::Secret", "Properties": { "algorithm": String, "bit_length": Number, "expiration": String, "mode": String, "name": String, "payload": String, "payload_content_encoding": String, "payload_content_type": String } } } }
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.
Can be updated without replacement.
Optional property, defaults to “{}”.
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.
Note
Available since 2015.1 (Kilo)
A list of query factors, each comparing a Sample attribute with a value. Implicitly combined with matching_metadata, if any.
Can be updated without replacement.
Optional property.
List contents:
Updates cause replacement.
Optional property.
Map properties:
Name of attribute to compare. Names of the form metadata.user_metadata.X or metadata.metering.X are equivalent to what you can address through matching_metadata; the former for Nova meters, the latter for all others. To see the attributes of your Samples, use `ceilometer –debug sample-list`.
Updates cause replacement.
Optional property.
Comparison operator
Updates cause replacement.
Optional property.
Allowed values: le, ge, eq, lt, gt, ne
String value with which to compare
Updates cause 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 query: [{"field": String, "value": String, "op": String}, {"field": String, "value": String, "op": String}, ...] 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 query: [{"field": String, "value": String, "op": String}, {"field": String, "value": String, "op": String}, ...] 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, "query": [{"field": String, "value": String, "op": String}, {"field": String, "value": String, "op": String}, ...], "repeat_actions": Boolean, "statistic": String, "threshold": Number } } } }
Note
Available since 2014.1 (Icehouse)
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 } } } }
Note
Available since 2015.1 (Kilo)
The aggregation method to compare to the threshold
Can be updated without replacement.
Optional property.
Allowed values: mean, sum, last, max, min, std, median, first, count
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.
The time range in seconds.
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.
A list of metric ids.
Can be updated without replacement.
Required property.
A list of URLs (webhooks) to invoke when state transitions to ok.
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”.
Threshold to evaluate against.
Can be updated without replacement.
Required property.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Ceilometer::GnocchiAggregationByMetricsAlarm properties: aggregation_method: String alarm_actions: [Value, Value, ...] comparison_operator: String description: String enabled: Boolean evaluation_periods: Integer granularity: Integer insufficient_data_actions: [Value, Value, ...] metrics: [Value, Value, ...] ok_actions: [Value, Value, ...] repeat_actions: Boolean threshold: Number
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Ceilometer::GnocchiAggregationByMetricsAlarm Properties: aggregation_method: String alarm_actions: [Value, Value, ...] comparison_operator: String description: String enabled: Boolean evaluation_periods: Integer granularity: Integer insufficient_data_actions: [Value, Value, ...] metrics: [Value, Value, ...] ok_actions: [Value, Value, ...] repeat_actions: Boolean threshold: Number
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Ceilometer::GnocchiAggregationByMetricsAlarm", "Properties": { "aggregation_method": String, "alarm_actions": [Value, Value, ...], "comparison_operator": String, "description": String, "enabled": Boolean, "evaluation_periods": Integer, "granularity": Integer, "insufficient_data_actions": [Value, Value, ...], "metrics": [Value, Value, ...], "ok_actions": [Value, Value, ...], "repeat_actions": Boolean, "threshold": Number } } } }
Note
Available since 2015.1 (Kilo)
The aggregation method to compare to the threshold
Can be updated without replacement.
Optional property.
Allowed values: mean, sum, last, max, min, std, median, first, count
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.
The time range in seconds.
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.
Metric name watched by the alarm.
Can be updated without replacement.
Required property.
A list of URLs (webhooks) to invoke when state transitions to ok.
Can be updated without replacement.
Optional property.
The query to filter the metrics
Can be updated without replacement.
Required 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”.
Resource type
Can be updated without replacement.
Required property.
Threshold to evaluate against.
Can be updated without replacement.
Required property.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Ceilometer::GnocchiAggregationByResourcesAlarm properties: aggregation_method: String alarm_actions: [Value, Value, ...] comparison_operator: String description: String enabled: Boolean evaluation_periods: Integer granularity: Integer insufficient_data_actions: [Value, Value, ...] metric: String ok_actions: [Value, Value, ...] query: String repeat_actions: Boolean resource_type: String threshold: Number
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Ceilometer::GnocchiAggregationByResourcesAlarm Properties: aggregation_method: String alarm_actions: [Value, Value, ...] comparison_operator: String description: String enabled: Boolean evaluation_periods: Integer granularity: Integer insufficient_data_actions: [Value, Value, ...] metric: String ok_actions: [Value, Value, ...] query: String repeat_actions: Boolean resource_type: String threshold: Number
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Ceilometer::GnocchiAggregationByResourcesAlarm", "Properties": { "aggregation_method": String, "alarm_actions": [Value, Value, ...], "comparison_operator": String, "description": String, "enabled": Boolean, "evaluation_periods": Integer, "granularity": Integer, "insufficient_data_actions": [Value, Value, ...], "metric": String, "ok_actions": [Value, Value, ...], "query": String, "repeat_actions": Boolean, "resource_type": String, "threshold": Number } } } }
Note
Available since 2015.1 (Kilo)
The aggregation method to compare to the threshold
Can be updated without replacement.
Optional property.
Allowed values: mean, sum, last, max, min, std, median, first, count
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.
The time range in seconds.
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.
Metric name watched by the alarm.
Can be updated without replacement.
Required property.
A list of URLs (webhooks) to invoke when state transitions to ok.
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”.
Id of a resource
Can be updated without replacement.
Required property.
Resource type
Can be updated without replacement.
Required property.
Threshold to evaluate against.
Can be updated without replacement.
Required property.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Ceilometer::GnocchiResourcesAlarm properties: aggregation_method: String alarm_actions: [Value, Value, ...] comparison_operator: String description: String enabled: Boolean evaluation_periods: Integer granularity: Integer insufficient_data_actions: [Value, Value, ...] metric: String ok_actions: [Value, Value, ...] repeat_actions: Boolean resource_id: String resource_type: String threshold: Number
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Ceilometer::GnocchiResourcesAlarm Properties: aggregation_method: String alarm_actions: [Value, Value, ...] comparison_operator: String description: String enabled: Boolean evaluation_periods: Integer granularity: Integer insufficient_data_actions: [Value, Value, ...] metric: String ok_actions: [Value, Value, ...] repeat_actions: Boolean resource_id: String resource_type: String threshold: Number
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Ceilometer::GnocchiResourcesAlarm", "Properties": { "aggregation_method": String, "alarm_actions": [Value, Value, ...], "comparison_operator": String, "description": String, "enabled": Boolean, "evaluation_periods": Integer, "granularity": Integer, "insufficient_data_actions": [Value, Value, ...], "metric": String, "ok_actions": [Value, Value, ...], "repeat_actions": Boolean, "resource_id": String, "resource_type": String, "threshold": Number } } } }
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.
Can be updated without 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.
Can be updated without replacement.
Optional property.
A name used to distinguish the volume.
Can be updated without replacement.
Optional property.
Note
Available since 2015.1 (Kilo)
Arbitrary key-value pairs specified by the client to help the Cinder scheduler creating a volume.
Updates cause replacement.
Optional property.
The size of the volume in GB. On update only increase in size is supported.
Can be updated without replacement.
Optional property.
The value must be at least 1.
If specified, the snapshot to create the volume from.
Updates cause replacement.
Optional property.
Value must be of type cinder.snapshot
If specified, the volume to use as source.
Updates cause replacement.
Optional property.
Value must be of type cinder.volume
If specified, the type of volume to use, mapping to a specific backend.
Can be updated without replacement.
Optional property.
Value must be of type cinder.vtype
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 scheduler_hints: {...} size: Integer 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 scheduler_hints: {...} size: Integer 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, "scheduler_hints": {...}, "size": Integer, "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.
Value must be of type cinder.volume
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 } } } }
Note
Available since 2015.1 (Kilo)
A resource for creating OpenStack virtual hardware templates.
Note that default cinder security policy usage of this resource is limited to being used by administrators only.
The extra specs key and value pairs of the volume type.
Can be updated without replacement.
Optional property.
Name of the volume type.
Updates cause replacement.
Required property.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Cinder::VolumeType properties: metadata: {...} name: String
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Cinder::VolumeType Properties: metadata: {...} name: String
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Cinder::VolumeType", "Properties": { "metadata": {...}, "name": String } } } }
Note
Available since 2014.2 (Juno)
A resource managing for image in Glance.
Container format of image.
Updates cause replacement.
Required property.
Allowed values: ami, ari, aki, bare, ova, ovf
Disk format of image.
Updates cause replacement.
Required property.
Allowed values: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso
The image ID. Glance will generate a UUID if not specified.
Updates cause replacement.
Optional property.
Scope of image accessibility. Public or private. Default value is False means private.
Updates cause replacement.
Optional property, defaults to “False”.
URL where the data for this image already resides. For example, if the image data is stored in swift, you could specify “swift://example.com/container/obj”.
Updates cause replacement.
Required property.
Amount of disk space (in GB) required to boot image. Default value is 0 if not specified and means no limit on the disk size.
Updates cause replacement.
Optional property.
The value must be at least 0.
Amount of ram (in MB) required to boot image. Default value is 0 if not specified and means no limit on the ram size.
Updates cause replacement.
Optional property.
The value must be at least 0.
Name for the image. The name of an image is not unique to a Image Service node.
Updates cause replacement.
Optional property.
Whether the image can be deleted. If the value is True, the image is protected and cannot be deleted.
Updates cause replacement.
Optional property.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Glance::Image properties: container_format: String disk_format: String id: String is_public: Boolean location: String min_disk: Integer min_ram: Integer name: String protected: Boolean
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Glance::Image Properties: container_format: String disk_format: String id: String is_public: Boolean location: String min_disk: Integer min_ram: Integer name: String protected: Boolean
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Glance::Image", "Properties": { "container_format": String, "disk_format": String, "id": String, "is_public": Boolean, "location": String, "min_disk": Integer, "min_ram": Integer, "name": String, "protected": Boolean } } } }
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, ...] } } } }
Note
Available since 2014.1 (Icehouse)
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.
Can be updated without replacement.
Required property.
Policy for rolling updates for this scaling group.
Can be updated without replacement.
Optional property, defaults to “{‘min_in_service’: 0, ‘pause_time’: 0, ‘max_batch_size’: 1}”.
Map properties:
The maximum number of resources to replace at once.
Updates cause replacement.
Optional property, defaults to “1”.
The value must be at least 0.
The minimum number of resources in service while rolling updates are being executed.
Updates cause replacement.
Optional property, defaults to “0”.
The value must be at least 0.
The number of seconds to wait between batches of updates.
Updates cause replacement.
Optional property, defaults to “0”.
The value must be at least 0.
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: {...} rolling_updates: {"min_in_service": Number, "pause_time": Number, "max_batch_size": Number}
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::AutoScalingGroup Properties: cooldown: Integer desired_capacity: Integer max_size: Integer min_size: Integer resource: {...} rolling_updates: {"min_in_service": Number, "pause_time": Number, "max_batch_size": Number}
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::AutoScalingGroup", "Properties": { "cooldown": Integer, "desired_capacity": Integer, "max_size": Integer, "min_size": Integer, "resource": {...}, "rolling_updates": {"min_in_service": Number, "pause_time": Number, "max_batch_size": Number} } } } }
Note
DEPRECATED - OS::Heat::CWLiteAlarm is deprecated, use OS::Ceilometer::Alarm instead.
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.
Required 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.
Required 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.
Required property.
Namespace for the metric.
Updates cause replacement.
Required 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.
Required property.
Metric statistic to evaluate.
Can be updated without replacement.
Required property.
Allowed values: SampleCount, Average, Sum, Minimum, Maximum
Threshold to evaluate against.
Can be updated without replacement.
Required 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 } } } }
Note
Available since 2014.1 (Icehouse)
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": {...} } } } }
Note
DEPRECATED - The HARestarter resource type is unsupported and will be removed in a future release of Heat, once it has support for auto-healing any type of resource. Note that HARestarter does *not* actually restart servers - it deletes and then recreates them. It also does the same to all dependent resources, and may therefore exhibit unexpected and undesirable behaviour. Avoid.
Instance ID to be restarted.
Updates cause replacement.
Required property.
Value must be of type nova.server
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.
The reference to a 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}, ...] } } } }
Note
Available since 2014.1 (Icehouse)
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 message.
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}, ...] } } } }
Note
Available since 2014.1 (Icehouse)
A resource which generates a random string.
This is useful for configuring passwords and secrets on services.
A list of character class and their constraints to generate the random string from.
Updates cause replacement.
Optional property.
List contents:
Updates cause replacement.
Optional property.
Map properties:
A character class and its corresponding min constraint to generate the random string from.
Updates cause replacement.
Optional property, defaults to “lettersdigits”.
Allowed values: lettersdigits, letters, lowercase, uppercase, digits, hexdigits, octdigits
The minimum number of characters from this character class that will be in the generated string.
Updates cause replacement.
Optional property, defaults to “1”.
The value must be in the range 1 to 512.
A list of character sequences and their constraints to generate the random string from.
Updates cause replacement.
Optional property.
List contents:
Updates cause replacement.
Optional property.
Map properties:
The minimum number of characters from this sequence that will be in the generated string.
Updates cause replacement.
Optional property, defaults to “1”.
The value must be in the range 1 to 512.
A character sequence and its corresponding min constraint to generate the random string from.
Updates cause replacement.
Required property.
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.
Note
DEPRECATED - Use property character_classes.
Sequence of characters to build the random string from.
Updates cause replacement.
Optional property.
Allowed values: lettersdigits, letters, lowercase, uppercase, digits, hexdigits, octdigits
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::RandomString properties: character_classes: [{"class": String, "min": Integer}, {"class": String, "min": Integer}, ...] character_sequences: [{"min": Integer, "sequence": String}, {"min": Integer, "sequence": String}, ...] length: Integer salt: String
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::RandomString Properties: character_classes: [{"class": String, "min": Integer}, {"class": String, "min": Integer}, ...] character_sequences: [{"min": Integer, "sequence": String}, {"min": Integer, "sequence": String}, ...] length: Integer salt: String
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::RandomString", "Properties": { "character_classes": [{"class": String, "min": Integer}, {"class": String, "min": Integer}, ...], "character_sequences": [{"min": Integer, "sequence": String}, {"min": Integer, "sequence": String}, ...], "length": Integer, "salt": String } } } }
Note
Available since 2014.1 (Icehouse)
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}.
While each resource in the group will be identically configured, this resource does allow for some index-based customization of the properties of the resources in the group. For example:
resources:
my_indexed_group:
type: OS::Heat::ResourceGroup
properties:
count: 3
resource_def:
type: OS::Nova::Server
properties:
# create a unique name for each server
# using its index in the group
name: my_server_%index%
image: CentOS 6.5
flavor: 4GB Performance
would result in a group of three servers having the same image and flavor, but names of my_server_0, my_server_1, and my_server_2. The variable used for substitution can be customized by using the index_var property.
The number of instances to create.
Can be updated without replacement.
Optional property, defaults to “1”.
The value must be at least 0.
Note
Available since 2014.2 (Juno)
A variable that this resource will use to replace with the current index of a given resource in the group. Can be used, for example, to customize the name property of grouped servers in order to differentiate them when listed with nova client.
Updates cause replacement.
Optional property, defaults to “%index%”.
The length must be at least 3.
Note
Available since 2015.1 (Kilo)
Policies for removal of resources on update
Can be updated without replacement.
Optional property, defaults to “[]”.
List contents:
Policy to be processed when doing an update which requires removal of specific resources.
Updates cause replacement.
Optional property.
Map properties:
List of resources to be removed when doing an update which requires removal of specific resources. The resource may be specified several ways: (1) The resource name, as in the nested stack, (2) The resource reference returned from get_resource in a template, as available via the ‘refs’ attribute Note this is destructive on update when specified; even if the count is not being reduced, and once a resource name is removed, it’s name is never reused in subsequent updates
Updates cause replacement.
Optional property, defaults to “[]”.
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.
Can be updated without 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.
Note
Available since 2014.2 (Juno)
A map of resource names to the specified attribute of each individual resource. Requires heat_template_version: 2014-10-16.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::ResourceGroup properties: count: Integer index_var: String removal_policies: [{"resource_list": [Value, Value, ...]}, {"resource_list": [Value, Value, ...]}, ...] resource_def: {"type": String, "properties": {...}}
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::ResourceGroup Properties: count: Integer index_var: String removal_policies: [{"resource_list": [Value, Value, ...]}, {"resource_list": [Value, Value, ...]}, ...] resource_def: {"type": String, "properties": {...}}
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::ResourceGroup", "Properties": { "count": Integer, "index_var": String, "removal_policies": [{"resource_list": [Value, Value, ...]}, {"resource_list": [Value, Value, ...]}, ...], "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 } } } }
Note
Available since 2014.2 (Juno)
A resource for describing and storing a software component.
This resource is similar to OS::Heat::SoftwareConfig. In contrast to SoftwareConfig which allows for storing only one configuration (e.g. one script), SoftwareComponent allows for storing multiple configurations to address handling of all lifecycle hooks (CREATE, UPDATE, SUSPEND, RESUME, DELETE) for a software component in one place.
This resource is backed by the persistence layer and the API of the SoftwareConfig resource, and only adds handling for the additional ‘configs’ property and attribute.
The list of configurations for the different lifecycle actions of the represented software component.
Updates cause replacement.
Required property.
The length must be at least 1.
List contents:
Updates cause replacement.
Optional property.
Map properties:
Lifecycle actions to which the configuration applies. The string values provided for this property can include the standard resource actions CREATE, DELETE, UPDATE, SUSPEND and RESUME supported by Heat.
Updates cause replacement.
Optional property, defaults to “[‘CREATE’, ‘UPDATE’]”.
The length must be at least 1.
List contents:
Updates cause replacement.
Optional property.
Configuration script or manifest which specifies what actual configuration is performed.
Updates cause replacement.
Optional property.
The configuration tool used to actually apply the configuration on a server. This string property has to be understood by in-instance tools running inside deployed servers.
Updates cause replacement.
Required property.
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::SoftwareComponent properties: configs: [{"tool": String, "config": String, "actions": [String, String, ...]}, {"tool": String, "config": String, "actions": [String, 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::SoftwareComponent Properties: configs: [{"tool": String, "config": String, "actions": [String, String, ...]}, {"tool": String, "config": String, "actions": [String, 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::SoftwareComponent", "Properties": { "configs": [{"tool": String, "config": String, "actions": [String, String, ...]}, {"tool": String, "config": String, "actions": [String, 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}, ...] } } } }
Note
Available since 2014.1 (Icehouse)
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}, ...] } } } }
Note
Available since 2014.1 (Icehouse)
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.
Value must be of type nova.server
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. TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT. 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, TEMP_URL_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 } } } }
Note
Available since 2014.2 (Juno)
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.
A map of Nova names and IDs to apply configuration to.
Can be updated without 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. TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT. 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, TEMP_URL_SIGNAL, HEAT_SIGNAL, NO_SIGNAL
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::SoftwareDeployments properties: actions: [Value, Value, ...] config: String input_values: {...} name: String servers: {...} signal_transport: String
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::SoftwareDeployments Properties: actions: [Value, Value, ...] config: String input_values: {...} name: String servers: {...} signal_transport: String
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::SoftwareDeployments", "Properties": { "actions": [Value, Value, ...], "config": String, "input_values": {...}, "name": String, "servers": {...}, "signal_transport": String } } } }
A Resource representing a stack which can be created using specified context.
Context for this stack.
Updates cause replacement.
Optional property.
Map properties:
Region name in which this stack will be created.
Updates cause replacement.
Required property.
Set of parameters passed to this stack.
Can be updated without replacement.
Optional property, defaults to “{}”.
Template that specifies the stack to be created as a resource.
Can be updated without replacement.
Required property.
Number of minutes to wait for this stack creation.
Can be updated without replacement.
Optional property.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::Stack properties: context: {"region_name": String} parameters: {...} template: String timeout: Number
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::Stack Properties: context: {"region_name": String} parameters: {...} template: String timeout: Number
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::Stack", "Properties": { "context": {"region_name": String}, "parameters": {...}, "template": String, "timeout": Number } } } }
Note
Available since 2014.1 (Icehouse)
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 JSON 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}, ...] } } } }
Note
Available since 2014.1 (Icehouse)
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.
Perform a check on the input values passed to verify that each required input has a corresponding value. When the property is set to STRICT and no value is passed, an exception is raised.
Updates cause replacement.
Optional property, defaults to “LAX”.
Allowed values: LAX, STRICT
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.
Value must be of type nova.server
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. TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT. 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, TEMP_URL_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: {...} input_values_validate: String 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: {...} input_values_validate: String 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": {...}, "input_values_validate": String, "name": String, "server": String, "signal_transport": String } } } }
Note
Available since 2014.2 (Juno)
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.
Perform a check on the input values passed to verify that each required input has a corresponding value. When the property is set to STRICT and no value is passed, an exception is raised.
Updates cause replacement.
Optional property, defaults to “LAX”.
Allowed values: LAX, STRICT
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.
A map of Nova names and IDs to apply configuration to.
Can be updated without 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. TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT. 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, TEMP_URL_SIGNAL, HEAT_SIGNAL, NO_SIGNAL
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::StructuredDeployments properties: actions: [Value, Value, ...] config: String input_key: String input_values: {...} input_values_validate: String name: String servers: {...} signal_transport: String
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::StructuredDeployments Properties: actions: [Value, Value, ...] config: String input_key: String input_values: {...} input_values_validate: String name: String servers: {...} signal_transport: String
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::StructuredDeployments", "Properties": { "actions": [Value, Value, ...], "config": String, "input_key": String, "input_values": {...}, "input_values_validate": String, "name": String, "servers": {...}, "signal_transport": String } } } }
Note
Available since 2014.2 (Juno)
The number of success signals that must be received before the stack creation process continues.
Updates cause replacement.
Optional property, defaults to “1”.
The value must be in the range 1 to 1000.
URL of TempURL where resource will signal completion and optionally upload data.
Updates cause replacement.
Required property.
The maximum number of seconds to wait for the resource to signal completion. Once the timeout is reached, creation of the signal resource will fail.
Updates cause replacement.
Required property.
The value must be in the range 1 to 43200.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::SwiftSignal properties: count: Number handle: String timeout: Number
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::SwiftSignal Properties: count: Number handle: String timeout: Number
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::SwiftSignal", "Properties": { "count": Number, "handle": String, "timeout": Number } } } }
Note
Available since 2014.2 (Juno)
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::SwiftSignalHandle
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::SwiftSignalHandle
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::SwiftSignalHandle" } } }
Note
Available since 2014.1 (Icehouse)
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
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::UpdateWaitConditionHandle
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::UpdateWaitConditionHandle" } } }
Note
Available since 2014.2 (Juno)
The number of success signals that must be received before the stack creation process continues.
Can be updated without replacement.
Optional property, defaults to “1”.
The value must be at least 1.
A reference to the wait condition handle used to signal this wait condition.
Updates cause replacement.
Required property.
The number of seconds to wait for the correct number of signals to arrive.
Updates cause replacement.
Required property.
The value must be in the range 1 to 43200.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::WaitCondition properties: count: Number handle: String timeout: Number
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::WaitCondition Properties: count: Number handle: String timeout: Number
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::WaitCondition", "Properties": { "count": Number, "handle": String, "timeout": Number } } } }
Note
Available since 2014.2 (Juno)
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::WaitConditionHandle
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::WaitConditionHandle
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::WaitConditionHandle" } } }
Note
Available since 2015.1 (Kilo) - Supported versions: keystone v3
Heat Template Resource for Keystone Group.
heat_template_version: 2013-05-23
description: Sample Keystone Group template
type: OS::Keystone::Group properties:
name: {get_param: group_name} domain: {get_param: group_domain} description: {get_param: group_description} roles:
- role: {get_param: group_role} domain: {get_param: group_role_domain}
- role: {get_param: group_role} project: {get_param: group_role_project}
Description of keystone group.
Can be updated without replacement.
Optional property, defaults to “”.
Name or id of keystone domain.
Can be updated without replacement.
Optional property, defaults to “default”.
Value must be of type keystone.domain
Name of keystone group.
Can be updated without replacement.
Optional property.
List of role assignments.
Can be updated without replacement.
Optional property.
List contents:
Map between role with either project or domain.
Updates cause replacement.
Optional property.
Map properties:
Keystone domain
Updates cause replacement.
Optional property.
Value must be of type keystone.domain
Keystone project
Updates cause replacement.
Optional property.
Value must be of type keystone.project
Keystone role
Updates cause replacement.
Required property.
Value must be of type keystone.role
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Keystone::Group properties: description: String domain: String name: String roles: [{"project": String, "domain": String, "role": String}, {"project": String, "domain": String, "role": String}, ...]
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Keystone::Group Properties: description: String domain: String name: String roles: [{"project": String, "domain": String, "role": String}, {"project": String, "domain": String, "role": String}, ...]
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Keystone::Group", "Properties": { "description": String, "domain": String, "name": String, "roles": [{"project": String, "domain": String, "role": String}, {"project": String, "domain": String, "role": String}, ...] } } } }
Note
Available since 2015.1 (Kilo) - Supported versions: keystone v3
Heat Template Resource for Keystone Project.
heat_template_version: 2013-05-23
description: Sample Keystone Project template
type: OS::Keystone::Project properties:
name: {get_param: project_name} domain: {get_param: project_domain} description: {get_param: project_description} enabled: {get_param: project_enabled}
Description of keystone project.
Can be updated without replacement.
Optional property, defaults to “”.
Name or id of keystone domain.
Can be updated without replacement.
Optional property, defaults to “default”.
Value must be of type keystone.domain
This project is enabled or disabled.
Can be updated without replacement.
Optional property, defaults to “True”.
Name of keystone project.
Can be updated without replacement.
Optional property.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Keystone::Project properties: description: String domain: String enabled: Boolean name: String
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Keystone::Project Properties: description: String domain: String enabled: Boolean name: String
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Keystone::Project", "Properties": { "description": String, "domain": String, "enabled": Boolean, "name": String } } } }
Note
Available since 2015.1 (Kilo) - Supported versions: keystone v3
Heat Template Resource for Keystone Role.
heat_template_version: 2013-05-23
type: OS::Keystone::Role properties:
name: {get_param: role_name}
Name of keystone role.
Can be updated without replacement.
Optional property.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Keystone::Role properties: name: String
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Keystone::Role Properties: name: String
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Keystone::Role", "Properties": { "name": String } } } }
Note
Available since 2015.1 (Kilo) - Supported versions: keystone v3
Heat Template Resource for Keystone User.
heat_template_version: 2013-05-23
description: Sample Keystone User template
type: OS::Keystone::User properties:
name: {get_param: user_name} domain: {get_param: user_domain} description: {get_param: user_description} enabled: {get_param: user_enabled} email: {get_param: user_email} password: {get_param: user_password} default_project: {get_param: user_default_project} groups: {get_param: user_groups} roles:
- role: {get_param: group_role} domain: {get_param: group_role_domain}
- role: {get_param: group_role} project: {get_param: group_role_project}
Default project of keystone user.
Can be updated without replacement.
Optional property.
Value must be of type keystone.project
Description of keystone user.
Can be updated without replacement.
Optional property, defaults to “”.
Name of keystone domain.
Can be updated without replacement.
Optional property, defaults to “default”.
Value must be of type keystone.domain
Email address of keystone user.
Can be updated without replacement.
Optional property.
Keystone user is enabled or disabled
Can be updated without replacement.
Optional property, defaults to “True”.
keystone user groups.
Can be updated without replacement.
Optional property.
List contents:
keystone user group.
Updates cause replacement.
Optional property.
Value must be of type keystone.group
Name of keystone user.
Can be updated without replacement.
Optional property.
Password of keystone user.
Can be updated without replacement.
Optional property.
List of role assignments.
Can be updated without replacement.
Optional property.
List contents:
Map between role with either project or domain.
Updates cause replacement.
Optional property.
Map properties:
Keystone domain
Updates cause replacement.
Optional property.
Value must be of type keystone.domain
Keystone project
Updates cause replacement.
Optional property.
Value must be of type keystone.project
Keystone role
Updates cause replacement.
Required property.
Value must be of type keystone.role
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Keystone::User properties: default_project: String description: String domain: String email: String enabled: Boolean groups: [String, String, ...] name: String password: String roles: [{"project": String, "domain": String, "role": String}, {"project": String, "domain": String, "role": String}, ...]
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Keystone::User Properties: default_project: String description: String domain: String email: String enabled: Boolean groups: [String, String, ...] name: String password: String roles: [{"project": String, "domain": String, "role": String}, {"project": String, "domain": String, "role": String}, ...]
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Keystone::User", "Properties": { "default_project": String, "description": String, "domain": String, "email": String, "enabled": Boolean, "groups": [String, String, ...], "name": String, "password": String, "roles": [{"project": String, "domain": String, "role": String}, {"project": String, "domain": String, "role": String}, ...] } } } }
Network in CIDR notation.
Updates cause replacement.
Required property.
Nexthop IP address.
Updates cause replacement.
Required property.
The router id.
Updates cause replacement.
Required property.
Value must be of type neutron.router
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.
Note
Available since 2015.1 (Kilo)
Whether this firewall should be shared across all tenants. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only.
Can be updated without replacement.
Optional property, defaults to “False”.
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 shared: Boolean
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::Firewall Properties: admin_state_up: Boolean description: String firewall_policy_id: String name: String shared: Boolean
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::Firewall", "Properties": { "admin_state_up": Boolean, "description": String, "firewall_policy_id": String, "name": String, "shared": Boolean } } } }
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, defaults to “any”.
Allowed values: tcp, udp, icmp, any
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.
Can be updated without replacement.
Optional property.
Note
Available since 2014.2 (Juno)
Network to allocate floating IP from.
Updates cause replacement.
Optional property.
Value must be of type neutron.network
ID of an existing port with at least one IP address to associate with this floating IP.
Can be updated without replacement.
Optional property.
Value must be of type neutron.port
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 “{}”.
Note
DEPRECATED - Use property floating_network.
Updates cause replacement.
Optional property.
Value must be of type neutron.network
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Neutron::FloatingIP properties: fixed_ip_address: String floating_network: String port_id: String value_specs: {...}
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::FloatingIP Properties: fixed_ip_address: String floating_network: String port_id: String value_specs: {...}
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::FloatingIP", "Properties": { "fixed_ip_address": String, "floating_network": String, "port_id": String, "value_specs": {...} } } } }
IP address to use if the port has multiple addresses.
Can be updated without replacement.
Optional property.
ID of the floating IP to associate.
Can be updated without replacement.
Required property.
ID of an existing port with at least one IP address to associate with this floating IP.
Can be updated without replacement.
Required property.
Value must be of type neutron.port
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.
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 } } } }
Note
Available since 2014.1 (Icehouse)
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.
Note
Available since 2015.1 (Kilo)
Whether the metering label should be shared across all tenants.
Updates cause replacement.
Optional property, defaults to “False”.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Neutron::MeteringLabel properties: description: String name: String shared: Boolean
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::MeteringLabel Properties: description: String name: String shared: Boolean
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::MeteringLabel", "Properties": { "description": String, "name": String, "shared": Boolean } } } }
Note
Available since 2014.1 (Icehouse)
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": {...} } } } }
Note
Available since 2014.1 (Icehouse)
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:
Note
Available since 2014.2 (Juno)
The internal network to connect on the network gateway.
Updates cause replacement.
Optional property.
Value must be of type neutron.network
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
Note
DEPRECATED - Use property network.
Updates cause replacement.
Optional property.
Value must be of type neutron.network
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": String}, {"network_id": String, "segmentation_id": Integer, "segmentation_type": String, "network": 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": String}, {"network_id": String, "segmentation_id": Integer, "segmentation_type": String, "network": 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": String}, {"network_id": String, "segmentation_id": Integer, "segmentation_type": String, "network": 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
Note
Available since 2014.2 (Juno)
The subnet for the port on which the members of the pool will be connected.
Updates cause replacement.
Optional property.
Value must be of type neutron.subnet
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.
Value must be of type neutron.subnet
Note
DEPRECATED - Use property subnet.
Updates cause replacement.
Optional property.
Value must be of type neutron.subnet
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: 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: 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": 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} } } } }
Note
Available since 2014.1 (Icehouse)
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.
Note
Available since 2015.1 (Kilo)
The vnic type to be bound on the neutron port. To support SR-IOV PCI passthrough networking, you can request that the neutron port to be realized as normal (virtual nic), direct (pci passthrough), or macvtap (virtual interface with a tap-like software interface). Note that this only works for Neutron deployments that support the bindings extension.
Can be updated without replacement.
Optional property.
Allowed values: normal, direct, macvtap
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.
Note
Available since 2014.2 (Juno)
Subnet in which to allocate the IP address for this port.
Updates cause replacement.
Optional property.
Value must be of type neutron.subnet
Note
DEPRECATED - Use property subnet.
Updates cause replacement.
Optional property.
Value must be of type neutron.subnet
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.
Note
Available since 2014.2 (Juno)
Network this port belongs to. If you plan to use current port to assign Floating IP, you should specify fixed_ips with subnet
Updates cause replacement.
Optional property.
Value must be of type neutron.network
Policy on how to respond to a stack-update for this resource. REPLACE_ALWAYS will replace the port regardless of any property changes. AUTO will update the existing port for any changed update-allowed property.
Can be updated without replacement.
Optional property, defaults to “AUTO”.
Allowed values: REPLACE_ALWAYS, AUTO
Security group IDs to associate with this port.
Can be updated without replacement.
Optional property.
Extra parameters to include in the “port” object in the creation request.
Updates cause replacement.
Optional property, defaults to “{}”.
Note
DEPRECATED - Use property network.
Updates cause replacement.
Optional property.
Value must be of type neutron.network
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}, ...] binding:vnic_type: String device_id: String device_owner: String fixed_ips: [{"subnet_id": String, "subnet": String, "ip_address": String}, {"subnet_id": String, "subnet": String, "ip_address": String}, ...] mac_address: String name: String network: String replacement_policy: 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}, ...] binding:vnic_type: String device_id: String device_owner: String fixed_ips: [{"subnet_id": String, "subnet": String, "ip_address": String}, {"subnet_id": String, "subnet": String, "ip_address": String}, ...] mac_address: String name: String network: String replacement_policy: 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}, ...], "binding:vnic_type": String, "device_id": String, "device_owner": String, "fixed_ips": [{"subnet_id": String, "subnet": String, "ip_address": String}, {"subnet_id": String, "subnet": String, "ip_address": String}, ...], "mac_address": String, "name": String, "network": String, "replacement_policy": String, "security_groups": [Value, Value, ...], "value_specs": {...} } } } }
Note
Available since 2014.1 (Icehouse)
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”.
Note
Available since 2015.1 (Kilo)
Indicates whether or not to create a distributed router. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only. This property can not be used in conjunction with the L3 agent ID.
Updates cause replacement.
Optional property.
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.
Note
Available since 2015.1 (Kilo)
Indicates whether or not to create a highly available router. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only. And now neutron do not support distributed and ha at the same time.
Updates cause replacement.
Optional property.
Note
Available since 2015.1 (Kilo)
ID list of the L3 agent. User can specify multi-agents for highly available router. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only.
Can be updated without replacement.
Optional property.
List contents:
Updates cause 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 “{}”.
Note
DEPRECATED - Deprecated in Kilo. Use property l3_agent_ids.
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.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Neutron::Router properties: admin_state_up: Boolean distributed: Boolean external_gateway_info: {"enable_snat": Boolean, "network": String} ha: Boolean l3_agent_ids: [String, String, ...] name: String value_specs: {...}
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::Router Properties: admin_state_up: Boolean distributed: Boolean external_gateway_info: {"enable_snat": Boolean, "network": String} ha: Boolean l3_agent_ids: [String, String, ...] name: String value_specs: {...}
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::Router", "Properties": { "admin_state_up": Boolean, "distributed": Boolean, "external_gateway_info": {"enable_snat": Boolean, "network": String}, "ha": Boolean, "l3_agent_ids": [String, 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.
external network for the gateway.
Updates cause replacement.
Optional property.
Value must be of type neutron.network
ID of the router.
Updates cause replacement.
Required property.
Value must be of type neutron.router
Note
DEPRECATED - Use property network.
Updates cause replacement.
Optional property.
Value must be of type neutron.network
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Neutron::RouterGateway properties: network: String router_id: String
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::RouterGateway Properties: network: String router_id: String
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::RouterGateway", "Properties": { "network": String, "router_id": String } } } }
Note
Available since 2015.1 (Kilo)
The port, either subnet or port should be specified.
Updates cause replacement.
Optional property.
Value must be of type neutron.port
The router.
Updates cause replacement.
Optional property.
Value must be of type neutron.router
The subnet, either subnet or port should be specified.
Updates cause replacement.
Optional property.
Value must be of type neutron.subnet
Note
DEPRECATED - Deprecated in Kilo. Use property port.
The port id, either subnet or port_id should be specified.
Updates cause replacement.
Optional property.
Value must be of type neutron.port
Note
DEPRECATED - Use property router.
ID of the router.
Updates cause replacement.
Optional property.
Value must be of type neutron.router
Note
DEPRECATED - Use property subnet.
Updates cause replacement.
Optional property.
Value must be of type neutron.subnet
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Neutron::RouterInterface properties: port: String router: String subnet: String
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::RouterInterface Properties: port: String router: String subnet: String
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::RouterInterface", "Properties": { "port": String, "router": String, "subnet": String } } } }
Note
Available since 2014.1 (Icehouse)
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. The remote mode parameter must be set to “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. Set to any of [ null | ~ | “” ] to create the subnet without a gateway. If omitted, the first IP address within the subnet is assigned to the gateway.
Can be updated without replacement.
Optional property.
Can be updated without 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
Note
Available since 2015.1 (Kilo)
IPv6 address mode. dhcpv6-stateful, dhcpv6-stateless, or slaac.
Updates cause replacement.
Optional property.
Allowed values: dhcpv6-stateful, dhcpv6-stateless, slaac
Note
Available since 2015.1 (Kilo)
IPv6 RA (Router Advertisement) mode. dhcpv6-stateful, dhcpv6-stateless, or slaac.
Updates cause replacement.
Optional property.
Allowed values: dhcpv6-stateful, dhcpv6-stateless, slaac
The name of the subnet.
Can be updated without replacement.
Optional property.
The ID of the attached network.
Updates cause replacement.
Optional property.
Value must be of type neutron.network
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 “{}”.
Note
DEPRECATED - Use property network.
Updates cause replacement.
Optional property.
Value must be of type neutron.network
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 ipv6_address_mode: String ipv6_ra_mode: String name: String network: 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 ipv6_address_mode: String ipv6_ra_mode: String name: String network: 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, "ipv6_address_mode": String, "ipv6_ra_mode": String, "name": String, "network": 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.
The router to which the vpn service will be inserted.
Updates cause replacement.
Optional property.
Value must be of type neutron.router
Note
Available since 2014.2 (Juno)
Subnet in which the vpn service will be created.
Updates cause replacement.
Optional property.
Value must be of type neutron.subnet
Note
DEPRECATED - Use property router
Unique identifier for the router to which the vpn service will be inserted.
Updates cause replacement.
Optional property.
Value must be of type neutron.router
Note
DEPRECATED - Use property subnet.
Updates cause replacement.
Optional property.
Value must be of type neutron.subnet
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Neutron::VPNService properties: admin_state_up: Boolean description: String name: String router: String subnet: String
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::VPNService Properties: admin_state_up: Boolean description: String name: String router: String subnet: String
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::VPNService", "Properties": { "admin_state_up": Boolean, "description": String, "name": String, "router": String, "subnet": String } } } }
A resource for creating OpenStack virtual hardware templates.
Due to default nova security policy usage of this resource is limited to being used by administrators only. The rights may also be delegated to other users by redefining the access controls on the nova-api server.
Note that the current implementation of the Nova Flavor resource does not allow specifying the name and flavorid properties for the resource. This is done to avoid potential naming collision upon flavor creation as all flavor have a global scope.
Size of local disk in GB. Set the value to 0 to remove limit on disk size.
Updates cause replacement.
Required property.
Size of a secondary ephemeral data disk in GB.
Updates cause replacement.
Optional property, defaults to “0”.
Key/Value pairs to extend the capabilities of the flavor.
Can be updated without replacement.
Optional property.
Memory in MB for the flavor.
Updates cause replacement.
Required property.
RX/TX factor.
Updates cause replacement.
Optional property, defaults to “1.0”.
Swap space in MB.
Updates cause replacement.
Optional property, defaults to “0”.
Number of VCPUs for the flavor.
Updates cause replacement.
Required property.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Nova::Flavor properties: disk: Integer ephemeral: Integer extra_specs: {...} ram: Integer rxtx_factor: Number swap: Integer vcpus: Integer
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Nova::Flavor Properties: disk: Integer ephemeral: Integer extra_specs: {...} ram: Integer rxtx_factor: Number swap: Integer vcpus: Integer
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Nova::Flavor", "Properties": { "disk": Integer, "ephemeral": Integer, "extra_specs": {...}, "ram": Integer, "rxtx_factor": Number, "swap": Integer, "vcpus": Integer } } } }
Note
Available since 2014.1 (Icehouse)
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 } } } }
Note
Available since 2014.1 (Icehouse)
ID of the floating IP to assign to the server.
Can be updated without replacement.
Required property.
Server to assign floating IP to.
Can be updated without replacement.
Required property.
Value must be of type nova.server
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 } } } }
Note
Available since 2014.1 (Icehouse)
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 length must be in the range 1 to 255.
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 } } } }
Resource for Rackspace Cloud Servers.
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.
Value must be of type cinder.snapshot
The ID of the volume to boot from. Only one of volume_id or snapshot_id should be provided.
Updates cause replacement.
Optional property.
Value must be of type cinder.volume
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.
Block device mappings v2 for this server.
Updates cause replacement.
Optional property.
List contents:
Updates cause replacement.
Optional property.
Map properties:
Integer used for ordering the boot disks.
Updates cause replacement.
Optional property.
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.
Optional property.
Device type: at the moment we can make distinction only between disk and cdrom.
Updates cause replacement.
Optional property.
Allowed values: cdrom, disk
Bus of the device: hypervisor driver chooses a suitable default if omitted.
Updates cause replacement.
Optional property.
Allowed values: ide, lame_bus, scsi, usb, virtio
The ID of the image to create a volume from.
Updates cause replacement.
Optional property.
Value must be of type glance.image
The ID of the snapshot to create a volume from.
Updates cause replacement.
Optional property.
Value must be of type cinder.snapshot
The size of the swap, in MB.
Updates cause replacement.
Optional property.
The volume_id can be boot or non-boot device to the server.
Updates cause replacement.
Optional property.
Value must be of type cinder.volume
Size of the block device in GB. If it is omitted, hypervisor driver calculates size.
Updates cause replacement.
Optional property.
If True, enable config drive on the server.
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.
Value must be of type nova.flavor
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 “REBUILD”.
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.
Value must be of type neutron.network
ID of an existing port to associate with this server.
Updates cause replacement.
Optional property.
Value must be of type neutron.port
Note
DEPRECATED - Use property network.
ID of network to create a port on.
Updates cause replacement.
Optional property.
Value must be of type neutron.network
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. POLL_TEMP_URL will create and populate a Swift TempURL with metadata for polling.
Updates cause replacement.
Optional property, defaults to “POLL_SERVER_CFN”.
Allowed values: POLL_SERVER_CFN, POLL_SERVER_HEAT, POLL_TEMP_URL
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
DEPRECATED
Name 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.
Note
Available since 2015.1 (Kilo)
URLs of server’s consoles. To get a specific console type, the requested type can be specified as parameter to the get_attr function, e.g. get_attr: [ <server>, console_urls, novnc ]. Currently supported types are novnc, xvpvnc, spice-html5, rdp-html5, serial.
Note
DEPRECATED - Use the networks attribute instead of first_address. For example: “{get_attr: [<server name>, networks, <network name>, 0]}”
Convenience attribute to fetch the first assigned network address, or an empty string if nothing has been assigned at this time. Result may not be predictable if the server has addresses from more than one network.
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}, ...] block_device_mapping_v2: [{"disk_bus": String, "image_id": String, "boot_index": Integer, "device_type": String, "swap_size": Integer, "volume_id": String, "delete_on_termination": Boolean, "snapshot_id": String, "volume_size": Integer, "device_name": String}, {"disk_bus": String, "image_id": String, "boot_index": Integer, "device_type": String, "swap_size": Integer, "volume_id": String, "delete_on_termination": Boolean, "snapshot_id": String, "volume_size": Integer, "device_name": String}, ...] config_drive: Boolean 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}, ...] block_device_mapping_v2: [{"disk_bus": String, "image_id": String, "boot_index": Integer, "device_type": String, "swap_size": Integer, "volume_id": String, "delete_on_termination": Boolean, "snapshot_id": String, "volume_size": Integer, "device_name": String}, {"disk_bus": String, "image_id": String, "boot_index": Integer, "device_type": String, "swap_size": Integer, "volume_id": String, "delete_on_termination": Boolean, "snapshot_id": String, "volume_size": Integer, "device_name": String}, ...] config_drive: Boolean 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}, ...], "block_device_mapping_v2": [{"disk_bus": String, "image_id": String, "boot_index": Integer, "device_type": String, "swap_size": Integer, "volume_id": String, "delete_on_termination": Boolean, "snapshot_id": String, "volume_size": Integer, "device_name": String}, {"disk_bus": String, "image_id": String, "boot_index": Integer, "device_type": String, "swap_size": Integer, "volume_id": String, "delete_on_termination": Boolean, "snapshot_id": String, "volume_size": Integer, "device_name": String}, ...], "config_drive": Boolean, "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 } } } }
Note
Available since 2014.2 (Juno)
A resource for managing a Nova server group.
Server Group name.
Updates cause replacement.
Optional property.
A list of string policies to apply. Defaults to anti-affinity.
Updates cause replacement.
Optional property, defaults to “[‘anti-affinity’]”.
Allowed values: anti-affinity, affinity
List contents:
Updates cause replacement.
Optional property.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Nova::ServerGroup properties: name: String policies: [String, String, ...]
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Nova::ServerGroup Properties: name: String policies: [String, String, ...]
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Nova::ServerGroup", "Properties": { "name": String, "policies": [String, String, ...] } } } }
ID of the Cluster Template used for Node Groups and configurations.
Updates cause replacement.
Required property.
Default name or UUID of the image used to boot Hadoop nodes.
Updates cause replacement.
Optional property.
Value must be of type sahara.image
Version of Hadoop running on instances.
Updates cause replacement.
Required property.
Keypair added to instances to make them accessible for user.
Updates cause replacement.
Optional property.
Value must be of type nova.keypair
Hadoop cluster name.
Updates cause replacement.
Optional property.
Name or UUID of network.
Updates cause replacement.
Optional property.
Value must be of type neutron.network
Plugin name.
Updates cause replacement.
Required property.
Note
DEPRECATED - Property was deprecated in Kilo release. Use property default_image_id.
Name or UUID of the image used to boot Hadoop nodes.
Updates cause replacement.
Optional property.
Value must be of type glance.image
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Sahara::Cluster properties: cluster_template_id: String default_image_id: String hadoop_version: String key_name: String name: String neutron_management_network: String plugin_name: String
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Sahara::Cluster Properties: cluster_template_id: String default_image_id: String hadoop_version: String key_name: String name: String neutron_management_network: String plugin_name: String
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Sahara::Cluster", "Properties": { "cluster_template_id": String, "default_image_id": String, "hadoop_version": String, "key_name": String, "name": String, "neutron_management_network": String, "plugin_name": String } } } }
Note
Available since 2014.2 (Juno)
List of processes to enable anti-affinity for.
Updates cause replacement.
Optional property.
List contents:
Updates cause replacement.
Optional property.
Cluster configs dictionary.
Updates cause replacement.
Optional property.
ID of the default image to use for the template.
Updates cause replacement.
Optional property.
Value must be of type sahara.image
Description of the Sahara Group Template.
Updates cause replacement.
Optional property, defaults to “”.
Version of Hadoop running on instances.
Updates cause replacement.
Required property.
Name for the Sahara Cluster Template.
Updates cause replacement.
Optional property.
The length must be in the range 1 to 50.
Value must match pattern: ^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])$
Name or UUID of network.
Updates cause replacement.
Optional property.
Value must be of type neutron.network
Node groups.
Updates cause replacement.
Optional property.
List contents:
Updates cause replacement.
Optional property.
Map properties:
Number of instances in the Node group.
Updates cause replacement.
Required property.
The value must be at least 1.
Name of the Node group.
Updates cause replacement.
Required property.
ID of the Node Group Template.
Updates cause replacement.
Required property.
Plugin name.
Updates cause replacement.
Required property.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Sahara::ClusterTemplate properties: anti_affinity: [String, String, ...] cluster_configs: {...} default_image_id: String description: String hadoop_version: String name: String neutron_management_network: String node_groups: [{"count": Integer, "name": String, "node_group_template_id": String}, {"count": Integer, "name": String, "node_group_template_id": String}, ...] plugin_name: String
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Sahara::ClusterTemplate Properties: anti_affinity: [String, String, ...] cluster_configs: {...} default_image_id: String description: String hadoop_version: String name: String neutron_management_network: String node_groups: [{"count": Integer, "name": String, "node_group_template_id": String}, {"count": Integer, "name": String, "node_group_template_id": String}, ...] plugin_name: String
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Sahara::ClusterTemplate", "Properties": { "anti_affinity": [String, String, ...], "cluster_configs": {...}, "default_image_id": String, "description": String, "hadoop_version": String, "name": String, "neutron_management_network": String, "node_groups": [{"count": Integer, "name": String, "node_group_template_id": String}, {"count": Integer, "name": String, "node_group_template_id": String}, ...], "plugin_name": String } } } }
Note
Available since 2014.2 (Juno)
Defines whether auto-assign security group to this Node Group template.
Updates cause replacement.
Optional property.
Availability zone to create servers in.
Updates cause replacement.
Optional property.
Description of the Node Group Template.
Updates cause replacement.
Optional property, defaults to “”.
Name or ID Nova flavor for the nodes.
Updates cause replacement.
Required property.
Value must be of type nova.flavor
Name or UUID of the Neutron floating IP network or name of the Nova floating ip pool to use. Should not be provided when used with Nova-network that auto-assign floating IPs.
Updates cause replacement.
Optional property.
Version of Hadoop running on instances.
Updates cause replacement.
Required property.
ID of the image to use for the template.
Updates cause replacement.
Optional property.
Value must be of type sahara.image
Name for the Sahara Node Group Template.
Updates cause replacement.
Optional property.
The length must be in the range 1 to 50.
Value must match pattern: ^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])$
Dictionary of node configurations.
Updates cause replacement.
Optional property.
List of processes to run on every node.
Updates cause replacement.
Required property.
The length must be at least 1.
List contents:
Updates cause replacement.
Optional property.
Plugin name.
Updates cause replacement.
Required property.
List of security group names or IDs to assign to this Node Group template.
Updates cause replacement.
Optional property.
List contents:
Updates cause replacement.
Optional property.
Type of the volume to create on Cinder backend.
Updates cause replacement.
Optional property.
Value must be of type cinder.vtype
Availability zone to create volumes in.
Updates cause replacement.
Optional property.
Volumes per node.
Updates cause replacement.
Optional property.
The value must be at least 0.
Size of the volumes, in GB.
Updates cause replacement.
Optional property.
The value must be at least 1.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Sahara::NodeGroupTemplate properties: auto_security_group: Boolean availability_zone: String description: String flavor: String floating_ip_pool: String hadoop_version: String image_id: String name: String node_configs: {...} node_processes: [String, String, ...] plugin_name: String security_groups: [String, String, ...] volume_type: String volumes_availability_zone: String volumes_per_node: Integer volumes_size: Integer
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Sahara::NodeGroupTemplate Properties: auto_security_group: Boolean availability_zone: String description: String flavor: String floating_ip_pool: String hadoop_version: String image_id: String name: String node_configs: {...} node_processes: [String, String, ...] plugin_name: String security_groups: [String, String, ...] volume_type: String volumes_availability_zone: String volumes_per_node: Integer volumes_size: Integer
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Sahara::NodeGroupTemplate", "Properties": { "auto_security_group": Boolean, "availability_zone": String, "description": String, "flavor": String, "floating_ip_pool": String, "hadoop_version": String, "image_id": String, "name": String, "node_configs": {...}, "node_processes": [String, String, ...], "plugin_name": String, "security_groups": [String, String, ...], "volume_type": String, "volumes_availability_zone": String, "volumes_per_node": Integer, "volumes_size": Integer } } } }
Note
Available since 2015.1 (Kilo)
If True, delete any objects in the container when the container is deleted. Otherwise, deleting a non-empty container will result in an error.
Updates cause replacement.
Optional property, defaults to “False”.
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: PurgeOnDelete: Boolean 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: PurgeOnDelete: Boolean 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": { "PurgeOnDelete": Boolean, "X-Account-Meta": {...}, "X-Container-Meta": {...}, "X-Container-Read": String, "X-Container-Write": String, "name": String } } } }
Note
Available since 2015.1 (Kilo)
Name of registered datastore type.
Updates cause replacement.
Required property.
The length must be no greater than 255.
Name of the registered datastore version. It must exist for provided datastore type. Defaults to using single active version. If several active versions exist for provided datastore type, explicit value for this parameter must be specified.
Updates cause replacement.
Required property.
The length must be no greater than 255.
List of database instances.
Updates cause replacement.
Required property.
List contents:
Updates cause replacement.
Optional property.
Map properties:
Flavor of the instance.
Updates cause replacement.
Required property.
Value must be of type trove.flavor
Size of the instance disk volume in GB.
Updates cause replacement.
Required property.
The value must be in the range 1 to 150.
Name of the cluster to create.
Updates cause replacement.
Optional property.
The length must be no greater than 255.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Trove::Cluster properties: datastore_type: String datastore_version: String instances: [{"volume_size": Integer, "flavor": String}, {"volume_size": Integer, "flavor": String}, ...] name: String
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Trove::Cluster Properties: datastore_type: String datastore_version: String instances: [{"volume_size": Integer, "flavor": String}, {"volume_size": Integer, "flavor": String}, ...] name: String
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Trove::Cluster", "Properties": { "datastore_type": String, "datastore_version": String, "instances": [{"volume_size": Integer, "flavor": String}, {"volume_size": Integer, "flavor": String}, ...], "name": String } } } }
Note
Available since 2014.1 (Icehouse)
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_]+
Name of registered datastore type.
Updates cause replacement.
Optional property.
The length must be no greater than 255.
Name of the registered datastore version. It must exist for provided datastore type. Defaults to using single active version. If several active versions exist for provided datastore type, explicit value for this parameter must be specified.
Updates cause replacement.
Optional property.
The length must be no greater than 255.
Reference to a flavor for creating DB instance.
Updates cause replacement.
Required property.
Value must be of type trove.flavor
Name of the DB instance to create.
Updates cause replacement.
Optional property.
The length must be no greater than 255.
List of network interfaces to create on instance.
Updates cause replacement.
Optional property, defaults to “[]”.
List contents:
Updates cause replacement.
Optional property.
Map properties:
Fixed IPv4 address for this NIC.
Updates cause replacement.
Optional property.
Name or UUID of the network to attach this NIC to. Either port or network must be specified.
Updates cause replacement.
Optional property.
Value must be of type neutron.network
Name or UUID of Neutron port to attach this NIC to. Either port or network must be specified.
Updates cause replacement.
Optional property.
Value must be of type neutron.port
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.
The length must be at least 1.
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}, ...] datastore_type: String datastore_version: String flavor: String name: String networks: [{"fixed_ip": String, "network": String, "port": String}, {"fixed_ip": String, "network": String, "port": 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}, ...] datastore_type: String datastore_version: String flavor: String name: String networks: [{"fixed_ip": String, "network": String, "port": String}, {"fixed_ip": String, "network": String, "port": 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}, ...], "datastore_type": String, "datastore_version": String, "flavor": String, "name": String, "networks": [{"fixed_ip": String, "network": String, "port": String}, {"fixed_ip": String, "network": String, "port": 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, ...]}, ...] } } } }
Arbitrary key/value metadata to store contextual information about this queue.
Can be updated without replacement.
Optional property.
Name of the queue instance to create.
Updates cause replacement.
Required property.
Note
DEPRECATED - Deprecated in kilo. Use get_resource|Ref command instead. For example: { get_resource : <resource_name> }
ID of the queue.
heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Zaqar::Queue properties: metadata: {...} name: String
HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Zaqar::Queue Properties: metadata: {...} name: String
{ "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Zaqar::Queue", "Properties": { "metadata": {...}, "name": String } } } }