OpenStack Resource Types¶

Required Properties¶

composite_rule¶

Composite threshold rules in JSON format.

Map value expected.

Can be updated without replacement.

Map properties:

operator¶

Required.

The operator indicates how to combine the rules.

String value expected.

Can be updated without replacement.

Allowed values: or, and

rules¶

Rules list. Basic threshold/gnocchi rules and nested dict which combine threshold/gnocchi rules by “and” or “or” are allowed. For example, the form is like: [RULE1, RULE2, {“and”: [RULE3, RULE4]}], the basic threshold/gnocchi rules must include a “type” field.

List value expected.

Can be updated without replacement.

The length must be at least 2.

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¶

Available since 8.0.0 (Ocata)

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

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"

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¶

Available since 8.0.0 (Ocata)

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

ok_actions¶

A list of URLs (webhooks) to invoke when state transitions to ok.

List value expected.

Can be updated without replacement.

ok_queues¶

Available since 8.0.0 (Ocata)

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

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¶

Available since 5.0.0 (Liberty)

Severity of the alarm.

String value expected.

Can be updated without replacement.

Defaults to "low"

Allowed values: low, moderate, critical

time_constraints¶

Available since 5.0.0 (Liberty)

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¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Aodh::CompositeAlarm
    properties:
      alarm_actions: [Value, Value, ...]
      alarm_queues: [String, String, ...]
      composite_rule: {"operator": String, "rules": [Value, Value, ...]}
      description: String
      enabled: Boolean
      insufficient_data_actions: [Value, Value, ...]
      insufficient_data_queues: [String, String, ...]
      ok_actions: [Value, Value, ...]
      ok_queues: [String, String, ...]
      repeat_actions: Boolean
      severity: String
      time_constraints: [{"duration": Integer, "start": String, "timezone": String, "name": String, "description": String}, {"duration": Integer, "start": String, "timezone": String, "name": String, "description": String}, ...]

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¶

Available since 8.0.0 (Ocata)

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

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"

event_type¶

Event type to evaluate against. If not specified will match all events.

String value expected.

Can be updated without replacement.

Defaults to "*"

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¶

Available since 8.0.0 (Ocata)

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

ok_actions¶

A list of URLs (webhooks) to invoke when state transitions to ok.

List value expected.

Can be updated without replacement.

ok_queues¶

Available since 8.0.0 (Ocata)

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

query¶

A list for filtering events. Query conditions used to filter specific events when evaluating the alarm.

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.

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¶

Available since 5.0.0 (Liberty)

Severity of the alarm.

String value expected.

Can be updated without replacement.

Defaults to "low"

Allowed values: low, moderate, critical

time_constraints¶

Available since 5.0.0 (Liberty)

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¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Aodh::EventAlarm
    properties:
      alarm_actions: [Value, Value, ...]
      alarm_queues: [String, String, ...]
      description: String
      enabled: Boolean
      event_type: String
      insufficient_data_actions: [Value, Value, ...]
      insufficient_data_queues: [String, String, ...]
      ok_actions: [Value, Value, ...]
      ok_queues: [String, String, ...]
      query: [{"field": String, "type": String, "value": String, "op": String}, {"field": String, "type": String, "value": String, "op": String}, ...]
      repeat_actions: Boolean
      severity: String
      time_constraints: [{"duration": Integer, "start": String, "timezone": String, "name": String, "description": String}, {"duration": Integer, "start": String, "timezone": String, "name": String, "description": String}, ...]

Required Properties¶

metrics¶

A list of metric ids.

List value expected.

Can be updated without replacement.

threshold¶

Threshold to evaluate against.

Number value expected.

Can be updated without replacement.

Optional Properties¶

aggregation_method¶

The aggregation method to compare to the threshold.

String value expected.

Can be updated without replacement.

Allowed values: mean, sum, last, max, min, std, median, first, count

alarm_actions¶

A list of URLs (webhooks) to invoke when state transitions to alarm.

List value expected.

Can be updated without replacement.

alarm_queues¶

Available since 8.0.0 (Ocata)

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.

granularity¶

The time range in seconds.

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¶

Available since 8.0.0 (Ocata)

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

ok_actions¶

A list of URLs (webhooks) to invoke when state transitions to ok.

List value expected.

Can be updated without replacement.

ok_queues¶

Available since 8.0.0 (Ocata)

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

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¶

Available since 5.0.0 (Liberty)

Severity of the alarm.

String value expected.

Can be updated without replacement.

Defaults to "low"

Allowed values: low, moderate, critical

time_constraints¶

Available since 5.0.0 (Liberty)

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¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Aodh::GnocchiAggregationByMetricsAlarm
    properties:
      aggregation_method: String
      alarm_actions: [Value, Value, ...]
      alarm_queues: [String, String, ...]
      comparison_operator: String
      description: String
      enabled: Boolean
      evaluation_periods: Integer
      granularity: Integer
      insufficient_data_actions: [Value, Value, ...]
      insufficient_data_queues: [String, String, ...]
      metrics: [Value, Value, ...]
      ok_actions: [Value, Value, ...]
      ok_queues: [String, String, ...]
      repeat_actions: Boolean
      severity: String
      threshold: Number
      time_constraints: [{"duration": Integer, "start": String, "timezone": String, "name": String, "description": String}, {"duration": Integer, "start": String, "timezone": String, "name": String, "description": String}, ...]

Required Properties¶

metric¶

Metric name watched by the alarm.

String value expected.

Can be updated without replacement.

query¶

The query to filter the metrics.

String value expected.

Can be updated without replacement.

resource_type¶

Resource type.

String value expected.

Can be updated without replacement.

threshold¶

Threshold to evaluate against.

Number value expected.

Can be updated without replacement.

Optional Properties¶

aggregation_method¶

The aggregation method to compare to the threshold.

String value expected.

Can be updated without replacement.

Allowed values: mean, sum, last, max, min, std, median, first, count

alarm_actions¶

A list of URLs (webhooks) to invoke when state transitions to alarm.

List value expected.

Can be updated without replacement.

alarm_queues¶

Available since 8.0.0 (Ocata)

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.

granularity¶

The time range in seconds.

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¶

Available since 8.0.0 (Ocata)

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

ok_actions¶

A list of URLs (webhooks) to invoke when state transitions to ok.

List value expected.

Can be updated without replacement.

ok_queues¶

Available since 8.0.0 (Ocata)

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

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¶

Available since 5.0.0 (Liberty)

Severity of the alarm.

String value expected.

Can be updated without replacement.

Defaults to "low"

Allowed values: low, moderate, critical

time_constraints¶

Available since 5.0.0 (Liberty)

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¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Aodh::GnocchiAggregationByResourcesAlarm
    properties:
      aggregation_method: String
      alarm_actions: [Value, Value, ...]
      alarm_queues: [String, String, ...]
      comparison_operator: String
      description: String
      enabled: Boolean
      evaluation_periods: Integer
      granularity: Integer
      insufficient_data_actions: [Value, Value, ...]
      insufficient_data_queues: [String, String, ...]
      metric: String
      ok_actions: [Value, Value, ...]
      ok_queues: [String, String, ...]
      query: String
      repeat_actions: Boolean
      resource_type: String
      severity: String
      threshold: Number
      time_constraints: [{"duration": Integer, "start": String, "timezone": String, "name": String, "description": String}, {"duration": Integer, "start": String, "timezone": String, "name": String, "description": String}, ...]

Required Properties¶

metric¶

Metric name watched by the alarm.

String value expected.

Can be updated without replacement.

resource_id¶

Id of a resource.

String value expected.

Can be updated without replacement.

resource_type¶

Resource type.

String value expected.

Can be updated without replacement.

threshold¶

Threshold to evaluate against.

Number value expected.

Can be updated without replacement.

Optional Properties¶

aggregation_method¶

The aggregation method to compare to the threshold.

String value expected.

Can be updated without replacement.

Allowed values: mean, sum, last, max, min, std, median, first, count

alarm_actions¶

A list of URLs (webhooks) to invoke when state transitions to alarm.

List value expected.

Can be updated without replacement.

alarm_queues¶

Available since 8.0.0 (Ocata)

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.

granularity¶

The time range in seconds.

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¶

Available since 8.0.0 (Ocata)

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

ok_actions¶

A list of URLs (webhooks) to invoke when state transitions to ok.

List value expected.

Can be updated without replacement.

ok_queues¶

Available since 8.0.0 (Ocata)

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

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¶

Available since 5.0.0 (Liberty)

Severity of the alarm.

String value expected.

Can be updated without replacement.

Defaults to "low"

Allowed values: low, moderate, critical

time_constraints¶

Available since 5.0.0 (Liberty)

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¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Aodh::GnocchiResourcesAlarm
    properties:
      aggregation_method: String
      alarm_actions: [Value, Value, ...]
      alarm_queues: [String, String, ...]
      comparison_operator: String
      description: String
      enabled: Boolean
      evaluation_periods: Integer
      granularity: Integer
      insufficient_data_actions: [Value, Value, ...]
      insufficient_data_queues: [String, String, ...]
      metric: String
      ok_actions: [Value, Value, ...]
      ok_queues: [String, String, ...]
      repeat_actions: Boolean
      resource_id: String
      resource_type: String
      severity: String
      threshold: Number
      time_constraints: [{"duration": Integer, "start": String, "timezone": String, "name": String, "description": String}, {"duration": Integer, "start": String, "timezone": String, "name": String, "description": String}, ...]

Optional Properties¶

certificate_ref¶

Reference to certificate.

String value expected.

Updates cause replacement.

Value must be of type barbican.secret

intermediates_ref¶

Reference to intermediates.

String value expected.

Updates cause replacement.

Value must be of type barbican.secret

name¶

Human-readable name for the container.

String value expected.

Updates cause replacement.

private_key_passphrase_ref¶

Reference to private key passphrase.

String value expected.

Updates cause replacement.

Value must be of type barbican.secret

private_key_ref¶

Reference to private key.

String value expected.

Updates cause replacement.

Value must be of type barbican.secret

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Barbican::CertificateContainer
    properties:
      certificate_ref: String
      intermediates_ref: String
      name: String
      private_key_passphrase_ref: String
      private_key_ref: String

Optional Properties¶

name¶

Human-readable name for the container.

String value expected.

Updates cause replacement.

secrets¶

References to secrets that will be stored in container.

List value expected.

Updates cause replacement.

List contents:

Map value expected.

Updates cause replacement.

Map properties:

name¶

Required.

Name of the secret.

String value expected.

Updates cause replacement.

ref¶

Required.

Reference to the secret.

String value expected.

Updates cause replacement.

Value must be of type barbican.secret

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Barbican::GenericContainer
    properties:
      name: String
      secrets: [{"ref": String, "name": String}, {"ref": String, "name": String}, ...]

Required Properties¶

type¶

Available since 5.0.0 (Liberty)

The type of the order.

String value expected.

Updates cause replacement.

Allowed values: key, asymmetric, certificate

Optional Properties¶

algorithm¶

The algorithm type used to generate the secret. Required for key and asymmetric types of order.

String value expected.

Updates cause replacement.

bit_length¶

The bit-length of the secret. Required for key and asymmetric types of order.

Integer value expected.

Updates cause replacement.

ca_id¶

Available since 5.0.0 (Liberty)

The identifier of the CA to use.

String value expected.

Updates cause replacement.

expiration¶

The expiration date for the secret in ISO-8601 format.

String value expected.

Updates cause replacement.

Value must be of type expiration

mode¶

The type/mode of the algorithm associated with the secret information.

String value expected.

Updates cause replacement.

name¶

Human readable name for the secret.

String value expected.

Updates cause replacement.

pass_phrase¶

Available since 5.0.0 (Liberty)

The passphrase of the created key. Can be set only for asymmetric type of order.

String value expected.

Updates cause replacement.

payload_content_type¶

The type/format the secret data is provided in.

String value expected.

Updates cause replacement.

profile¶

Available since 5.0.0 (Liberty)

The profile of certificate to use.

String value expected.

Updates cause replacement.

request_data¶

Available since 5.0.0 (Liberty)

The content of the CSR. Only for certificate orders.

String value expected.

Updates cause replacement.

request_type¶

Available since 5.0.0 (Liberty)

The type of the certificate request.

String value expected.

Updates cause replacement.

Allowed values: stored-key, simple-cmc, custom

source_container_ref¶

Available since 5.0.0 (Liberty)

The source of certificate request.

String value expected.

Updates cause replacement.

Value must be of type barbican.container

subject_dn¶

Available since 5.0.0 (Liberty)

The subject of the certificate request.

String value expected.

Updates cause replacement.

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Barbican::Order
    properties:
      algorithm: String
      bit_length: Integer
      ca_id: String
      expiration: String
      mode: String
      name: String
      pass_phrase: String
      payload_content_type: String
      profile: String
      request_data: String
      request_type: String
      source_container_ref: String
      subject_dn: String
      type: String

Optional Properties¶

name¶

Human-readable name for the container.

String value expected.

Updates cause replacement.

private_key_passphrase_ref¶

Reference to private key passphrase.

String value expected.

Updates cause replacement.

Value must be of type barbican.secret

private_key_ref¶

Reference to private key.

String value expected.

Updates cause replacement.

Value must be of type barbican.secret

public_key_ref¶

Reference to public key.

String value expected.

Updates cause replacement.

Value must be of type barbican.secret

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Barbican::RSAContainer
    properties:
      name: String
      private_key_passphrase_ref: String
      private_key_ref: String
      public_key_ref: String

Optional Properties¶

algorithm¶

The algorithm type used to generate the secret.

String value expected.

Updates cause replacement.

bit_length¶

The bit-length of the secret.

Integer value expected.

Updates cause replacement.

The value must be at least 0.

expiration¶

The expiration date for the secret in ISO-8601 format.

String value expected.

Updates cause replacement.

Value must be of type expiration

mode¶

The type/mode of the algorithm associated with the secret information.

String value expected.

Updates cause replacement.

name¶

Human readable name for the secret.

String value expected.

Updates cause replacement.

payload¶

The unencrypted plain text of the secret.

String value expected.

Updates cause replacement.

payload_content_encoding¶

The encoding format used to provide the payload data.

String value expected.

Updates cause replacement.

Allowed values: base64

payload_content_type¶

The type/format the secret data is provided in.

String value expected.

Updates cause replacement.

Allowed values: text/plain, application/octet-stream

secret_type¶

Available since 5.0.0 (Liberty)

The type of the secret.

String value expected.

Updates cause replacement.

Defaults to "opaque"

Allowed values: symmetric, public, private, certificate, passphrase, opaque

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Barbican::Secret
    properties:
      algorithm: String
      bit_length: Integer
      expiration: String
      mode: String
      name: String
      payload: String
      payload_content_encoding: String
      payload_content_type: String
      secret_type: String

Required Properties¶

provider¶

The class that provides encryption support. For example, nova.volume.encryptors.luks.LuksEncryptor.

String value expected.

Can be updated without replacement.

volume_type¶

Name or id of volume type (OS::Cinder::VolumeType).

String value expected.

Updates cause replacement.

Value must be of type cinder.vtype

Optional Properties¶

cipher¶

The encryption algorithm or mode. For example, aes-xts-plain64.

String value expected.

Can be updated without replacement.

Allowed values: aes-xts-plain64, aes-cbc-essiv

control_location¶

Notional service where encryption is performed For example, front-end. For Nova.

String value expected.

Can be updated without replacement.

Defaults to "front-end"

Allowed values: front-end, back-end

key_size¶

Size of encryption key, in bits. For example, 128 or 256.

Integer value expected.

Can be updated without replacement.

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Cinder::EncryptedVolumeType
    properties:
      cipher: String
      control_location: String
      key_size: Integer
      provider: String
      volume_type: String

Required Properties¶

qos_specs¶

ID or Name of the QoS specs.

String value expected.

Updates cause replacement.

Value must be of type cinder.qos_specs

volume_types¶

List of volume type IDs or Names to be attached to QoS specs.

List value expected.

Can be updated without replacement.

List contents:

Optional.

A volume type to attach specs.

String value expected.

Can be updated without replacement.

Value must be of type cinder.vtype

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Cinder::QoSAssociation
    properties:
      qos_specs: String
      volume_types: [String, String, ...]

Required Properties¶

specs¶

The specs key and value pairs of the QoS.

Map value expected.

Can be updated without replacement.

Optional Properties¶

name¶

Name of the QoS.

String value expected.

Updates cause replacement.

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Cinder::QoSSpecs
    properties:
      name: String
      specs: {...}

Required Properties¶

project¶

OpenStack Keystone Project.

String value expected.

Updates cause replacement.

Value must be of type keystone.project

Optional Properties¶

gigabytes¶

Quota for the amount of disk space (in Gigabytes). Setting the value to -1 removes the limit.

Integer value expected.

Can be updated without replacement.

The value must be at least -1.

snapshots¶

Quota for the number of snapshots. Setting the value to -1 removes the limit.

Integer value expected.

Can be updated without replacement.

The value must be at least -1.

volumes¶

Quota for the number of volumes. Setting the value to -1 removes the limit.

Integer value expected.

Can be updated without replacement.

The value must be at least -1.

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Cinder::Quota
    properties:
      gigabytes: Integer
      project: String
      snapshots: Integer
      volumes: Integer

Optional Properties¶

availability_zone¶

The availability zone in which the volume will be created.

String value expected.

Updates cause replacement.

backup_id¶

If specified, the backup to create the volume from.

String value expected.

Can be updated without replacement.

Value must be of type cinder.backup

description¶

A description of the volume.

String value expected.

Can be updated without replacement.

image¶

If specified, the name or ID of the image to create the volume from.

String value expected.

Updates cause replacement.

Value must be of type glance.image

metadata¶

Key/value pairs to associate with the volume.

Map value expected.

Can be updated without replacement.

Defaults to {}

multiattach¶

Available since 6.0.0 (Mitaka)

Whether allow the volume to be attached more than once.

Boolean value expected.

Updates cause replacement.

Defaults to false

name¶

A name used to distinguish the volume.

String value expected.

Can be updated without replacement.

read_only¶

Available since 5.0.0 (Liberty)

Enables or disables read-only access mode of volume.

Boolean value expected.

Can be updated without replacement.

scheduler_hints¶

Available since 2015.1 (Kilo)

Arbitrary key-value pairs specified by the client to help the Cinder scheduler creating a volume.

Map value expected.

Updates cause replacement.

size¶

The size of the volume in GB. On update only increase in size is supported. This property is required unless property backup_id or source_volid or snapshot_id is specified.

Integer value expected.

Can be updated without replacement.

The value must be at least 1.

snapshot_id¶

If specified, the snapshot to create the volume from.

String value expected.

Updates cause replacement.

Value must be of type cinder.snapshot

source_volid¶

If specified, the volume to use as source.

String value expected.

Updates cause replacement.

Value must be of type cinder.volume

volume_type¶

If specified, the type of volume to use, mapping to a specific backend.

String value expected.

Can be updated without replacement.

Value must be of type cinder.vtype

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Cinder::Volume
    properties:
      availability_zone: String
      backup_id: String
      description: String
      image: String
      metadata: {...}
      multiattach: Boolean
      name: String
      read_only: Boolean
      scheduler_hints: {...}
      size: Integer
      snapshot_id: String
      source_volid: String
      volume_type: String

Required Properties¶

instance_uuid¶

The ID of the server to which the volume attaches.

String value expected.

Can be updated without replacement.

volume_id¶

The ID of the volume to be attached.

String value expected.

Can be updated without replacement.

Value must be of type cinder.volume

Optional Properties¶

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.

String value expected.

Can be updated without replacement.

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Cinder::VolumeAttachment
    properties:
      instance_uuid: String
      mountpoint: String
      volume_id: String

Required Properties¶

name¶

Name of the volume type.

String value expected.

Can be updated without replacement.

Optional Properties¶

description¶

Available since 5.0.0 (Liberty)

Description of the volume type.

String value expected.

Can be updated without replacement.

is_public¶

Available since 5.0.0 (Liberty)

Whether the volume type is accessible to the public.

Boolean value expected.

Can be updated without replacement.

Defaults to true

metadata¶

The extra specs key and value pairs of the volume type.

Map value expected.

Can be updated without replacement.

projects¶

Available since 5.0.0 (Liberty)

Projects to add volume type access to. NOTE: This property is only supported since Cinder API V2.

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 keystone.project

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Cinder::VolumeType
    properties:
      description: String
      is_public: Boolean
      metadata: {...}
      name: String
      projects: [String, String, ...]

Required Properties¶

records¶

A list of data for this RecordSet. Each item will be a separate record in Designate These items should conform to the DNS spec for the record type - e.g. A records must be IPv4 addresses, CNAME records must be a hostname. DNS record data varies based on the type of record. For more details, please refer rfc 1035.

List value expected.

Can be updated without replacement.

type¶

DNS RecordSet type.

String value expected.

Updates cause replacement.

Allowed values: A, AAAA, CNAME, MX, SRV, TXT, SPF, NS, PTR, SSHFP, SOA

zone¶

DNS Zone id or name.

String value expected.

Updates cause replacement.

Value must be of type designate.zone

Optional Properties¶

description¶

Description of RecordSet.

String value expected.

Can be updated without replacement.

The length must be no greater than 160.

name¶

RecordSet name.

String value expected.

Updates cause replacement.

The length must be no greater than 255.

ttl¶

Time To Live (Seconds).

Integer value expected.

Can be updated without replacement.

The value must be in the range 1 to 2147483647.

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Designate::RecordSet
    properties:
      description: String
      name: String
      records: [Value, Value, ...]
      ttl: Integer
      type: String
      zone: String

Required Properties¶

name¶

DNS Name for the zone.

String value expected.

Updates cause replacement.

The length must be no greater than 255.

Optional Properties¶

description¶

Description of zone.

String value expected.

Can be updated without replacement.

The length must be no greater than 160.

email¶

E-mail for the zone. Used in SOA records for the zone. It is required for PRIMARY Type, otherwise ignored.

String value expected.

Can be updated without replacement.

masters¶

The servers to slave from to get DNS information and is mandatory for zone type SECONDARY, otherwise ignored.

List value expected.

Can be updated without replacement.

ttl¶

Time To Live (Seconds) for the zone.

Integer value expected.

Can be updated without replacement.

The value must be in the range 1 to 2147483647.

type¶

Type of zone. PRIMARY is controlled by Designate, SECONDARY zones are slaved from another DNS Server.

String value expected.

Updates cause replacement.

Defaults to "PRIMARY"

Allowed values: PRIMARY, SECONDARY

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Designate::Zone
    properties:
      description: String
      email: String
      masters: [Value, Value, ...]
      name: String
      ttl: Integer
      type: String

Required Properties¶

AllowedResources¶

Resources that users are allowed to access by the DescribeStackResource API.

List value expected.

Updates cause replacement.

Attributes¶

HOT Syntax¶

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

Required Properties¶

max_size¶

Maximum number of resources in the group.

Integer value expected.

Can be updated without replacement.

The value must be at least 0.

min_size¶

Minimum number of resources in the group.

Integer value expected.

Can be updated without replacement.

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.

Map value expected.

Can be updated without replacement.

Optional Properties¶

cooldown¶

Cooldown period, in seconds.

Integer value expected.

Can be updated without replacement.

desired_capacity¶

Desired initial number of resources.

Integer value expected.

Can be updated without replacement.

rolling_updates¶

Policy for rolling updates for this scaling group.

Map value expected.

Can be updated without replacement.

Defaults to {"min_in_service": 0, "pause_time": 0, "max_batch_size": 1}

Map properties:

max_batch_size¶

Optional.

The maximum number of resources to replace at once.

Integer value expected.

Can be updated without replacement.

Defaults to 1

The value must be at least 1.

min_in_service¶

Optional.

The minimum number of resources in service while rolling updates are being executed.

Integer value expected.

Can be updated without replacement.

Defaults to 0

The value must be at least 0.

pause_time¶

Optional.

The number of seconds to wait between batches of updates.

Number value expected.

Can be updated without replacement.

Defaults to 0

The value must be at least 0.

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
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": Integer, "pause_time": Number, "max_batch_size": Integer}

Optional Properties¶

cloud_config¶

Map representing the cloud-config data structure which will be formatted as YAML.

Map value expected.

Updates cause replacement.

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::CloudConfig
    properties:
      cloud_config: {...}

Optional Properties¶

actions¶

Actions during which the delay will occur.

List value expected.

Can be updated without replacement.

Defaults to ["CREATE"]

Allowed values: CREATE, DELETE, SUSPEND, RESUME

jitter_multiplier¶

Number of seconds to multiply the maximum jitter value by.

Number value expected.

Can be updated without replacement.

Defaults to 1.0

The value must be at least 0.

max_jitter¶

Maximum jitter to add to the minimum wait time.

Number value expected.

Can be updated without replacement.

Defaults to 0

The value must be at least 0.

min_wait¶

Minimum time in seconds to wait during the specified actions.

Number value expected.

Can be updated without replacement.

Defaults to 0

The value must be at least 0.

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::Delay
    properties:
      actions: [Value, Value, ...]
      jitter_multiplier: Number
      max_jitter: Number
      min_wait: Number

Optional Properties¶

deployment_swift_data¶

Available since 9.0.0 (Pike)

Swift container and object to use for storing deployment data for the server resource. The parameter is a map value with the keys “container” and “object”, and the values are the corresponding container and object names. The software_config_transport parameter must be set to POLL_TEMP_URL for swift to be used. If not specified, and software_config_transport is set to POLL_TEMP_URL, a container will be automatically created from the resource name, and the object name will be a generated uuid.

Map value expected.

Can be updated without replacement.

Defaults to {}

Map properties:

container¶

Optional.

Name of the container.

String value expected.

Can be updated without replacement.

The length must be at least 1.

object¶

Optional.

Name of the object.

String value expected.

Can be updated without replacement.

The length must be at least 1.

name¶

Server name.

String value expected.

Can be updated without replacement.

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. ZAQAR_MESSAGE will create a dedicated zaqar queue and post the metadata for polling.

String value expected.

Can be updated without replacement.

Defaults to "POLL_SERVER_CFN"

Allowed values: POLL_SERVER_CFN, POLL_SERVER_HEAT, POLL_TEMP_URL, ZAQAR_MESSAGE

metadata¶

DEPRECATED since 9.0.0 (Pike) - This property will be ignored

Available since 8.0.0 (Ocata)

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).

Map value expected.

Can be updated without replacement.

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::DeployedServer
    properties:
      deployment_swift_data: {"object": String, "container": String}
      name: String
      software_config_transport: String

Required Properties¶

AvailabilityZones¶

Not Implemented.

List value expected.

Updates cause replacement.

LaunchConfigurationName¶

The reference to a LaunchConfiguration resource.

String value expected.

Can be updated without replacement.

Size¶

Desired number of instances.

Integer value expected.

Can be updated without replacement.

Optional Properties¶

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.

Tag key.

String value expected.

Updates cause replacement.

Value¶

Required.

Tag value.

String value expected.

Updates cause replacement.

Attributes¶

update_policy¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
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}, ...]

Optional Properties¶

parts¶

Parts belonging to this message.

List value expected.

Updates cause replacement.

Defaults to []

List contents:

Map value expected.

Updates cause replacement.

Map properties:

config¶

Required.

Content of part to attach, either inline or by referencing the ID of another software config resource.

String value expected.

Updates cause replacement.

filename¶

Optional.

Optional filename to associate with part.

String value expected.

Updates cause replacement.

subtype¶

Optional.

Optional subtype to specify with the type.

String value expected.

Updates cause replacement.

type¶

Optional.

Whether the part content is text or multipart.

String value expected.

Updates cause replacement.

Defaults to "text"

Allowed values: text, multipart

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
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}, ...]

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::None

Optional Properties¶

character_classes¶

A list of character class and their constraints to generate the random string from.

List value expected.

Updates cause replacement.

Defaults to [{"class": "lettersdigits", "min": 1}]

List contents:

Map value expected.

Updates cause replacement.

Map properties:

class¶

Optional.

A character class and its corresponding min constraint to generate the random string from.

String value expected.

Updates cause replacement.

Defaults to "lettersdigits"

Allowed values: lettersdigits, letters, lowercase, uppercase, digits, hexdigits, octdigits

min¶

Optional.

The minimum number of characters from this character class that will be in the generated string.

Integer value expected.

Updates cause replacement.

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.

List value expected.

Updates cause replacement.

List contents:

Map value expected.

Updates cause replacement.

Map properties:

min¶

Optional.

The minimum number of characters from this sequence that will be in the generated string.

Integer value expected.

Updates cause replacement.

Defaults to 1

The value must be in the range 1 to 512.

sequence¶

Required.

A character sequence and its corresponding min constraint to generate the random string from.

String value expected.

Updates cause replacement.

length¶

Length of the string to generate.

Integer value expected.

Updates cause replacement.

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.

String value expected.

Updates cause replacement.

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
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

Required Properties¶

resources¶

The list of resource types to create. This list may contain type names or aliases defined in the resource registry. Specific template names are not supported.

List value expected.

Can be updated without replacement.

Optional Properties¶

concurrent¶

If true, the resources in the chain will be created concurrently. If false or omitted, each resource will be treated as having a dependency on the previous resource in the list.

Boolean value expected.

Updates cause replacement.

Defaults to false

resource_properties¶

Properties to pass to each resource being created in the chain.

Map value expected.

Updates cause replacement.

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::ResourceChain
    properties:
      concurrent: Boolean
      resource_properties: {...}
      resources: [Value, Value, ...]

Required Properties¶

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.

Map value expected.

Can be updated without replacement.

Map properties:

metadata¶

Available since 5.0.0 (Liberty)

Supplied metadata for the resources in the group.

Map value expected.

Can be updated without replacement.

properties¶

Property values for the resources in the group.

Map value expected.

Can be updated without replacement.

type¶

Required.

The type of the resources in the group.

String value expected.

Can be updated without replacement.

Optional Properties¶

count¶

The number of resources to create.

Integer value expected.

Can be updated without replacement.

Defaults to 1

The value must be at least 0.

index_var¶

Available since 2014.2 (Juno)

A variable that this resource will use to replace with the current index of a given resource in the group. Can be used, for example, to customize the name property of grouped servers in order to differentiate them when listed with nova client.

String value expected.

Updates cause replacement.

Defaults to "%index%"

The length must be at least 3.

removal_policies¶

Available since 2015.1 (Kilo)

Policies for removal of resources on update.

List value expected.

Can be updated without replacement.

Defaults to []

List contents:

Policy to be processed when doing an update which requires removal of specific resources.

Map value expected.

Can be updated without replacement.

Map properties:

resource_list¶

List of resources to be removed when doing an update which requires removal of specific resources. The resource may be specified several ways: (1) The resource name, as in the nested stack, (2) The resource reference returned from get_resource in a template, as available via the ‘refs’ attribute. Note this is destructive on update when specified; even if the count is not being reduced, and once a resource name is removed, its name is never reused in subsequent updates.

List value expected.

Can be updated without replacement.

Defaults to []

removal_policies_mode¶

Available since 10.0.0 (Queens)

How to handle changes to removal_policies on update. The default “append” mode appends to the internal list, “update” replaces it on update.

String value expected.

Can be updated without replacement.

Defaults to "append"

Allowed values: append, update

Attributes¶

update_policy¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::ResourceGroup
    properties:
      count: Integer
      index_var: String
      removal_policies: [{"resource_list": [Value, Value, ...]}, {"resource_list": [Value, Value, ...]}, ...]
      removal_policies_mode: String
      resource_def: {"type": String, "properties": {...}, "metadata": {...}}

Required Properties¶

adjustment_type¶

Type of adjustment (absolute or percentage).

String value expected.

Can be updated without replacement.

Allowed values: change_in_capacity, exact_capacity, percent_change_in_capacity

auto_scaling_group_id¶

AutoScaling group ID to apply policy to.

String value expected.

Updates cause replacement.

scaling_adjustment¶

Size of adjustment.

Number value expected.

Can be updated without replacement.

Optional Properties¶

cooldown¶

Cooldown period, in seconds.

Number value expected.

Can be updated without replacement.

min_adjustment_step¶

Minimum number of resources that are added or removed when the AutoScaling group scales up or down. This can be used only when specifying percent_change_in_capacity for the adjustment_type property.

Integer value expected.

Can be updated without replacement.

The value must be at least 0.

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::ScalingPolicy
    properties:
      adjustment_type: String
      auto_scaling_group_id: String
      cooldown: Number
      min_adjustment_step: Integer
      scaling_adjustment: Number

Required Properties¶

configs¶

The list of configurations for the different lifecycle actions of the represented software component.

List value expected.

Updates cause replacement.

The length must be at least 1.

List contents:

Map value expected.

Updates cause replacement.

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.

List value expected.

Updates cause replacement.

Defaults to ["CREATE", "UPDATE"]

The length must be at least 1.

List contents:

Optional.

String value expected.

Updates cause replacement.

config¶

Optional.

Configuration script or manifest which specifies what actual configuration is performed.

String value expected.

Updates cause replacement.

tool¶

Required.

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.

String value expected.

Updates cause replacement.

Optional Properties¶

inputs¶

Schema representing the inputs that this software config is expecting.

List value expected.

Updates cause replacement.

List contents:

Map value expected.

Updates cause replacement.

Map properties:

default¶

Optional.

Default value for the input if none is specified.

Any value expected.

Updates cause replacement.

description¶

Optional.

Description of the input.

String value expected.

Updates cause replacement.

name¶

Required.

Name of the input.

String value expected.

Updates cause replacement.

replace_on_change¶

Optional.

Replace the deployment instead of updating it when the input value changes.

Boolean value expected.

Updates cause replacement.

Defaults to false

type¶

Optional.

Type of the value of the input.

String value expected.

Updates cause replacement.

Defaults to "String"

Allowed values: String, Number, CommaDelimitedList, Json, Boolean

options¶

Map containing options specific to the configuration management tool used by this resource.

Map value expected.

Updates cause replacement.

outputs¶

Schema representing the outputs that this software config will produce.

List value expected.

Updates cause replacement.

List contents:

Map value expected.

Updates cause replacement.

Map properties:

description¶

Optional.

Description of the output.

String value expected.

Updates cause replacement.

error_output¶

Optional.

Denotes that the deployment is in an error state if this output has a value.

Boolean value expected.

Updates cause replacement.

Defaults to false

name¶

Required.

Name of the output.

String value expected.

Updates cause replacement.

type¶

Optional.

Type of the value of the output.

String value expected.

Updates cause replacement.

Defaults to "String"

Allowed values: String, Number, CommaDelimitedList, Json, Boolean

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
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": Any, "type": String, "name": String, "replace_on_change": Boolean, "description": String}, {"default": Any, "type": String, "name": String, "replace_on_change": Boolean, "description": String}, ...]
      options: {...}
      outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]

Optional Properties¶

config¶

Configuration script or manifest which specifies what actual configuration is performed.

String value expected.

Updates cause replacement.

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.

String value expected.

Updates cause replacement.

Defaults to "Heat::Ungrouped"

inputs¶

Schema representing the inputs that this software config is expecting.

List value expected.

Updates cause replacement.

List contents:

Map value expected.

Updates cause replacement.

Map properties:

default¶

Optional.

Default value for the input if none is specified.

Any value expected.

Updates cause replacement.

description¶

Optional.

Description of the input.

String value expected.

Updates cause replacement.

name¶

Required.

Name of the input.

String value expected.

Updates cause replacement.

replace_on_change¶

Optional.

Replace the deployment instead of updating it when the input value changes.

Boolean value expected.

Updates cause replacement.

Defaults to false

type¶

Optional.

Type of the value of the input.

String value expected.

Updates cause replacement.

Defaults to "String"

Allowed values: String, Number, CommaDelimitedList, Json, Boolean

options¶

Map containing options specific to the configuration management tool used by this resource.

Map value expected.

Updates cause replacement.

outputs¶

Schema representing the outputs that this software config will produce.

List value expected.

Updates cause replacement.

List contents:

Map value expected.

Updates cause replacement.

Map properties:

description¶

Optional.

Description of the output.

String value expected.

Updates cause replacement.

error_output¶

Optional.

Denotes that the deployment is in an error state if this output has a value.

Boolean value expected.

Updates cause replacement.

Defaults to false

name¶

Required.

Name of the output.

String value expected.

Updates cause replacement.

type¶

Optional.

Type of the value of the output.

String value expected.

Updates cause replacement.

Defaults to "String"

Allowed values: String, Number, CommaDelimitedList, Json, Boolean

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::SoftwareConfig
    properties:
      config: String
      group: String
      inputs: [{"default": Any, "type": String, "name": String, "replace_on_change": Boolean, "description": String}, {"default": Any, "type": String, "name": String, "replace_on_change": Boolean, "description": String}, ...]
      options: {...}
      outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]

Required Properties¶

server¶

ID of resource to apply configuration to. Normally this should be a Nova server ID.

String value expected.

Updates cause replacement.

Optional Properties¶

actions¶

Which lifecycle actions of the deployment resource will result in this deployment being triggered.

List value expected.

Can be updated without replacement.

Defaults to ["CREATE", "UPDATE"]

Allowed values: CREATE, UPDATE, DELETE, SUSPEND, RESUME

config¶

ID of software configuration resource to execute when applying to the server.

String value expected.

Can be updated without replacement.

input_values¶

Input values to apply to the software configuration on this server.

Map value expected.

Can be updated without replacement.

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.

String value expected.

Can be updated without replacement.

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. TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT. HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signaled using the provided keystone credentials. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal.

String value expected.

Updates cause replacement.

Defaults to "CFN_SIGNAL"

Allowed values: CFN_SIGNAL, TEMP_URL_SIGNAL, HEAT_SIGNAL, NO_SIGNAL, ZAQAR_SIGNAL

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::SoftwareDeployment
    properties:
      actions: [Value, Value, ...]
      config: String
      input_values: {...}
      name: String
      server: String
      signal_transport: String

Required Properties¶

servers¶

A map of names and server IDs to apply configuration to. The name is arbitrary and is used as the Heat resource name for the corresponding deployment.

Map value expected.

Can be updated without replacement.

Optional Properties¶

actions¶

Which lifecycle actions of the deployment resource will result in this deployment being triggered.

List value expected.

Can be updated without replacement.

Defaults to ["CREATE", "UPDATE"]

Allowed values: CREATE, UPDATE, DELETE, SUSPEND, RESUME

config¶

ID of software configuration resource to execute when applying to the server.

String value expected.

Can be updated without replacement.

input_values¶

Input values to apply to the software configuration on this server.

Map value expected.

Can be updated without replacement.

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.

String value expected.

Can be updated without replacement.

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. TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT. HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signaled using the provided keystone credentials. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal.

String value expected.

Updates cause replacement.

Defaults to "CFN_SIGNAL"

Allowed values: CFN_SIGNAL, TEMP_URL_SIGNAL, HEAT_SIGNAL, NO_SIGNAL, ZAQAR_SIGNAL

Attributes¶

update_policy¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::SoftwareDeploymentGroup
    properties:
      actions: [Value, Value, ...]
      config: String
      input_values: {...}
      name: String
      servers: {...}
      signal_transport: String

Required Properties¶

template¶

Template that specifies the stack to be created as a resource.

String value expected.

Can be updated without replacement.

Optional Properties¶

context¶

Context for this stack.

Map value expected.

Updates cause replacement.

Map properties:

region_name¶

Required.

Region name in which this stack will be created.

String value expected.

Updates cause replacement.

parameters¶

Set of parameters passed to this stack.

Map value expected.

Can be updated without replacement.

Defaults to {}

timeout¶

Number of minutes to wait for this stack creation.

Integer value expected.

Can be updated without replacement.

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::Stack
    properties:
      context: {"region_name": String}
      parameters: {...}
      template: String
      timeout: Integer

Optional Properties¶

config¶

Map representing the configuration data structure which will be serialized to JSON format.

Map value expected.

Updates cause replacement.

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.

String value expected.

Updates cause replacement.

Defaults to "Heat::Ungrouped"

inputs¶

Schema representing the inputs that this software config is expecting.

List value expected.

Updates cause replacement.

List contents:

Map value expected.

Updates cause replacement.

Map properties:

default¶

Optional.

Default value for the input if none is specified.

Any value expected.

Updates cause replacement.

description¶

Optional.

Description of the input.

String value expected.

Updates cause replacement.

name¶

Required.

Name of the input.

String value expected.

Updates cause replacement.

replace_on_change¶

Optional.

Replace the deployment instead of updating it when the input value changes.

Boolean value expected.

Updates cause replacement.

Defaults to false

type¶

Optional.

Type of the value of the input.

String value expected.

Updates cause replacement.

Defaults to "String"

Allowed values: String, Number, CommaDelimitedList, Json, Boolean

options¶

Map containing options specific to the configuration management tool used by this resource.

Map value expected.

Updates cause replacement.

outputs¶

Schema representing the outputs that this software config will produce.

List value expected.

Updates cause replacement.

List contents:

Map value expected.

Updates cause replacement.

Map properties:

description¶

Optional.

Description of the output.

String value expected.

Updates cause replacement.

error_output¶

Optional.

Denotes that the deployment is in an error state if this output has a value.

Boolean value expected.

Updates cause replacement.

Defaults to false

name¶

Required.

Name of the output.

String value expected.

Updates cause replacement.

type¶

Optional.

Type of the value of the output.

String value expected.

Updates cause replacement.

Defaults to "String"

Allowed values: String, Number, CommaDelimitedList, Json, Boolean

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::StructuredConfig
    properties:
      config: {...}
      group: String
      inputs: [{"default": Any, "type": String, "name": String, "replace_on_change": Boolean, "description": String}, {"default": Any, "type": String, "name": String, "replace_on_change": Boolean, "description": String}, ...]
      options: {...}
      outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]

Required Properties¶

server¶

ID of resource to apply configuration to. Normally this should be a Nova server ID.

String value expected.

Updates cause replacement.

Optional Properties¶

actions¶

Which lifecycle actions of the deployment resource will result in this deployment being triggered.

List value expected.

Can be updated without replacement.

Defaults to ["CREATE", "UPDATE"]

Allowed values: CREATE, UPDATE, DELETE, SUSPEND, RESUME

config¶

ID of software configuration resource to execute when applying to the server.

String value expected.

Can be updated without replacement.

input_key¶

Name of key to use for substituting inputs during deployment.

String value expected.

Updates cause replacement.

Defaults to "get_input"

input_values¶

Input values to apply to the software configuration on this server.

Map value expected.

Can be updated without replacement.

input_values_validate¶

Perform a check on the input values passed to verify that each required input has a corresponding value. When the property is set to STRICT and no value is passed, an exception is raised.

String value expected.

Updates cause replacement.

Defaults to "LAX"

Allowed values: LAX, STRICT

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.

String value expected.

Can be updated without replacement.

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. TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT. HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signaled using the provided keystone credentials. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal.

String value expected.

Updates cause replacement.

Defaults to "CFN_SIGNAL"

Allowed values: CFN_SIGNAL, TEMP_URL_SIGNAL, HEAT_SIGNAL, NO_SIGNAL, ZAQAR_SIGNAL

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::StructuredDeployment
    properties:
      actions: [Value, Value, ...]
      config: String
      input_key: String
      input_values: {...}
      input_values_validate: String
      name: String
      server: String
      signal_transport: String

Required Properties¶

servers¶

A map of names and server IDs to apply configuration to. The name is arbitrary and is used as the Heat resource name for the corresponding deployment.

Map value expected.

Can be updated without replacement.

Optional Properties¶

actions¶

Which lifecycle actions of the deployment resource will result in this deployment being triggered.

List value expected.

Can be updated without replacement.

Defaults to ["CREATE", "UPDATE"]

Allowed values: CREATE, UPDATE, DELETE, SUSPEND, RESUME

config¶

ID of software configuration resource to execute when applying to the server.

String value expected.

Can be updated without replacement.

input_key¶

Name of key to use for substituting inputs during deployment.

String value expected.

Updates cause replacement.

Defaults to "get_input"

input_values¶

Input values to apply to the software configuration on this server.

Map value expected.

Can be updated without replacement.

input_values_validate¶

Perform a check on the input values passed to verify that each required input has a corresponding value. When the property is set to STRICT and no value is passed, an exception is raised.

String value expected.

Updates cause replacement.

Defaults to "LAX"

Allowed values: LAX, STRICT

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.

String value expected.

Can be updated without replacement.

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. TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT. HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signaled using the provided keystone credentials. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal.

String value expected.

Updates cause replacement.

Defaults to "CFN_SIGNAL"

Allowed values: CFN_SIGNAL, TEMP_URL_SIGNAL, HEAT_SIGNAL, NO_SIGNAL, ZAQAR_SIGNAL

Attributes¶

update_policy¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::StructuredDeploymentGroup
    properties:
      actions: [Value, Value, ...]
      config: String
      input_key: String
      input_values: {...}
      input_values_validate: String
      name: String
      servers: {...}
      signal_transport: String

Required Properties¶

handle¶

URL of TempURL where resource will signal completion and optionally upload data.

String value expected.

Updates cause replacement.

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.

Number 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.

Updates cause replacement.

Defaults to 1

The value must be in the range 1 to 1000.

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::SwiftSignal
    properties:
      count: Integer
      handle: String
      timeout: Number

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::SwiftSignalHandle

Optional Properties¶

action_wait_secs¶

Options for simulating waiting.

Map value expected.

Can be updated without replacement.

Map properties:

create¶

Optional.

Seconds to wait after a create. Defaults to the global wait_secs.

Number value expected.

Can be updated without replacement.

delete¶

Optional.

Seconds to wait after a delete. Defaults to the global wait_secs.

Number value expected.

Can be updated without replacement.

update¶

Optional.

Seconds to wait after an update. Defaults to the global wait_secs.

Number value expected.

Can be updated without replacement.

attr_wait_secs¶

Available since 6.0.0 (Mitaka)

Number value for timeout during resolving output value.

Number value expected.

Can be updated without replacement.

Defaults to 0

client_name¶

Client to poll.

String value expected.

Can be updated without replacement.

Defaults to ""

constraint_prop_secs¶

Available since 6.0.0 (Mitaka)

Number value for delay during resolve constraint.

Number value expected.

Can be updated without replacement.

Defaults to 0

Value must be of type test_constr

entity_name¶

Client entity to poll.

String value expected.

Can be updated without replacement.

Defaults to ""

fail¶

Value which can be set to fail the resource operation to test failure scenarios.

Boolean value expected.

Can be updated without replacement.

Defaults to false

update_replace¶

Value which can be set to trigger update replace for the particular resource.

Boolean value expected.

Can be updated without replacement.

Defaults to false

update_replace_value¶

Available since 7.0.0 (Newton)

Some value that can be stored but can not be updated.

String value expected.

Updates cause replacement.

value¶

The input string to be stored.

String value expected.

Can be updated without replacement.

Defaults to "test_string"

wait_secs¶

Seconds to wait after an action (-1 is infinite).

Number value expected.

Can be updated without replacement.

Defaults to 0

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::TestResource
    properties:
      action_wait_secs: {"create": Number, "update": Number, "delete": Number}
      attr_wait_secs: Number
      client_name: String
      constraint_prop_secs: Number
      entity_name: String
      fail: Boolean
      update_replace: Boolean
      update_replace_value: String
      value: String
      wait_secs: Number

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::UpdateWaitConditionHandle

Required Properties¶

value¶

The expression to generate the “value” attribute.

Any value expected.

Can be updated without replacement.

Optional Properties¶

type¶

The type of the “value” property.

String value expected.

Can be updated without replacement.

Allowed values: string, number, comma_delimited_list, json, boolean

Attributes¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::Value
    properties:
      type: String
      value: Any

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.

Number 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¶

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Heat::WaitCondition
    properties:
      count: Integer
      handle: String
      timeout: Number

Optional Properties¶

signal_transport¶

Available since 6.0.0 (Mitaka)

How the client will signal the wait condition. CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL. TEMP_URL_SIGNAL will create a Swift TempURL to be signalled via HTTP PUT. HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signalled using the provided keystone credentials. TOKEN_SIGNAL will allow and HTTP POST to a Heat API endpoint with the provided keystone token. NO_SIGNAL will result in the resource going to a signalled state without waiting for any signal.

String value expected.

Updates cause replacement.

Defaults to "TOKEN_SIGNAL"

Allowed values: CFN_SIGNAL, TEMP_URL_SIGNAL, HEAT_SIGNAL, NO_SIGNAL, ZAQAR_SIGNAL, TOKEN_SIGNAL

Attributes¶