OpenStack Resource Types
OS::Ceilometer::Alarm
Properties alarm_actions A list of URLs (webhooks) to invoke when state transitions to alarm. Can be updated without replacement. Optional property. comparison_operator Operator used to compare specified statistic with threshold. Can be updated without replacement. Optional property. Allowed values: ge, gt, eq, ne, lt, le description Description for the alarm. Can be updated without replacement. Optional property. enabled True if alarm evaluation/actioning is enabled. Can be updated without replacement. Optional property, defaults to "true". evaluation_periods Number of periods to evaluate over. Can be updated without replacement. Optional property. insufficient_data_actions A list of URLs (webhooks) to invoke when state transitions to insufficient-data. Can be updated without replacement. Optional property. matching_metadata Meter should match this resource metadata (key=value) additionally to the meter_name. Updates cause replacement. Optional property, defaults to "{}". meter_name Meter name watched by the alarm. Updates cause replacement. Required property. ok_actions A list of URLs (webhooks) to invoke when state transitions to ok. Can be updated without replacement. Optional property. period Period (seconds) to evaluate over. Can be updated without replacement. Optional property. repeat_actions 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". statistic Meter statistic to evaluate. Can be updated without replacement. Optional property. Allowed values: count, avg, sum, min, max threshold Threshold to evaluate against. Can be updated without replacement. Required property.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Ceilometer::Alarm properties: alarm_actions: [Value, Value, ...] comparison_operator: String description: String enabled: Boolean evaluation_periods: Integer insufficient_data_actions: [Value, Value, ...] matching_metadata: {...} meter_name: String ok_actions: [Value, Value, ...] period: Integer repeat_actions: Boolean statistic: String threshold: Number
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Ceilometer::Alarm Properties: alarm_actions: [Value, Value, ...] comparison_operator: String description: String enabled: Boolean evaluation_periods: Integer insufficient_data_actions: [Value, Value, ...] matching_metadata: {...} meter_name: String ok_actions: [Value, Value, ...] period: Integer repeat_actions: Boolean statistic: String threshold: Number
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Ceilometer::Alarm", "Properties": { "alarm_actions": [Value, Value, ...], "comparison_operator": String, "description": String, "enabled": Boolean, "evaluation_periods": Integer, "insufficient_data_actions": [Value, Value, ...], "matching_metadata": {...}, "meter_name": String, "ok_actions": [Value, Value, ...], "period": Integer, "repeat_actions": Boolean, "statistic": String, "threshold": Number } } } }
OS::Ceilometer::CombinationAlarm Available since 2014.1 (Icehouse).
Properties alarm_actions A list of URLs (webhooks) to invoke when state transitions to alarm. Can be updated without replacement. Optional property. alarm_ids List of alarm identifiers to combine. Can be updated without replacement. Required property. The length must be at least 1. description Description for the alarm. Can be updated without replacement. Optional property. enabled True if alarm evaluation/actioning is enabled. Can be updated without replacement. Optional property, defaults to "true". insufficient_data_actions A list of URLs (webhooks) to invoke when state transitions to insufficient-data. Can be updated without replacement. Optional property. ok_actions A list of URLs (webhooks) to invoke when state transitions to ok. Can be updated without replacement. Optional property. operator Operator used to combine the alarms. Can be updated without replacement. Optional property. Allowed values: and, or repeat_actions 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".
HOT Syntax 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
YAML Syntax 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
JSON Syntax { "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 } } } }
OS::Cinder::Volume
Properties availability_zone The availability zone in which the volume will be created. Updates cause replacement. Optional property. backup_id If specified, the backup to create the volume from. Updates cause replacement. Optional property. description A description of the volume. Can be updated without replacement. Optional property. image 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 metadata Key/value pairs to associate with the volume. Can be updated without replacement. Optional property. name A name used to distinguish the volume. Can be updated without replacement. Optional property. size 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. snapshot_id If specified, the snapshot to create the volume from. Updates cause replacement. Optional property. source_volid If specified, the volume to use as source. Updates cause replacement. Optional property. volume_type If specified, the type of volume to use, mapping to a specific backend. Updates cause replacement. Optional property. imageRef DEPRECATED - Use property image. The ID of the image to create the volume from. Updates cause replacement. Optional property.
Attributes attachments The list of attachments of the volume. availability_zone The availability zone in which the volume is located. bootable Boolean indicating if the volume can be booted or not. created_at The timestamp indicating volume creation. display_description Description of the volume. display_name Name of the volume. encrypted Boolean indicating if the volume is encrypted or not. metadata Key/value pairs associated with the volume. metadata_values Key/value pairs associated with the volume in raw dict form. size The size of the volume in GB. snapshot_id The snapshot the volume was created from, if any. source_volid The volume used as source, if any. status The current status of the volume. volume_type The type of the volume mapping to a backend, if any.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Cinder::Volume properties: availability_zone: String backup_id: String description: String image: String metadata: {...} name: String size: Integer snapshot_id: String source_volid: String volume_type: String
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Cinder::Volume Properties: availability_zone: String backup_id: String description: String image: String metadata: {...} name: String size: Integer snapshot_id: String source_volid: String volume_type: String
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Cinder::Volume", "Properties": { "availability_zone": String, "backup_id": String, "description": String, "image": String, "metadata": {...}, "name": String, "size": Integer, "snapshot_id": String, "source_volid": String, "volume_type": String } } } }
OS::Cinder::VolumeAttachment
Properties instance_uuid The ID of the server to which the volume attaches. Can be updated without replacement. Required property. mountpoint 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. volume_id The ID of the volume to be attached. Can be updated without replacement. Required property.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Cinder::VolumeAttachment properties: instance_uuid: String mountpoint: String volume_id: String
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Cinder::VolumeAttachment Properties: instance_uuid: String mountpoint: String volume_id: String
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Cinder::VolumeAttachment", "Properties": { "instance_uuid": String, "mountpoint": String, "volume_id": String } } } }
OS::Glance::Image A resource managing for image in Glance. Available since 2014.2 (Juno).
Properties container_format Container format of image. Updates cause replacement. Required property. Allowed values: ami, ari, aki, bare, ova, ovf disk_format Disk format of image. Updates cause replacement. Required property. Allowed values: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso id The image ID. Glance will generate a UUID if not specified. Updates cause replacement. Optional property. is_public Scope of image accessibility. Public or private. Default value is False means private. Updates cause replacement. Optional property, defaults to "False". location 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. min_disk 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. min_ram 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 Name for the image. The name of an image is not unique to a Image Service node. Updates cause replacement. Optional property. protected Whether the image can be deleted. If the value is True, the image is protected and cannot be deleted. Updates cause replacement. Optional property.
HOT Syntax 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
YAML Syntax 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
JSON Syntax { "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 } } } }
OS::Heat::AccessPolicy
Properties AllowedResources Resources that users are allowed to access by the DescribeStackResource API. Updates cause replacement. Required property.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::AccessPolicy properties: AllowedResources: [Value, Value, ...]
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::AccessPolicy Properties: AllowedResources: [Value, Value, ...]
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::AccessPolicy", "Properties": { "AllowedResources": [Value, Value, ...] } } } }
OS::Heat::AutoScalingGroup An autoscaling group that can scale arbitrary resources. Available since 2014.1 (Icehouse).
Properties cooldown Cooldown period, in seconds. Can be updated without replacement. Optional property. desired_capacity Desired initial number of resources. Can be updated without replacement. Optional property. max_size Maximum number of resources in the group. Can be updated without replacement. Required property. The value must be at least 0. min_size Minimum number of resources in the group. Can be updated without replacement. Required property. The value must be at least 0. resource 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. rolling_updates Policy for rolling updates for this scaling group. Can be updated without replacement. Optional property. Map properties: max_batch_size The maximum number of resources to replace at once. Updates cause replacement. Optional property, defaults to "1". The value must be at least 0. min_in_service 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. pause_time 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.
Attributes current_size The current size of AutoscalingResourceGroup. outputs A map of resource names to the specified attribute of each individual resource. outputs_list A list of the specified attribute of each individual resource.
HOT Syntax 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}
YAML Syntax 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}
JSON Syntax { "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} } } } }
OS::Heat::CWLiteAlarm DEPRECATED - OS::Heat::CWLiteAlarm is deprecated, use OS::Ceilometer::Alarm instead.
Properties AlarmActions A list of actions to execute when state transitions to alarm. Can be updated without replacement. Optional property. AlarmDescription Description for the alarm. Can be updated without replacement. Optional property. ComparisonOperator Operator used to compare the specified Statistic with Threshold. Can be updated without replacement. Optional property. Allowed values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold Dimensions A list of dimensions (arbitrary name/value pairs) associated with the metric. Updates cause replacement. Optional property. EvaluationPeriods Number of periods to evaluate over. Can be updated without replacement. Optional property. InsufficientDataActions A list of actions to execute when state transitions to insufficient-data. Can be updated without replacement. Optional property. MetricName Metric name watched by the alarm. Updates cause replacement. Optional property. Namespace Namespace for the metric. Updates cause replacement. Optional property. OKActions A list of actions to execute when state transitions to ok. Can be updated without replacement. Optional property. Period Period (seconds) to evaluate over. Can be updated without replacement. Optional property. Statistic Metric statistic to evaluate. Can be updated without replacement. Optional property. Allowed values: SampleCount, Average, Sum, Minimum, Maximum Threshold Threshold to evaluate against. Can be updated without replacement. Optional property. Units 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
HOT Syntax 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
YAML Syntax 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
JSON Syntax { "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 } } } }
OS::Heat::CloudConfig 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. Available since 2014.1 (Icehouse).
Properties cloud_config Map representing the cloud-config data structure which will be formatted as YAML. Updates cause replacement. Optional property.
Attributes config The config value of the software config.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::CloudConfig properties: cloud_config: {...}
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::CloudConfig Properties: cloud_config: {...}
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::CloudConfig", "Properties": { "cloud_config": {...} } } } }
OS::Heat::HARestarter
Properties InstanceId Instance ID to be restarted. Updates cause replacement. Required property.
Attributes AlarmUrl A signed url to handle the alarm (Heat extension).
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::HARestarter properties: InstanceId: String
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::HARestarter Properties: InstanceId: String
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::HARestarter", "Properties": { "InstanceId": String } } } }
OS::Heat::InstanceGroup
Properties AvailabilityZones Not Implemented. Updates cause replacement. Required property. LaunchConfigurationName Name of LaunchConfiguration resource. Can be updated without replacement. Required property. LoadBalancerNames List of LoadBalancer resources. Updates cause replacement. Optional property. Size Desired number of instances. Can be updated without replacement. Required property. Tags Tags to attach to this group. Updates cause replacement. Optional property. List contents: * Updates cause replacement. Optional property. Map properties: Key Updates cause replacement. Required property. Value Updates cause replacement. Required property.
Attributes InstanceList A comma-delimited list of server ip addresses. (Heat extension).
HOT Syntax 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}, ...]
YAML Syntax 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}, ...]
JSON Syntax { "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}, ...] } } } }
OS::Heat::MultipartMime 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. Available since 2014.1 (Icehouse).
Properties parts Parts belonging to this message. Updates cause replacement. Optional property, defaults to "[]". List contents: * Updates cause replacement. Optional property. Map properties: config Content of part to attach, either inline or by referencing the ID of another software config resource Updates cause replacement. Required property. filename Optional filename to associate with part. Updates cause replacement. Optional property. subtype Optional subtype to specify with the type. Updates cause replacement. Optional property. type Whether the part content is text or multipart. Updates cause replacement. Optional property, defaults to "text". Allowed values: text, multipart
Attributes config The config value of the software config.
HOT Syntax 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}, ...]
YAML Syntax 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}, ...]
JSON Syntax { "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}, ...] } } } }
OS::Heat::RandomString A resource which generates a random string. This is useful for configuring passwords and secrets on services. Available since 2014.1 (Icehouse).
Properties character_classes 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: class 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 min 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. character_sequences 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: min 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. sequence A character sequence and its corresponding min constraint to generate the random string from. Updates cause replacement. Required property. length Length of the string to generate. Updates cause replacement. Optional property, defaults to "32". The value must be in the range 1 to 512. salt Value which can be set or changed on stack update to trigger the resource for replacement with a new random string . The salt value itself is ignored by the random generator. Updates cause replacement. Optional property. sequence 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
Attributes value The random string generated by this resource. This value is also available by referencing the resource.
HOT Syntax 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
YAML Syntax 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
JSON Syntax { "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 } } } }
OS::Heat::ResourceGroup 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. Available since 2014.1 (Icehouse).
Properties count The number of instances to create. Can be updated without replacement. Optional property, defaults to "1". The value must be at least 0. index_var 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. resource_def Resource definition for the resources in the group. The value of this property is the definition of a resource just as if it had been declared in the template itself. Updates cause replacement. Required property. Map properties: properties Property values for the resources in the group Updates cause replacement. Optional property. type The type of the resources in the group Updates cause replacement. Required property.
Attributes attributes A map of resource names to the specified attribute of each individual resource. refs A list of resource IDs for the resources in the group
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::ResourceGroup properties: count: Integer index_var: String resource_def: {"type": String, "properties": {...}}
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::ResourceGroup Properties: count: Integer index_var: String resource_def: {"type": String, "properties": {...}}
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::ResourceGroup", "Properties": { "count": Integer, "index_var": String, "resource_def": {"type": String, "properties": {...}} } } } }
OS::Heat::ScalingPolicy A resource to manage scaling of OS::Heat::AutoScalingGroup. while it may incidentally support AWS::AutoScaling::AutoScalingGroup for now, please don't use it for that purpose and use AWS::AutoScaling::ScalingPolicy instead.
Properties adjustment_type Type of adjustment (absolute or percentage). Can be updated without replacement. Required property. Allowed values: change_in_capacity, exact_capacity, percent_change_in_capacity auto_scaling_group_id AutoScaling group ID to apply policy to. Updates cause replacement. Required property. cooldown Cooldown period, in seconds. Can be updated without replacement. Optional property. scaling_adjustment Size of adjustment. Can be updated without replacement. Required property.
Attributes alarm_url A signed url to handle the alarm.
HOT Syntax 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
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::ScalingPolicy Properties: adjustment_type: String auto_scaling_group_id: String cooldown: Number scaling_adjustment: Number
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::ScalingPolicy", "Properties": { "adjustment_type": String, "auto_scaling_group_id": String, "cooldown": Number, "scaling_adjustment": Number } } } }
OS::Heat::SoftwareComponent 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. Available since 2014.1 (Icehouse).
Properties configs 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: actions 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. Required property. The length must be at least 1. List contents: * Updates cause replacement. Optional property. config Configuration script or manifest which specifies what actual configuration is performed. Updates cause replacement. Optional property. tool 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. inputs 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 Default value for the input if none is specified. Updates cause replacement. Optional property. description Description of the input. Updates cause replacement. Optional property. name Name of the input. Updates cause replacement. Required property. type Type of the value of the input. Updates cause replacement. Optional property, defaults to "String". Allowed values: String, Number, CommaDelimitedList, Json options Map containing options specific to the configuration management tool used by this resource. Updates cause replacement. Optional property. outputs 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 Description of the output. Updates cause replacement. Optional property. error_output Denotes that the deployment is in an error state if this output has a value. Updates cause replacement. Optional property, defaults to "False". name Name of the output. Updates cause replacement. Required property. type Type of the value of the output. Updates cause replacement. Optional property, defaults to "String". Allowed values: String, Number, CommaDelimitedList, Json
Attributes config The config value of the software config.
HOT Syntax 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}, ...]
YAML Syntax 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}, ...]
JSON Syntax { "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}, ...] } } } }
OS::Heat::SoftwareConfig 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. Available since 2014.1 (Icehouse).
Properties config Configuration script or manifest which specifies what actual configuration is performed. Updates cause replacement. Optional property. group 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". inputs 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 Default value for the input if none is specified. Updates cause replacement. Optional property. description Description of the input. Updates cause replacement. Optional property. name Name of the input. Updates cause replacement. Required property. type Type of the value of the input. Updates cause replacement. Optional property, defaults to "String". Allowed values: String, Number, CommaDelimitedList, Json options Map containing options specific to the configuration management tool used by this resource. Updates cause replacement. Optional property. outputs 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 Description of the output. Updates cause replacement. Optional property. error_output Denotes that the deployment is in an error state if this output has a value. Updates cause replacement. Optional property, defaults to "False". name Name of the output. Updates cause replacement. Required property. type Type of the value of the output. Updates cause replacement. Optional property, defaults to "String". Allowed values: String, Number, CommaDelimitedList, Json
Attributes config The config value of the software config.
HOT Syntax 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}, ...]
YAML Syntax 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}, ...]
JSON Syntax { "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}, ...] } } } }
OS::Heat::SoftwareDeployment 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. Available since 2014.1 (Icehouse).
Properties 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 config ID of software configuration resource to execute when applying to the server. Can be updated without replacement. Optional property. input_values Input values to apply to the software configuration on this server. Can be updated without replacement. Optional property. name 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. server ID of Nova server to apply configuration to. Updates cause replacement. Optional property. signal_transport How the server should signal to heat with the deployment output values. CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL. HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal. Updates cause replacement. Optional property, defaults to "CFN_SIGNAL". Allowed values: CFN_SIGNAL, HEAT_SIGNAL, NO_SIGNAL
Attributes deploy_status_code Returned status code from the configuration execution deploy_stderr Captured stderr from the configuration execution. deploy_stdout Captured stdout from the configuration execution.
HOT Syntax 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
YAML Syntax 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
JSON Syntax { "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 } } } }
OS::Heat::SoftwareDeployments Available since 2014.1 (Icehouse).
Properties 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 config ID of software configuration resource to execute when applying to the server. Can be updated without replacement. Optional property. input_values Input values to apply to the software configuration on this server. Can be updated without replacement. Optional property. name 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. servers A map of Nova names and IDs to apply configuration to. Updates cause replacement. Optional property. signal_transport How the server should signal to heat with the deployment output values. CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL. HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal. Updates cause replacement. Optional property, defaults to "CFN_SIGNAL". Allowed values: CFN_SIGNAL, HEAT_SIGNAL, NO_SIGNAL
Attributes deploy_status_codes A map of Nova names and returned status code from the configuration execution deploy_stderrs A map of Nova names and captured stderrs from the configuration execution to each server. deploy_stdouts A map of Nova names and captured stdouts from the configuration execution to each server.
HOT Syntax 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
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::SoftwareDeployments Properties: actions: [Value, Value, ...] config: String input_values: {...} name: String servers: {...} signal_transport: String
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::SoftwareDeployments", "Properties": { "actions": [Value, Value, ...], "config": String, "input_values": {...}, "name": String, "servers": {...}, "signal_transport": String } } } }
OS::Heat::StructuredConfig 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. Available since 2014.1 (Icehouse).
Properties config Map representing the configuration data structure which will be serialized to JSON format. Updates cause replacement. Optional property. group 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". inputs 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 Default value for the input if none is specified. Updates cause replacement. Optional property. description Description of the input. Updates cause replacement. Optional property. name Name of the input. Updates cause replacement. Required property. type Type of the value of the input. Updates cause replacement. Optional property, defaults to "String". Allowed values: String, Number, CommaDelimitedList, Json options Map containing options specific to the configuration management tool used by this resource. Updates cause replacement. Optional property. outputs 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 Description of the output. Updates cause replacement. Optional property. error_output Denotes that the deployment is in an error state if this output has a value. Updates cause replacement. Optional property, defaults to "False". name Name of the output. Updates cause replacement. Required property. type Type of the value of the output. Updates cause replacement. Optional property, defaults to "String". Allowed values: String, Number, CommaDelimitedList, Json
Attributes config The config value of the software config.
HOT Syntax 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}, ...]
YAML Syntax 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}, ...]
JSON Syntax { "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}, ...] } } } }
OS::Heat::StructuredDeployment 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. Available since 2014.1 (Icehouse).
Properties 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 config ID of software configuration resource to execute when applying to the server. Can be updated without replacement. Optional property. input_key Name of key to use for substituting inputs during deployment Updates cause replacement. Optional property, defaults to "get_input". input_values Input values to apply to the software configuration on this server. Can be updated without replacement. Optional property. name 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. server ID of Nova server to apply configuration to. Updates cause replacement. Optional property. signal_transport How the server should signal to heat with the deployment output values. CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL. HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal. Updates cause replacement. Optional property, defaults to "CFN_SIGNAL". Allowed values: CFN_SIGNAL, HEAT_SIGNAL, NO_SIGNAL
Attributes deploy_status_code Returned status code from the configuration execution deploy_stderr Captured stderr from the configuration execution. deploy_stdout Captured stdout from the configuration execution.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::StructuredDeployment properties: actions: [Value, Value, ...] config: String input_key: String input_values: {...} name: String server: String signal_transport: String
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::StructuredDeployment Properties: actions: [Value, Value, ...] config: String input_key: String input_values: {...} name: String server: String signal_transport: String
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::StructuredDeployment", "Properties": { "actions": [Value, Value, ...], "config": String, "input_key": String, "input_values": {...}, "name": String, "server": String, "signal_transport": String } } } }
OS::Heat::StructuredDeployments Available since 2014.1 (Icehouse).
Properties 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 config ID of software configuration resource to execute when applying to the server. Can be updated without replacement. Optional property. input_key Name of key to use for substituting inputs during deployment Updates cause replacement. Optional property, defaults to "get_input". input_values Input values to apply to the software configuration on this server. Can be updated without replacement. Optional property. name 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. servers A map of Nova names and IDs to apply configuration to. Updates cause replacement. Optional property. signal_transport How the server should signal to heat with the deployment output values. CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL. HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal. Updates cause replacement. Optional property, defaults to "CFN_SIGNAL". Allowed values: CFN_SIGNAL, HEAT_SIGNAL, NO_SIGNAL
Attributes deploy_status_codes A map of Nova names and returned status code from the configuration execution deploy_stderrs A map of Nova names and captured stderrs from the configuration execution to each server. deploy_stdouts A map of Nova names and captured stdouts from the configuration execution to each server.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::StructuredDeployments properties: actions: [Value, Value, ...] config: String input_key: String input_values: {...} name: String servers: {...} signal_transport: String
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::StructuredDeployments Properties: actions: [Value, Value, ...] config: String input_key: String input_values: {...} name: String servers: {...} signal_transport: String
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::StructuredDeployments", "Properties": { "actions": [Value, Value, ...], "config": String, "input_key": String, "input_values": {...}, "name": String, "servers": {...}, "signal_transport": String } } } }
OS::Heat::SwiftSignal Available since 2014.2 (Juno).
Properties count 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. handle URL of TempURL where resource will signal completion and optionally upload data. Updates cause replacement. Required property. timeout 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.
Attributes data JSON data that was uploaded via the SwiftSignalHandle.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::SwiftSignal properties: count: Number handle: String timeout: Number
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::SwiftSignal Properties: count: Number handle: String timeout: Number
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::SwiftSignal", "Properties": { "count": Number, "handle": String, "timeout": Number } } } }
OS::Heat::SwiftSignalHandle Available since 2014.2 (Juno).
Attributes curl_cli Convenience attribute, provides curl CLI command prefix, which can be used for signalling handle completion or failure. You can signal success by adding --data-binary '{"status": "SUCCESS"}' , or signal failure by adding --data-binary '{"status": "FAILURE"}' endpoint Endpoint/url which can be used for signalling handle token Tokens are not needed for Swift TempURLs. This attribute is being kept for compatibility with the OS::Heat::WaitConditionHandle resource
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::SwiftSignalHandle
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::SwiftSignalHandle
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::SwiftSignalHandle" } } }
OS::Heat::UpdateWaitConditionHandle 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. Available since 2014.1 (Icehouse).
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::UpdateWaitConditionHandle
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::UpdateWaitConditionHandle
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::UpdateWaitConditionHandle" } } }
OS::Heat::WaitCondition
Properties count 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. handle A reference to the wait condition handle used to signal this wait condition. Updates cause replacement. Required property. timeout 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.
Attributes data JSON serialized dict containing data associated with wait condition signals sent to the handle.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::WaitCondition properties: count: Number handle: String timeout: Number
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::WaitCondition Properties: count: Number handle: String timeout: Number
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::WaitCondition", "Properties": { "count": Number, "handle": String, "timeout": Number } } } }
OS::Heat::WaitConditionHandle
Attributes curl_cli Convenience attribute, provides curl CLI command prefix, which can be used for signalling handle completion or failure. You can signal success by adding --data-binary '{"status": "SUCCESS"}' , or signal failure by adding --data-binary '{"status": "FAILURE"}' endpoint Endpoint/url which can be used for signalling handle token Token for stack-user which can be used for signalling handle
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Heat::WaitConditionHandle
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Heat::WaitConditionHandle
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Heat::WaitConditionHandle" } } }
OS::Neutron::Firewall A resource for the Firewall resource in Neutron FWaaS.
Properties admin_state_up 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 Description for the firewall. Can be updated without replacement. Optional property. firewall_policy_id The ID of the firewall policy that this firewall is associated with. Can be updated without replacement. Required property. name Name for the firewall. Can be updated without replacement. Optional property.
Attributes admin_state_up The administrative state of the firewall. description Description of the firewall. firewall_policy_id Unique identifier of the firewall policy used to create the firewall. name Name for the firewall. show All attributes. status The status of the firewall. tenant_id Id of the tenant owning the firewall.
HOT Syntax 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
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::Firewall Properties: admin_state_up: Boolean description: String firewall_policy_id: String name: String
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::Firewall", "Properties": { "admin_state_up": Boolean, "description": String, "firewall_policy_id": String, "name": String } } } }
OS::Neutron::FirewallPolicy A resource for the FirewallPolicy resource in Neutron FWaaS.
Properties audited 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 Description for the firewall policy. Can be updated without replacement. Optional property. firewall_rules An ordered list of firewall rules to apply to the firewall. Can be updated without replacement. Required property. name Name for the firewall policy. Can be updated without replacement. Optional property. shared Whether this policy should be shared across all tenants. Can be updated without replacement. Optional property, defaults to "False".
Attributes audited Audit status of this firewall policy. description Description of the firewall policy. firewall_rules List of firewall rules in this firewall policy. name Name for the firewall policy. shared Shared status of this firewall policy. tenant_id Id of the tenant owning the firewall policy.
HOT Syntax 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
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::FirewallPolicy Properties: audited: Boolean description: String firewall_rules: [Value, Value, ...] name: String shared: Boolean
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::FirewallPolicy", "Properties": { "audited": Boolean, "description": String, "firewall_rules": [Value, Value, ...], "name": String, "shared": Boolean } } } }
OS::Neutron::FirewallRule A resource for the FirewallRule resource in Neutron FWaaS.
Properties action 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 Description for the firewall rule. Can be updated without replacement. Optional property. destination_ip_address Destination IP address or CIDR. Can be updated without replacement. Optional property. destination_port Destination port number or a range. Can be updated without replacement. Optional property. enabled Whether this rule should be enabled. Can be updated without replacement. Optional property, defaults to "True". ip_version Internet protocol version. Can be updated without replacement. Optional property, defaults to "4". Allowed values: 4, 6 name Name for the firewall rule. Can be updated without replacement. Optional property. protocol Protocol for the firewall rule. Can be updated without replacement. Optional property. Allowed values: tcp, udp, icmp, None shared Whether this rule should be shared across all tenants. Can be updated without replacement. Optional property, defaults to "False". source_ip_address Source IP address or CIDR. Can be updated without replacement. Optional property. source_port Source port number or a range. Can be updated without replacement. Optional property.
Attributes action Allow or deny action for this firewall rule. description Description of the firewall rule. destination_ip_address Destination ip_address for this firewall rule. destination_port Destination port range for this firewall rule. enabled Indicates whether this firewall rule is enabled or not. firewall_policy_id Unique identifier of the firewall policy to which this firewall rule belongs. ip_version Ip_version for this firewall rule. name Name for the firewall rule. position Position of the rule within the firewall policy. protocol Protocol value for this firewall rule. shared Shared status of this firewall rule. source_ip_address Source ip_address for this firewall rule. source_port Source port range for this firewall rule. tenant_id Id of the tenant owning the firewall.
HOT Syntax 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
YAML Syntax 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
JSON Syntax { "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 } } } }
OS::Neutron::FloatingIP
Properties fixed_ip_address IP address to use if the port has multiple addresses. Can be updated without replacement. Optional property. floating_network Network to allocate floating IP from. Updates cause replacement. Optional property. port_id 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_specs 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 "{}". floating_network_id DEPRECATED - Use property floating_network. Updates cause replacement. Optional property.
Attributes fixed_ip_address IP address of the associated port, if specified. floating_ip_address The allocated address of this IP. floating_network_id ID of the network in which this IP is allocated. port_id ID of the port associated with this IP. router_id ID of the router used as gateway, set when associated with a port. show All attributes. tenant_id The tenant owning this floating IP.
HOT Syntax 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: {...}
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::FloatingIP Properties: fixed_ip_address: String floating_network: String port_id: String value_specs: {...}
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::FloatingIP", "Properties": { "fixed_ip_address": String, "floating_network": String, "port_id": String, "value_specs": {...} } } } }
OS::Neutron::FloatingIPAssociation
Properties fixed_ip_address IP address to use if the port has multiple addresses. Can be updated without replacement. Optional property. floatingip_id ID of the floating IP to associate. Can be updated without replacement. Required property. port_id ID of an existing port with at least one IP address to associate with this floating IP. Can be updated without replacement. Required property.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Neutron::FloatingIPAssociation properties: fixed_ip_address: String floatingip_id: String port_id: String
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::FloatingIPAssociation Properties: fixed_ip_address: String floatingip_id: String port_id: String
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::FloatingIPAssociation", "Properties": { "fixed_ip_address": String, "floatingip_id": String, "port_id": String } } } }
OS::Neutron::HealthMonitor A resource for managing health monitors for load balancers in Neutron.
Properties admin_state_up The administrative state of the health monitor. Can be updated without replacement. Optional property, defaults to "True". delay The minimum time in seconds between regular connections of the member. Can be updated without replacement. Required property. expected_codes The list of HTTP status codes expected in response from the member to declare it healthy. Can be updated without replacement. Optional property. http_method The HTTP method used for requests by the monitor of type HTTP. Can be updated without replacement. Optional property. max_retries Number of permissible connection failures before changing the member status to INACTIVE. Can be updated without replacement. Required property. timeout 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. type One of predefined health monitor types. Updates cause replacement. Required property. Allowed values: PING, TCP, HTTP, HTTPS url_path The HTTP path used in the HTTP request used by the monitor to test a member health. Can be updated without replacement. Optional property.
Attributes admin_state_up The administrative state of this health monitor. delay The minimum time in seconds between regular connections of the member. expected_codes The list of HTTP status codes expected in response from the member to declare it healthy. http_method The HTTP method used for requests by the monitor of type HTTP. max_retries Number of permissible connection failures before changing the member status to INACTIVE. show All attributes. tenant_id Tenant owning the health monitor. timeout Maximum number of seconds for a monitor to wait for a connection to be established before it times out. type One of predefined health monitor types. url_path The HTTP path used in the HTTP request used by the monitor to test a member health.
HOT Syntax 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
YAML Syntax 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
JSON Syntax { "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 } } } }
OS::Neutron::IKEPolicy A resource for IKE policy in Neutron.
Properties auth_algorithm Authentication hash algorithm for the ike policy. Updates cause replacement. Optional property, defaults to "sha1". Allowed values: sha1 description Description for the ike policy. Can be updated without replacement. Optional property. encryption_algorithm Encryption algorithm for the ike policy. Updates cause replacement. Optional property, defaults to "aes-128". Allowed values: 3des, aes-128, aes-192, aes-256 ike_version Version for the ike policy. Updates cause replacement. Optional property, defaults to "v1". Allowed values: v1, v2 lifetime Safety assessment lifetime configuration for the ike policy. Updates cause replacement. Optional property. Map properties: units Safety assessment lifetime units. Updates cause replacement. Optional property, defaults to "seconds". Allowed values: seconds, kilobytes value Safety assessment lifetime value in specified units. Updates cause replacement. Optional property, defaults to "3600". name Name for the ike policy. Can be updated without replacement. Optional property. pfs Perfect forward secrecy in lowercase for the ike policy. Updates cause replacement. Optional property, defaults to "group5". Allowed values: group2, group5, group14 phase1_negotiation_mode Negotiation mode for the ike policy. Updates cause replacement. Optional property, defaults to "main". Allowed values: main
Attributes auth_algorithm The authentication hash algorithm used by the ike policy. description The description of the ike policy. encryption_algorithm The encryption algorithm used by the ike policy. ike_version The version of the ike policy. lifetime The safety assessment lifetime configuration for the ike policy. name The name of the ike policy. pfs The perfect forward secrecy of the ike policy. phase1_negotiation_mode The negotiation mode of the ike policy. tenant_id The unique identifier of the tenant owning the ike policy.
HOT Syntax 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
YAML Syntax 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
JSON Syntax { "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 } } } }
OS::Neutron::IPsecPolicy A resource for IPsec policy in Neutron.
Properties auth_algorithm Authentication hash algorithm for the ipsec policy. Updates cause replacement. Optional property, defaults to "sha1". Allowed values: sha1 description Description for the ipsec policy. Can be updated without replacement. Optional property. encapsulation_mode Encapsulation mode for the ipsec policy. Updates cause replacement. Optional property, defaults to "tunnel". Allowed values: tunnel, transport encryption_algorithm Encryption algorithm for the ipsec policy. Updates cause replacement. Optional property, defaults to "aes-128". Allowed values: 3des, aes-128, aes-192, aes-256 lifetime Safety assessment lifetime configuration for the ipsec policy. Updates cause replacement. Optional property. Map properties: units Safety assessment lifetime units. Updates cause replacement. Optional property, defaults to "seconds". Allowed values: seconds, kilobytes value Safety assessment lifetime value in specified units. Updates cause replacement. Optional property, defaults to "3600". name Name for the ipsec policy. Can be updated without replacement. Optional property. pfs Perfect forward secrecy for the ipsec policy. Updates cause replacement. Optional property, defaults to "group5". Allowed values: group2, group5, group14 transform_protocol Transform protocol for the ipsec policy. Updates cause replacement. Optional property, defaults to "esp". Allowed values: esp, ah, ah-esp
Attributes auth_algorithm The authentication hash algorithm of the ipsec policy. description The description of the ipsec policy. encapsulation_mode The encapsulation mode of the ipsec policy. encryption_algorithm The encryption algorithm of the ipsec policy. lifetime The safety assessment lifetime configuration of the ipsec policy. name The name of the ipsec policy. pfs The perfect forward secrecy of the ipsec policy. tenant_id The unique identifier of the tenant owning the ipsec policy. transform_protocol The transform protocol of the ipsec policy.
HOT Syntax 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
YAML Syntax 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
JSON Syntax { "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 } } } }
OS::Neutron::IPsecSiteConnection A resource for IPsec site connection in Neutron.
Properties admin_state_up Administrative state for the ipsec site connection. Can be updated without replacement. Optional property, defaults to "True". description Description for the ipsec site connection. Can be updated without replacement. Optional property. dpd Dead Peer Detection protocol configuration for the ipsec site connection. Updates cause replacement. Optional property. Map properties: actions Controls DPD protocol mode. Updates cause replacement. Optional property, defaults to "hold". Allowed values: clear, disabled, hold, restart, restart-by-peer interval Number of seconds for the DPD delay. Updates cause replacement. Optional property, defaults to "30". timeout Number of seconds for the DPD timeout. Updates cause replacement. Optional property, defaults to "120". ikepolicy_id Unique identifier for the ike policy associated with the ipsec site connection. Updates cause replacement. Required property. initiator Initiator state in lowercase for the ipsec site connection. Updates cause replacement. Optional property, defaults to "bi-directional". Allowed values: bi-directional, response-only ipsecpolicy_id Unique identifier for the ipsec policy associated with the ipsec site connection. Updates cause replacement. Required property. mtu Maximum transmission unit size (in bytes) for the ipsec site connection. Updates cause replacement. Optional property, defaults to "1500". name Name for the ipsec site connection. Can be updated without replacement. Optional property. peer_address Remote branch router public IPv4 address or IPv6 address or FQDN. Updates cause replacement. Required property. peer_cidrs Remote subnet(s) in CIDR format. Updates cause replacement. Required property. peer_id Remote branch router identity. Updates cause replacement. Required property. psk Pre-shared key string for the ipsec site connection. Updates cause replacement. Required property. vpnservice_id Unique identifier for the vpn service associated with the ipsec site connection. Updates cause replacement. Required property.
Attributes admin_state_up The administrative state of the ipsec site connection. auth_mode The authentication mode of the ipsec site connection. description The description of the ipsec site connection. dpd The dead peer detection protocol configuration of the ipsec site connection. ikepolicy_id The unique identifier of ike policy associated with the ipsec site connection. initiator The initiator of the ipsec site connection. ipsecpolicy_id The unique identifier of ipsec policy associated with the ipsec site connection. mtu The maximum transmission unit size (in bytes) of the ipsec site connection. name The name of the ipsec site connection. peer_address The remote branch router public IPv4 address or IPv6 address or FQDN. peer_cidrs The remote subnet(s) in CIDR format of the ipsec site connection. peer_id The remote branch router identity of the ipsec site connection. psk The pre-shared key string of the ipsec site connection. route_mode The route mode of the ipsec site connection. status The status of the ipsec site connection. tenant_id The unique identifier of the tenant owning the ipsec site connection. vpnservice_id The unique identifier of vpn service associated with the ipsec site connection.
HOT Syntax 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
YAML Syntax 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
JSON Syntax { "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 } } } }
OS::Neutron::LoadBalancer A resource to link a neutron pool with servers.
Properties members The list of Nova server IDs load balanced. Can be updated without replacement. Optional property. pool_id The ID of the load balancing pool. Can be updated without replacement. Required property. protocol_port Port number on which the servers are running on the members. Updates cause replacement. Required property.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Neutron::LoadBalancer properties: members: [Value, Value, ...] pool_id: String protocol_port: Integer
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::LoadBalancer Properties: members: [Value, Value, ...] pool_id: String protocol_port: Integer
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::LoadBalancer", "Properties": { "members": [Value, Value, ...], "pool_id": String, "protocol_port": Integer } } } }
OS::Neutron::MeteringLabel A resource for creating neutron metering label. Available since 2014.1 (Icehouse).
Properties description Description of the metering label. Updates cause replacement. Optional property. name Name of the metering label. Updates cause replacement. Optional property.
Attributes description Description of the metering label. name Name of the metering label.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Neutron::MeteringLabel properties: description: String name: String
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::MeteringLabel Properties: description: String name: String
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::MeteringLabel", "Properties": { "description": String, "name": String } } } }
OS::Neutron::MeteringRule A resource to create rule for some label. Available since 2014.1 (Icehouse).
Properties direction The direction in which metering rule is applied, either ingress or egress. Updates cause replacement. Optional property, defaults to "ingress". Allowed values: ingress, egress excluded 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". metering_label_id The metering label ID to associate with this metering rule. Updates cause replacement. Required property. remote_ip_prefix Indicates remote IP prefix to be associated with this metering rule. Updates cause replacement. Required property.
Attributes direction The direction in which metering rule is applied. excluded Exclude state for cidr. metering_label_id The metering label ID to associate with this metering rule. remote_ip_prefix CIDR to be associated with this metering rule.
HOT Syntax 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
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::MeteringRule Properties: direction: String excluded: Boolean metering_label_id: String remote_ip_prefix: String
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::MeteringRule", "Properties": { "direction": String, "excluded": Boolean, "metering_label_id": String, "remote_ip_prefix": String } } } }
OS::Neutron::Net
Properties admin_state_up A boolean value specifying the administrative status of the network. Can be updated without replacement. Optional property, defaults to "True". dhcp_agent_ids 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. name A string specifying a symbolic name for the network, which is not required to be unique. Can be updated without replacement. Optional property. shared 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". tenant_id 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. value_specs 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 "{}".
Attributes admin_state_up The administrative status of the network. name The name of the network. show All attributes. status The status of the network. subnets Subnets of this network. tenant_id The tenant owning this network.
HOT Syntax 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: {...}
YAML Syntax 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: {...}
JSON Syntax { "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": {...} } } } }
OS::Neutron::NetworkGateway A resource for the Network Gateway resource in Neutron Network Gateway. Available since 2014.1 (Icehouse).
Properties connections Connection info for this network gateway. Can be updated without replacement. Optional property, defaults to "{}". List contents: * Updates cause replacement. Optional property. Map properties: network The internal network to connect on the network gateway. Updates cause replacement. Optional property. segmentation_id 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. segmentation_type L2 segmentation strategy on the external side of the network gateway. Updates cause replacement. Optional property, defaults to "flat". Allowed values: flat, vlan network_id DEPRECATED - Use property network. Updates cause replacement. Optional property. devices 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: id The device id for the network gateway. Updates cause replacement. Required property. interface_name The interface name for the network gateway. Updates cause replacement. Required property. name The name of the network gateway. Can be updated without replacement. Optional property.
Attributes default A boolean value of default flag. show All attributes.
HOT Syntax 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
YAML Syntax 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
JSON Syntax { "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 } } } }
OS::Neutron::Pool A resource for managing load balancer pools in Neutron.
Properties admin_state_up The administrative state of this pool. Can be updated without replacement. Optional property, defaults to "True". description Description of the pool. Can be updated without replacement. Optional property. lb_method 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 monitors List of health monitors associated with the pool. Can be updated without replacement. Optional property, defaults to "[]". name Name of the pool. Updates cause replacement. Optional property. protocol Protocol for balancing. Updates cause replacement. Required property. Allowed values: TCP, HTTP, HTTPS subnet The subnet for the port on which the members of the pool will be connected. Updates cause replacement. Optional property. vip IP address and port of the pool. Updates cause replacement. Required property. Map properties: address IP address of the vip. Updates cause replacement. Optional property. admin_state_up The administrative state of this vip. Updates cause replacement. Optional property, defaults to "True". connection_limit The maximum number of connections per second allowed for the vip. Updates cause replacement. Optional property. description Description of the vip. Updates cause replacement. Optional property. name Name of the vip. Updates cause replacement. Optional property. protocol_port TCP port on which to listen for client traffic that is associated with the vip address. Updates cause replacement. Required property. session_persistence Configuration of session persistence. Updates cause replacement. Optional property. Map properties: cookie_name Name of the cookie, required if type is APP_COOKIE. Updates cause replacement. Optional property. type Method of implementation of session persistence feature. Updates cause replacement. Required property. Allowed values: SOURCE_IP, HTTP_COOKIE, APP_COOKIE subnet Subnet of the vip. Updates cause replacement. Optional property. subnet_id DEPRECATED - Use property subnet. Updates cause replacement. Optional property.
Attributes admin_state_up The administrative state of this pool. description Description of the pool. lb_method The algorithm used to distribute load between the members of the pool. name Name of the pool. protocol Protocol to balance. subnet_id The subnet for the port on which the members of the pool will be connected. tenant_id Tenant owning the pool. vip Vip associated with the pool.
HOT Syntax 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}
YAML Syntax 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}
JSON Syntax { "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} } } } }
OS::Neutron::PoolMember A resource to handle load balancer members. Available since 2014.1 (Icehouse).
Properties address IP address of the pool member on the pool network. Updates cause replacement. Required property. admin_state_up The administrative state of the pool member. Updates cause replacement. Optional property, defaults to "True". pool_id The ID of the load balancing pool. Can be updated without replacement. Required property. protocol_port 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 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.
Attributes address IP address of the pool member. admin_state_up The administrative state of this pool member. pool_id The ID of the load balancing pool. protocol_port TCP port on which the pool member listens for requests or connections. show All attributes. tenant_id Tenant owning the pool member. weight Weight of the pool member in the pool.
HOT Syntax 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
YAML Syntax 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
JSON Syntax { "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 } } } }
OS::Neutron::Port
Properties admin_state_up The administrative state of this port. Can be updated without replacement. Optional property, defaults to "True". allowed_address_pairs 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 IP address to allow through this port. Updates cause replacement. Required property. mac_address MAC address to allow through this port. Updates cause replacement. Optional property. device_id Device ID of this port. Can be updated without replacement. Optional property. device_owner 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. fixed_ips 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 IP address desired in the subnet for this port. Updates cause replacement. Optional property. subnet Subnet in which to allocate the IP address for this port. Updates cause replacement. Optional property. subnet_id DEPRECATED - Use property subnet. Updates cause replacement. Optional property. mac_address MAC address to give to this port. Updates cause replacement. Optional property. name A symbolic name for this port. Can be updated without replacement. Optional property. network Network this port belongs to. Updates cause replacement. Optional property. replacement_policy 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 "REPLACE_ALWAYS". Allowed values: REPLACE_ALWAYS, AUTO security_groups Security group IDs to associate with this port. Can be updated without replacement. Optional property, defaults to "[]". value_specs Extra parameters to include in the "port" object in the creation request. Updates cause replacement. Optional property, defaults to "{}". network_id DEPRECATED - Use property network. Updates cause replacement. Optional property.
Attributes admin_state_up The administrative state of this port. allowed_address_pairs Additional MAC/IP address pairs allowed to pass through a port. device_id Unique identifier for the device. device_owner Name of the network owning the port. fixed_ips Fixed IP addresses. mac_address MAC address of the port. name Friendly name of the port. network_id Unique identifier for the network owning the port. security_groups A list of security groups for the port. show All attributes. status The status of the port. subnets A list of all subnet attributes for the port. tenant_id Tenant owning the port.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Neutron::Port properties: admin_state_up: Boolean allowed_address_pairs: [{"ip_address": String, "mac_address": String}, {"ip_address": String, "mac_address": String}, ...] device_id: String device_owner: String fixed_ips: [{"subnet_id": String, "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: {...}
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::Port Properties: admin_state_up: Boolean allowed_address_pairs: [{"ip_address": String, "mac_address": String}, {"ip_address": String, "mac_address": String}, ...] device_id: String device_owner: String fixed_ips: [{"subnet_id": String, "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: {...}
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::Port", "Properties": { "admin_state_up": Boolean, "allowed_address_pairs": [{"ip_address": String, "mac_address": String}, {"ip_address": String, "mac_address": String}, ...], "device_id": String, "device_owner": String, "fixed_ips": [{"subnet_id": String, "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": {...} } } } }
OS::Neutron::ProviderNet Available since 2014.1 (Icehouse).
Properties admin_state_up A boolean value specifying the administrative status of the network. Can be updated without replacement. Optional property, defaults to "True". name A string specifying a symbolic name for the network, which is not required to be unique. Can be updated without replacement. Optional property. network_type A string specifying the provider network type for the network. Can be updated without replacement. Required property. Allowed values: vlan, flat physical_network A string specifying physical network mapping for the network. Can be updated without replacement. Required property. segmentation_id A string specifying the segmentation id for the network. Can be updated without replacement. Optional property. shared Whether this network should be shared across all tenants. Can be updated without replacement. Optional property, defaults to "True".
Attributes show All attributes. status The status of the network. subnets Subnets of this network.
HOT Syntax 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
YAML Syntax 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
JSON Syntax { "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 } } } }
OS::Neutron::Router
Properties admin_state_up The administrative state of the router. Can be updated without replacement. Optional property, defaults to "True". external_gateway_info External network gateway configuration for a router. Can be updated without replacement. Optional property. Map properties: enable_snat 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. network ID or name of the external network for the gateway. Can be updated without replacement. Required property. l3_agent_id 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. name The name of the router. Can be updated without replacement. Optional property. value_specs Extra parameters to include in the creation request. Can be updated without replacement. Optional property, defaults to "{}".
Attributes admin_state_up Administrative state of the router. external_gateway_info Gateway network for the router. name Friendly name of the router. show All attributes. status The status of the router. tenant_id Tenant owning the router.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Neutron::Router properties: admin_state_up: Boolean external_gateway_info: {"enable_snat": Boolean, "network": String} l3_agent_id: String name: String value_specs: {...}
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::Router Properties: admin_state_up: Boolean external_gateway_info: {"enable_snat": Boolean, "network": String} l3_agent_id: String name: String value_specs: {...}
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::Router", "Properties": { "admin_state_up": Boolean, "external_gateway_info": {"enable_snat": Boolean, "network": String}, "l3_agent_id": String, "name": String, "value_specs": {...} } } } }
OS::Neutron::RouterGateway 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.
Properties network external network for the gateway. Updates cause replacement. Optional property. router_id ID of the router. Updates cause replacement. Required property. network_id DEPRECATED - Use property network. Updates cause replacement. Optional property.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Neutron::RouterGateway properties: network: String router_id: String
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::RouterGateway Properties: network: String router_id: String
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::RouterGateway", "Properties": { "network": String, "router_id": String } } } }
OS::Neutron::RouterInterface
Properties port_id The port id, either subnet or port_id should be specified. Updates cause replacement. Optional property. router_id The router id. Updates cause replacement. Required property. subnet The subnet, either subnet or port_id should be specified. Updates cause replacement. Optional property. subnet_id DEPRECATED - Use property subnet. Updates cause replacement. Optional property.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Neutron::RouterInterface properties: port_id: String router_id: String subnet: String
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::RouterInterface Properties: port_id: String router_id: String subnet: String
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::RouterInterface", "Properties": { "port_id": String, "router_id": String, "subnet": String } } } }
OS::Neutron::SecurityGroup Available since 2014.1 (Icehouse).
Properties description Description of the security group. Can be updated without replacement. Optional property. name A string specifying a symbolic name for the security group, which is not required to be unique. Can be updated without replacement. Optional property. rules List of security group rules. Can be updated without replacement. Optional property, defaults to "[]". List contents: * Updates cause replacement. Optional property. Map properties: direction 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 Ethertype of the traffic. Updates cause replacement. Optional property, defaults to "IPv4". Allowed values: IPv4, IPv6 port_range_max 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. port_range_min 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. protocol The protocol that is matched by the security group rule. Valid values include tcp, udp, and icmp. Updates cause replacement. Optional property. remote_group_id The remote group ID to be associated with this security group rule. If no value is specified then this rule will use this security group for the remote_group_id. Updates cause replacement. Optional property. remote_ip_prefix The remote IP prefix (CIDR) to be associated with this security group rule. Updates cause replacement. Optional property. remote_mode 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
HOT Syntax 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}, ...]
YAML Syntax 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}, ...]
JSON Syntax { "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}, ...] } } } }
OS::Neutron::Subnet
Properties allocation_pools The start and end addresses for the allocation pools. Updates cause replacement. Optional property. List contents: * Updates cause replacement. Optional property. Map properties: end Updates cause replacement. Required property. start Updates cause replacement. Required property. cidr The CIDR. Updates cause replacement. Required property. dns_nameservers A specified set of DNS name servers to be used. Can be updated without replacement. Optional property, defaults to "[]". enable_dhcp Set to true if DHCP is enabled and false if DHCP is disabled. Can be updated without replacement. Optional property, defaults to "True". gateway_ip The gateway IP address. Can be updated without replacement. Optional property. host_routes Updates cause replacement. Optional property. List contents: * Updates cause replacement. Optional property. Map properties: destination Updates cause replacement. Required property. nexthop Updates cause replacement. Required property. ip_version The IP version, which is 4 or 6. Updates cause replacement. Optional property, defaults to "4". Allowed values: 4, 6 name The name of the subnet. Can be updated without replacement. Optional property. network The ID of the attached network. Updates cause replacement. Optional property. tenant_id 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. value_specs Extra parameters to include in the creation request. Can be updated without replacement. Optional property, defaults to "{}". network_id DEPRECATED - Use property network. Updates cause replacement. Optional property.
Attributes allocation_pools Ip allocation pools and their ranges. cidr CIDR block notation for this subnet. dns_nameservers List of dns nameservers. enable_dhcp 'true' if DHCP is enabled for this subnet; 'false' otherwise. gateway_ip Ip of the subnet's gateway. host_routes Additional routes for this subnet. ip_version Ip version for the subnet. name Friendly name of the subnet. network_id Parent network of the subnet. show All attributes. tenant_id Tenant owning the subnet.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Neutron::Subnet properties: allocation_pools: [{"start": String, "end": String}, {"start": String, "end": String}, ...] cidr: String dns_nameservers: [Value, Value, ...] enable_dhcp: Boolean gateway_ip: String host_routes: [{"nexthop": String, "destination": String}, {"nexthop": String, "destination": String}, ...] ip_version: Integer name: String network: String tenant_id: String value_specs: {...}
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::Subnet Properties: allocation_pools: [{"start": String, "end": String}, {"start": String, "end": String}, ...] cidr: String dns_nameservers: [Value, Value, ...] enable_dhcp: Boolean gateway_ip: String host_routes: [{"nexthop": String, "destination": String}, {"nexthop": String, "destination": String}, ...] ip_version: Integer name: String network: String tenant_id: String value_specs: {...}
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::Subnet", "Properties": { "allocation_pools": [{"start": String, "end": String}, {"start": String, "end": String}, ...], "cidr": String, "dns_nameservers": [Value, Value, ...], "enable_dhcp": Boolean, "gateway_ip": String, "host_routes": [{"nexthop": String, "destination": String}, {"nexthop": String, "destination": String}, ...], "ip_version": Integer, "name": String, "network": String, "tenant_id": String, "value_specs": {...} } } } }
OS::Neutron::VPNService A resource for VPN service in Neutron.
Properties admin_state_up Administrative state for the vpn service. Can be updated without replacement. Optional property, defaults to "True". description Description for the vpn service. Can be updated without replacement. Optional property. name Name for the vpn service. Can be updated without replacement. Optional property. router_id Unique identifier for the router to which the vpn service will be inserted. Updates cause replacement. Required property. subnet Subnet in which the vpn service will be created. Updates cause replacement. Optional property. subnet_id DEPRECATED - Use property subnet. Updates cause replacement. Optional property.
Attributes admin_state_up The administrative state of the vpn service. description The description of the vpn service. name The name of the vpn service. router_id The unique identifier of the router to which the vpn service was inserted. show All attributes. status The status of the vpn service. subnet_id The unique identifier of the subnet in which the vpn service was created. tenant_id The unique identifier of the tenant owning the vpn service.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Neutron::VPNService properties: admin_state_up: Boolean description: String name: String router_id: String subnet: String
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Neutron::VPNService Properties: admin_state_up: Boolean description: String name: String router_id: String subnet: String
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Neutron::VPNService", "Properties": { "admin_state_up": Boolean, "description": String, "name": String, "router_id": String, "subnet": String } } } }
OS::Nova::FloatingIP Available since 2014.1 (Icehouse).
Properties pool Allocate a floating IP from a given floating IP pool. Updates cause replacement. Optional property.
Attributes ip Allocated floating IP address. pool Pool from which floating IP is allocated.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Nova::FloatingIP properties: pool: String
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Nova::FloatingIP Properties: pool: String
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Nova::FloatingIP", "Properties": { "pool": String } } } }
OS::Nova::FloatingIPAssociation Available since 2014.1 (Icehouse).
Properties floating_ip ID of the floating IP to assign to the server. Can be updated without replacement. Required property. server_id Server to assign floating IP to. Can be updated without replacement. Required property.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Nova::FloatingIPAssociation properties: floating_ip: String server_id: String
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Nova::FloatingIPAssociation Properties: floating_ip: String server_id: String
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Nova::FloatingIPAssociation", "Properties": { "floating_ip": String, "server_id": String } } } }
OS::Nova::KeyPair A resource for creating Nova key pairs. 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. Available since 2014.1 (Icehouse).
Properties name The name of the key pair. Updates cause replacement. Required property. The length must be in the range 1 to 255. public_key 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. save_private_key True if the system should remember a generated private key; False otherwise. Updates cause replacement. Optional property, defaults to "False".
Attributes private_key The private key if it has been saved. public_key The public key.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Nova::KeyPair properties: name: String public_key: String save_private_key: Boolean
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Nova::KeyPair Properties: name: String public_key: String save_private_key: Boolean
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Nova::KeyPair", "Properties": { "name": String, "public_key": String, "save_private_key": Boolean } } } }
OS::Nova::Server
Properties admin_pass The administrator password for the server. Can be updated without replacement. Optional property. availability_zone Name of the availability zone for server placement. Updates cause replacement. Optional property. block_device_mapping Block device mappings for this server. Updates cause replacement. Optional property. List contents: * Updates cause replacement. Optional property. Map properties: delete_on_termination Indicate whether the volume should be deleted when the server is terminated. Updates cause replacement. Optional property. device_name 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. snapshot_id The ID of the snapshot to create a volume from. Updates cause replacement. Optional property. volume_id The ID of the volume to boot from. Only one of volume_id or snapshot_id should be provided. Updates cause replacement. Optional property. volume_size 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. config_drive If True, enable config drive on the server. Updates cause replacement. Optional property. diskConfig Control how the disk is partitioned when the server is created. Updates cause replacement. Optional property. Allowed values: AUTO, MANUAL flavor The ID or name of the flavor to boot onto. Can be updated without replacement. Required property. flavor_update_policy 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 image The ID or name of the image to boot with. Can be updated without replacement. Optional property. Value must be of type glance.image image_update_policy Policy on how to apply an image-id update; either by requesting a server rebuild or by replacing the entire server Can be updated without replacement. Optional property, defaults to "REPLACE". Allowed values: REBUILD, REPLACE, REBUILD_PRESERVE_EPHEMERAL key_name Name of keypair to inject into the server. Updates cause replacement. Optional property. Value must be of type nova.keypair metadata 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. name Server name. Can be updated without replacement. Optional property. networks 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 Fixed IP address to specify for the port created on the requested network. Updates cause replacement. Optional property. network Name or ID of network to create a port on. Updates cause replacement. Optional property. port ID of an existing port to associate with this server. Updates cause replacement. Optional property. uuid DEPRECATED - Use property network. ID of network to create a port on. Updates cause replacement. Optional property. personality 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 "{}". reservation_id A UUID for the set of servers being requested. Updates cause replacement. Optional property. scheduler_hints Arbitrary key-value pairs specified by the client to help boot a server. Updates cause replacement. Optional property. security_groups 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 "[]". software_config_transport 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 User data script to be executed by cloud-init. Updates cause replacement. Optional property, defaults to "". user_data_format 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 admin_user 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.
Attributes accessIPv4 The manually assigned alternative public IPv4 address of the server. accessIPv6 The manually assigned alternative public IPv6 address of the server. addresses A dict of all network addresses with corresponding port_id. first_address 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. instance_name AWS compatible instance name. name Name of the server. networks A dict of assigned network addresses of the form: {"public": [ip1, ip2...], "private": [ip3, ip4]}. show A dict of all server details as returned by the API.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Nova::Server properties: admin_pass: String availability_zone: String block_device_mapping: [{"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, {"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, ...] config_drive: 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
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Nova::Server Properties: admin_pass: String availability_zone: String block_device_mapping: [{"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, {"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, ...] config_drive: 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
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Nova::Server", "Properties": { "admin_pass": String, "availability_zone": String, "block_device_mapping": [{"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, {"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, ...], "config_drive": 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 } } } }
OS::Nova::ServerGroup A resource for managing a Nova server group. Available since 2014.2 (Juno).
Properties name Server Group name. Updates cause replacement. Optional property. policies 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.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Nova::ServerGroup properties: name: String policies: [String, String, ...]
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Nova::ServerGroup Properties: name: String policies: [String, String, ...]
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Nova::ServerGroup", "Properties": { "name": String, "policies": [String, String, ...] } } } }
OS::Sahara::Cluster
Properties cluster_template_id ID of the Cluster Template used for Node Groups and configurations. Updates cause replacement. Required property. hadoop_version Version of Hadoop running on instances. Updates cause replacement. Required property. image Name or UUID of the image used to boot Hadoop nodes. Updates cause replacement. Optional property. Value must be of type glance.image key_name Keypair added to instances to make them accessible for user. Updates cause replacement. Optional property. Value must be of type nova.keypair name Hadoop cluster name. Updates cause replacement. Optional property. neutron_management_network Name or UUID of Neutron network. Updates cause replacement. Optional property. Value must be of type neutron.network plugin_name Plugin name. Updates cause replacement. Required property.
Attributes info Cluster information. status Cluster status.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Sahara::Cluster properties: cluster_template_id: String hadoop_version: String image: String key_name: String name: String neutron_management_network: String plugin_name: String
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Sahara::Cluster Properties: cluster_template_id: String hadoop_version: String image: String key_name: String name: String neutron_management_network: String plugin_name: String
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Sahara::Cluster", "Properties": { "cluster_template_id": String, "hadoop_version": String, "image": String, "key_name": String, "name": String, "neutron_management_network": String, "plugin_name": String } } } }
OS::Sahara::ClusterTemplate Available since 2014.2 (Juno).
Properties anti_affinity List of processes to enable anti-affinity for. Updates cause replacement. Optional property. List contents: * Updates cause replacement. Optional property. cluster_configs Cluster configs dictionary. Updates cause replacement. Optional property. default_image_id ID of the default image to use for the template. Updates cause replacement. Optional property. Value must be of type glance.image description Description of the Sahara Group Template. Updates cause replacement. Optional property, defaults to "". hadoop_version Version of Hadoop running on instances. Updates cause replacement. Required property. name 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])$ neutron_management_network Name or UUID of Neutron network. Updates cause replacement. Optional property. Value must be of type neutron.network node_groups Node groups. Updates cause replacement. Optional property. List contents: * Updates cause replacement. Optional property. Map properties: count Number of instances in the Node group. Updates cause replacement. Required property. The value must be at least 1. name Name of the Node group. Updates cause replacement. Required property. node_group_template_id ID of the Node Group Template. Updates cause replacement. Required property. plugin_name Plugin name. Updates cause replacement. Required property.
HOT Syntax 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
YAML Syntax 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
JSON Syntax { "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 } } } }
OS::Sahara::NodeGroupTemplate Available since 2014.2 (Juno).
Properties description Description of the Node Group Template. Updates cause replacement. Optional property, defaults to "". flavor Name or ID Nova flavor for the nodes. Updates cause replacement. Required property. floating_ip_pool Name or UUID of the Neutron floating IP network to use. Updates cause replacement. Optional property. Value must be of type neutron.network hadoop_version Version of Hadoop running on instances. Updates cause replacement. Required property. name 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])$ node_configs Dictionary of node configurations. Updates cause replacement. Optional property. node_processes 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 Plugin name. Updates cause replacement. Required property. volumes_per_node Volumes per node. Updates cause replacement. Optional property. The value must be at least 0. volumes_size Size of the volumes, in GB. Updates cause replacement. Optional property. The value must be at least 1.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Sahara::NodeGroupTemplate properties: description: String flavor: String floating_ip_pool: String hadoop_version: String name: String node_configs: {...} node_processes: [String, String, ...] plugin_name: String volumes_per_node: Integer volumes_size: Integer
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Sahara::NodeGroupTemplate Properties: description: String flavor: String floating_ip_pool: String hadoop_version: String name: String node_configs: {...} node_processes: [String, String, ...] plugin_name: String volumes_per_node: Integer volumes_size: Integer
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Sahara::NodeGroupTemplate", "Properties": { "description": String, "flavor": String, "floating_ip_pool": String, "hadoop_version": String, "name": String, "node_configs": {...}, "node_processes": [String, String, ...], "plugin_name": String, "volumes_per_node": Integer, "volumes_size": Integer } } } }
OS::Swift::Container
Properties X-Account-Meta 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 "{}". X-Container-Meta 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 "{}". X-Container-Read Specify the ACL permissions on who can read objects in the container. Updates cause replacement. Optional property. X-Container-Write Specify the ACL permissions on who can write objects to the container. Updates cause replacement. Optional property. name Name for the container. If not specified, a unique name will be generated. Updates cause replacement. Optional property.
Attributes BytesUsed The number of bytes stored in the container. DomainName The host from the container URL. HeadContainer A map containing all headers for the container. ObjectCount The number of objects stored in the container. RootURL The parent URL of the container. WebsiteURL The URL of the container.
HOT Syntax heat_template_version: 2013-05-23 ... resources: ... the_resource: type: OS::Swift::Container properties: X-Account-Meta: {...} X-Container-Meta: {...} X-Container-Read: String X-Container-Write: String name: String
YAML Syntax HeatTemplateFormatVersion: '2012-12-12' ... Resources: ... TheResource: Type: OS::Swift::Container Properties: X-Account-Meta: {...} X-Container-Meta: {...} X-Container-Read: String X-Container-Write: String name: String
JSON Syntax { "AWSTemplateFormatVersion" : "2010-09-09", ... "Resources" : { "TheResource": { "Type": "OS::Swift::Container", "Properties": { "X-Account-Meta": {...}, "X-Container-Meta": {...}, "X-Container-Read": String, "X-Container-Write": String, "name": String } } } }
OS::Trove::Instance OpenStack cloud database instance resource. Available since 2014.1 (Icehouse).
Properties availability_zone Name of the availability zone for DB instance. Updates cause replacement. Optional property. databases 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: character_set Set of symbols and encodings. Updates cause replacement. Optional property, defaults to "utf8". collate Set of rules for comparing characters in a character set. Updates cause replacement. Optional property, defaults to "utf8_general_ci". name 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_]+ datastore_type Name of registered datastore type. Updates cause replacement. Optional property. The length must be no greater than 255. datastore_version 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. flavor Reference to a flavor for creating DB instance. Updates cause replacement. Required property. name Name of the DB instance to create. Updates cause replacement. Optional property. The length must be no greater than 255. networks 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_ip Fixed IPv4 address for this NIC. Updates cause replacement. Optional property. network Name or UUID of the network to attach this NIC to. Either port or network must be specified. Updates cause replacement. Optional property. port Name or UUID of Neutron port to attach this NIC to. Either port or network must be specified. Updates cause replacement. Optional property. restore_point DB instance restore point. Updates cause replacement. Optional property. size Database volume size in GB. Updates cause replacement. Required property. The value must be in the range 1 to 150. users 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: databases 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. host The host from which a user is allowed to connect to the database. Updates cause replacement. Optional property, defaults to "%". name 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 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_]+
Attributes hostname Hostname of the instance. href Api endpoint reference of the instance.
HOT Syntax 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, ...]}, ...]
YAML Syntax 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, ...]}, ...]
JSON Syntax { "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, ...]}, ...] } } } }