Unsupported Heat Resource Types

These resources are enabled, but are not officially supported.

AWS::AutoScaling::AutoScalingGroup

AWS CloudFormation compatible autoscaling group.

Required Properties

AvailabilityZones
Not Implemented.
List value expected.
Updates cause replacement.
MaxSize
Maximum number of instances in the group.
Integer value expected.
Can be updated without replacement.
MinSize
Minimum number of instances in the group.
Integer value expected.
Can be updated without replacement.

Optional Properties

Cooldown
Cooldown period, in seconds.
Integer value expected.
Can be updated without replacement.
DesiredCapacity
Desired initial number of instances.
Integer value expected.
Can be updated without replacement.
HealthCheckGracePeriod

Note

Not implemented.
HealthCheckType

Note

Not implemented.
InstanceId
The ID of an existing instance to use to create the Auto Scaling group. If specify this property, will create the group use an existing instance instead of a launch configuration.
String value expected.
Updates cause replacement.
Value must be of type nova.server
LaunchConfigurationName
The reference to a LaunchConfiguration resource.
String value expected.
Can be updated without replacement.
LoadBalancerNames
List of LoadBalancer resources.
List value expected.
Updates cause replacement.
Tags
Tags to attach to this group.
List value expected.
Updates cause replacement.
List contents:
Map value expected.
Updates cause replacement.
Map properties:
Key
Required.
String value expected.
Updates cause replacement.
Value
Required.
String value expected.
Updates cause replacement.
VPCZoneIdentifier
Use only with Neutron, to list the internal subnet to which the instance will be attached; needed only if multiple exist; list length must be exactly 1.
List value expected.
Updates cause replacement.
List contents:
Optional.
UUID of the internal subnet to which the instance will be attached.
String value expected.
Updates cause replacement.

Attributes

InstanceList

A comma-delimited list of server ip addresses. (Heat extension).

show

Detailed information about resource.

update_policy

AutoScalingRollingUpdate
Map value expected.
Updates cause replacement.
Map properties:
MaxBatchSize
Optional.
Integer value expected.
Updates cause replacement.
Defaults to 1
MinInstancesInService
Optional.
Integer value expected.
Updates cause replacement.
Defaults to 0
PauseTime
Optional.
String value expected.
Updates cause replacement.
Defaults to "PT0S"

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::AutoScaling::AutoScalingGroup
    properties:
      AvailabilityZones: [Value, Value, ...]
      Cooldown: Integer
      DesiredCapacity: Integer
      InstanceId: String
      LaunchConfigurationName: String
      LoadBalancerNames: [Value, Value, ...]
      MaxSize: Integer
      MinSize: Integer
      Tags: [{"Key": String, "Value": String}, {"Key": String, "Value": String}, ...]
      VPCZoneIdentifier: [String, String, ...]

AWS::AutoScaling::LaunchConfiguration

Optional Properties

BlockDeviceMappings
Block device mappings to attach to instance.
List value expected.
Updates cause replacement.
List contents:
Map value expected.
Updates cause replacement.
Map properties:
DeviceName
Required.
A device name where the volume will be attached in the system at /dev/device_name.e.g. vdb
String value expected.
Updates cause replacement.
Ebs
The ebs volume to attach to the instance.
Map value expected.
Updates cause replacement.
Map properties:
DeleteOnTermination
Optional.
Indicate whether the volume should be deleted when the instance is terminated.
Boolean value expected.
Updates cause replacement.
Defaults to true
Iops
Not implemented.
SnapshotId
Optional.
The ID of the snapshot to create a volume from.
String value expected.
Updates cause replacement.
Value must be of type cinder.snapshot
VolumeSize
Optional.
The size of the volume, in GB. Must be equal or greater than the size of the snapshot. It is safe to leave this blank and have the Compute service infer the size.
String value expected.
Updates cause replacement.
VolumeType
Not implemented.
NoDevice
Not implemented.
VirtualName
Not implemented.
ImageId
Glance image ID or name.
String value expected.
Updates cause replacement.
Value must be of type glance.image
InstanceId
The ID of an existing instance you want to use to create the launch configuration. All properties are derived from the instance with the exception of BlockDeviceMapping.
String value expected.
Updates cause replacement.
Value must be of type nova.server
InstanceType
Nova instance type (flavor).
String value expected.
Updates cause replacement.
Value must be of type nova.flavor
KernelId

Note

Not implemented.
KeyName
Optional Nova keypair name.
String value expected.
Updates cause replacement.
Value must be of type nova.keypair
NovaSchedulerHints
Scheduler hints to pass to Nova (Heat extension).
List value expected.
Updates cause replacement.
List contents:
Map value expected.
Updates cause replacement.
Map properties:
Key
Required.
String value expected.
Updates cause replacement.
Value
Required.
String value expected.
Updates cause replacement.
RamDiskId

Note

Not implemented.
SecurityGroups
Security group names to assign.
List value expected.
Updates cause replacement.
UserData
User data to pass to instance.
String value expected.
Updates cause replacement.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::AutoScaling::LaunchConfiguration
    properties:
      BlockDeviceMappings: [{"DeviceName": String, "Ebs": {"DeleteOnTermination": Boolean, "SnapshotId": String, "VolumeSize": String}}, {"DeviceName": String, "Ebs": {"DeleteOnTermination": Boolean, "SnapshotId": String, "VolumeSize": String}}, ...]
      ImageId: String
      InstanceId: String
      InstanceType: String
      KeyName: String
      NovaSchedulerHints: [{"Key": String, "Value": String}, {"Key": String, "Value": String}, ...]
      SecurityGroups: [Value, Value, ...]
      UserData: String

AWS::AutoScaling::ScalingPolicy

Required Properties

AdjustmentType
Type of adjustment (absolute or percentage).
String value expected.
Can be updated without replacement.
Allowed values: “ChangeInCapacity”, “ExactCapacity”, “PercentChangeInCapacity”
AutoScalingGroupName
AutoScaling group name to apply policy to.
String value expected.
Updates cause replacement.
ScalingAdjustment
Size of adjustment.
Integer value expected.
Can be updated without replacement.

Optional Properties

Cooldown
Cooldown period, in seconds.
Integer value expected.
Can be updated without replacement.
MinAdjustmentStep
Minimum number of resources that are added or removed when the AutoScaling group scales up or down. This can be used only when specifying PercentChangeInCapacity for the AdjustmentType property.
Integer value expected.
Can be updated without replacement.
The value must be at least 0.

Attributes

AlarmUrl

A signed url to handle the alarm. (Heat extension).

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::AutoScaling::ScalingPolicy
    properties:
      AdjustmentType: String
      AutoScalingGroupName: String
      Cooldown: Integer
      MinAdjustmentStep: Integer
      ScalingAdjustment: Integer

AWS::CloudFormation::Stack

Represents a child stack to allow composition of templates.

Required Properties

TemplateURL
The URL of a template that specifies the stack to be created as a resource.
String value expected.
Can be updated without replacement.

Optional Properties

Parameters
The set of parameters passed to this nested stack.
Map value expected.
Can be updated without replacement.
TimeoutInMinutes
The length of time, in minutes, to wait for the nested stack creation.
Integer value expected.
Can be updated without replacement.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::CloudFormation::Stack
    properties:
      Parameters: {...}
      TemplateURL: String
      TimeoutInMinutes: Integer

AWS::CloudFormation::WaitCondition

Required Properties

Handle
A reference to the wait condition handle used to signal this wait condition.
String value expected.
Updates cause replacement.
Timeout
The number of seconds to wait for the correct number of signals to arrive.
Integer value expected.
Updates cause replacement.
The value must be in the range 1 to 43200.

Optional Properties

Count
The number of success signals that must be received before the stack creation process continues.
Integer value expected.
Can be updated without replacement.
Defaults to 1
The value must be at least 1.

Attributes

Data

JSON string containing data associated with wait condition signals sent to the handle.

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::CloudFormation::WaitCondition
    properties:
      Count: Integer
      Handle: String
      Timeout: Integer

AWS::CloudFormation::WaitConditionHandle

AWS WaitConditionHandle resource.

the main point of this class is to : have no dependencies (so the instance can reference it) generate a unique url (to be returned in the reference) then the cfn-signal will use this url to post to and WaitCondition will poll it to see if has been written to.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::CloudFormation::WaitConditionHandle

AWS::ElasticLoadBalancing::LoadBalancer

Implements a HAProxy-bearing instance as a nested stack.

The template for the nested stack can be redefined with loadbalancer_template option in heat.conf.

Generally the image used for the instance must have the following packages installed or available for installation at runtime:

- heat-cfntools and its dependencies like python-psutil
- cronie
- socat
- haproxy

Current default builtin template uses Fedora 21 x86_64 base cloud image (https://getfedora.org/cloud/download/) and apart from installing packages goes through some hoops around SELinux due to pecularities of heat-cfntools.

Required Properties

AvailabilityZones
The Availability Zones in which to create the load balancer.
List value expected.
Updates cause replacement.
Listeners
One or more listeners for this load balancer.
List value expected.
Updates cause replacement.
List contents:
Map value expected.
Updates cause replacement.
Map properties:
InstancePort
Required.
TCP port on which the instance server is listening.
Integer value expected.
Updates cause replacement.
LoadBalancerPort
Required.
The external load balancer port number.
Integer value expected.
Updates cause replacement.
PolicyNames
Not implemented.
Protocol
Required.
The load balancer transport protocol to use.
String value expected.
Updates cause replacement.
Allowed values: “TCP”, “HTTP”
SSLCertificateId
Not implemented.

Optional Properties

AppCookieStickinessPolicy

Note

Not implemented.
HealthCheck
An application health check for the instances.
Map value expected.
Updates cause replacement.
Map properties:
HealthyThreshold
Required.
The number of consecutive health probe successes required before moving the instance to the healthy state.
Integer value expected.
Updates cause replacement.
Interval
Required.
The approximate interval, in seconds, between health checks of an individual instance.
Integer value expected.
Updates cause replacement.
Target
Required.
The port being checked.
String value expected.
Updates cause replacement.
Timeout
Required.
Health probe timeout, in seconds.
Integer value expected.
Updates cause replacement.
UnhealthyThreshold
Required.
The number of consecutive health probe failures required before moving the instance to the unhealthy state
Integer value expected.
Updates cause replacement.
Instances
The list of instance IDs load balanced.
List value expected.
Can be updated without replacement.
LBCookieStickinessPolicy

Note

Not implemented.
SecurityGroups
List of Security Groups assigned on current LB.
List value expected.
Can be updated without replacement.
Subnets

Note

Not implemented.

Attributes

CanonicalHostedZoneName

The name of the hosted zone that is associated with the LoadBalancer.

CanonicalHostedZoneNameID

The ID of the hosted zone name that is associated with the LoadBalancer.

DNSName

The DNS name for the LoadBalancer.

SourceSecurityGroup.GroupName

The security group that you can use as part of your inbound rules for your LoadBalancer’s back-end instances.

SourceSecurityGroup.OwnerAlias

Owner of the source security group.

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::ElasticLoadBalancing::LoadBalancer
    properties:
      AvailabilityZones: [Value, Value, ...]
      HealthCheck: {"HealthyThreshold": Integer, "Interval": Integer, "Target": String, "Timeout": Integer, "UnhealthyThreshold": Integer}
      Instances: [Value, Value, ...]
      Listeners: [{"InstancePort": Integer, "LoadBalancerPort": Integer, "Protocol": String}, {"InstancePort": Integer, "LoadBalancerPort": Integer, "Protocol": String}, ...]
      SecurityGroups: [Value, Value, ...]

AWS::IAM::AccessKey

Required Properties

UserName
The name of the user that the new key will belong to.
String value expected.
Updates cause replacement.

Optional Properties

Serial

Note

Not implemented.
Status

Note

Not implemented.

Attributes

SecretAccessKey

Keypair secret key.

UserName

Username associated with the AccessKey.

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::IAM::AccessKey
    properties:
      UserName: String

AWS::IAM::User

Optional Properties

Groups
Not Implemented.
List value expected.
Updates cause replacement.
LoginProfile
A login profile for the user.
Map value expected.
Updates cause replacement.
Map properties:
Password
Optional.
String value expected.
Updates cause replacement.
Path
Not Implemented.
String value expected.
Updates cause replacement.
Policies
Access policies to apply to the user.
List value expected.
Updates cause replacement.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::IAM::User
    properties:
      Groups: [Value, Value, ...]
      LoginProfile: {"Password": String}
      Path: String
      Policies: [Value, Value, ...]

AWS::S3::Bucket

Optional Properties

AccessControl
A predefined access control list (ACL) that grants permissions on the bucket.
String value expected.
Updates cause replacement.
Allowed values: “Private”, “PublicRead”, “PublicReadWrite”, “AuthenticatedRead”, “BucketOwnerRead”, “BucketOwnerFullControl”
Tags
Tags to attach to the bucket.
List value expected.
Updates cause replacement.
List contents:
Map value expected.
Updates cause replacement.
Map properties:
Key
Required.
The tag key name.
String value expected.
Updates cause replacement.
Value
Required.
The tag value.
String value expected.
Updates cause replacement.
WebsiteConfiguration
Information used to configure the bucket as a static website.
Map value expected.
Updates cause replacement.
Map properties:
ErrorDocument
Optional.
The name of the error document.
String value expected.
Updates cause replacement.
IndexDocument
Optional.
The name of the index document.
String value expected.
Updates cause replacement.

Attributes

DomainName

The DNS name of the specified bucket.

WebsiteURL

The website endpoint for the specified bucket.

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: AWS::S3::Bucket
    properties:
      AccessControl: String
      Tags: [{"Key": String, "Value": String}, {"Key": String, "Value": String}, ...]
      WebsiteConfiguration: {"IndexDocument": String, "ErrorDocument": String}

OS::Aodh::Alarm

A resource that implements alarming service of Aodh.

A resource that allows for the setting alarms based on threshold evaluation for a collection of samples. Also, you can define actions to take if state of watched resource will be satisfied specified conditions. For example, it can watch for the memory consumption and when it reaches 70% on a given instance if the instance has been up for more than 10 min, some action will be called.

Required Properties

meter_name
Meter name watched by the alarm.
String value expected.
Updates cause replacement.
threshold
Threshold to evaluate against.
Number value expected.
Can be updated without replacement.

Optional Properties

alarm_actions
A list of URLs (webhooks) to invoke when state transitions to alarm.
List value expected.
Can be updated without replacement.
alarm_queues
A list of Zaqar queues to post to when state transitions to alarm.
List value expected.
Can be updated without replacement.
Defaults to []
List contents:
Optional.
String value expected.
Can be updated without replacement.
Value must be of type zaqar.queue
comparison_operator
Operator used to compare specified statistic with threshold.
String value expected.
Can be updated without replacement.
Allowed values: “le”, “ge”, “eq”, “lt”, “gt”, “ne”
description
Description for the alarm.
String value expected.
Can be updated without replacement.
enabled
True if alarm evaluation/actioning is enabled.
Boolean value expected.
Can be updated without replacement.
Defaults to "true"
evaluation_periods
Number of periods to evaluate over.
Integer value expected.
Can be updated without replacement.
insufficient_data_actions
A list of URLs (webhooks) to invoke when state transitions to insufficient-data.
List value expected.
Can be updated without replacement.
insufficient_data_queues
A list of Zaqar queues to post to when state transitions to insufficient-data.
List value expected.
Can be updated without replacement.
Defaults to []
List contents:
Optional.
String value expected.
Can be updated without replacement.
Value must be of type zaqar.queue
matching_metadata
Meter should match this resource metadata (key=value) additionally to the meter_name.
Map value expected.
Can be updated without replacement.
Defaults to {}
ok_actions
A list of URLs (webhooks) to invoke when state transitions to ok.
List value expected.
Can be updated without replacement.
ok_queues
A list of Zaqar queues to post to when state transitions to ok.
List value expected.
Can be updated without replacement.
Defaults to []
List contents:
Optional.
String value expected.
Can be updated without replacement.
Value must be of type zaqar.queue
period
Period (seconds) to evaluate over.
Integer value expected.
Can be updated without replacement.
query
A list of query factors, each comparing a Sample attribute with a value. Implicitly combined with matching_metadata, if any.
List value expected.
Can be updated without replacement.
List contents:
Map value expected.
Can be updated without replacement.
Map properties:
field
Optional.
Name of attribute to compare. Names of the form metadata.user_metadata.X or metadata.metering.X are equivalent to what you can address through matching_metadata; the former for Nova meters, the latter for all others. To see the attributes of your Samples, use `ceilometer –debug sample-list`.
String value expected.
Can be updated without replacement.
op
Optional.
Comparison operator.
String value expected.
Can be updated without replacement.
Allowed values: “le”, “ge”, “eq”, “lt”, “gt”, “ne”
type
Optional.
The type of the attribute.
String value expected.
Can be updated without replacement.
Defaults to "string"
Allowed values: “integer”, “float”, “string”, “boolean”, “datetime”
value
Optional.
String value with which to compare.
String value expected.
Can be updated without replacement.
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.
Boolean value expected.
Can be updated without replacement.
Defaults to "true"
severity
Severity of the alarm.
String value expected.
Can be updated without replacement.
Defaults to "low"
Allowed values: “low”, “moderate”, “critical”
statistic
Meter statistic to evaluate.
String value expected.
Can be updated without replacement.
Allowed values: “count”, “avg”, “sum”, “min”, “max”
time_constraints
Describe time constraints for the alarm. Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression, whereas its duration is given in seconds.
List value expected.
Updates cause replacement.
Defaults to []
List contents:
Map value expected.
Updates cause replacement.
Map properties:
description
Optional.
Description for the time constraint.
String value expected.
Updates cause replacement.
duration
Required.
Duration for the time constraint.
Integer value expected.
Updates cause replacement.
The value must be at least 0.
name
Required.
Name for the time constraint.
String value expected.
Updates cause replacement.
start
Required.
Start time for the time constraint. A CRON expression property.
String value expected.
Updates cause replacement.
Value must be of type cron_expression
timezone
Optional.
Timezone for the time constraint (eg. ‘Asia/Taipei’, ‘Europe/Amsterdam’).
String value expected.
Updates cause replacement.
Value must be of type timezone

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Aodh::Alarm
    properties:
      alarm_actions: [Value, Value, ...]
      alarm_queues: [String, String, ...]
      comparison_operator: String
      description: String
      enabled: Boolean
      evaluation_periods: Integer
      insufficient_data_actions: [Value, Value, ...]
      insufficient_data_queues: [String, String, ...]
      matching_metadata: {...}
      meter_name: String
      ok_actions: [Value, Value, ...]
      ok_queues: [String, String, ...]
      period: Integer
      query: [{"field": String, "type": String, "op": String, "value": String}, {"field": String, "type": String, "op": String, "value": String}, ...]
      repeat_actions: Boolean
      severity: String
      statistic: String
      threshold: Number
      time_constraints: [{"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, {"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, ...]

OS::Heat::AccessPolicy

Resource for defining which resources can be accessed by users.

NOTE: Now this resource is actually associated with an AWS user resource, not any OS:: resource though it is registered under the OS namespace below.

Resource for defining resources that users are allowed to access by the DescribeStackResource API.

Required Properties

AllowedResources
Resources that users are allowed to access by the DescribeStackResource API.
List value expected.
Updates cause replacement.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::AccessPolicy
    properties:
      AllowedResources: [Value, Value, ...]

OS::Neutron::ExtraRoute

Resource for specifying extra routes for Neutron router.

Resource allows to specify nexthop IP and destination network for router.

Required Properties

destination
Network in CIDR notation.
String value expected.
Updates cause replacement.
nexthop
Nexthop IP address.
String value expected.
Updates cause replacement.
router_id
The router id.
String value expected.
Updates cause replacement.
Value must be of type neutron.router

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Neutron::ExtraRoute
    properties:
      destination: String
      nexthop: String
      router_id: String