This page documents the language specification for the openstack package. If you're looking for help working with the inputs, outputs, or functions of openstack resources in a Pulumi program, please see the resource documentation for examples and API reference.

orchestration¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-openstack repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-openstack repo.

class pulumi_openstack.orchestration.StackV1(resource_name, opts=None, capabilities=None, creation_time=None, description=None, disable_rollback=None, environment_opts=None, name=None, notification_topics=None, outputs=None, parameters=None, region=None, status=None, status_reason=None, tags=None, template_description=None, template_opts=None, timeout=None, updated_time=None, __props__=None, __name__=None, __opts__=None)¶

Manages a V1 stack resource within OpenStack.

## Example Usage



```python
import pulumi
import pulumi_openstack as openstack

stack1 = openstack.orchestration.StackV1("stack1",
    disable_rollback=True,
    environment_opts={
        "Bin": "

“,

}, parameters={
“length”: 4,
}, template_opts={
“Bin”: “””heat_template_version: 2013-05-23

parameters:

length:: type: number

resources:

test_res:: type: OS::Heat::TestResource
random:: type: OS::Heat::RandomString properties:
length: {get_param: length}

""",
    },
    timeout=30)
```


:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
:param pulumi.Input[list] capabilities: List of stack capabilities for stack.
:param pulumi.Input[str] creation_time: The date and time when the resource was created. The date
       and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm
       For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included,
       is the time zone as an offset from UTC.
:param pulumi.Input[str] description: The description of the stack resource.
:param pulumi.Input[bool] disable_rollback: Enables or disables deletion of all stack
       resources when a stack creation fails. Default is true, meaning all
       resources are not deleted when stack creation fails.
:param pulumi.Input[dict] environment_opts: Environment key/value pairs to associate with
       the stack which contains details for the environment of the stack.
       Allowed keys: Bin, URL, Files. Changing this updates the existing stack
       Environment Opts.
:param pulumi.Input[str] name: A unique name for the stack. It must start with an
       alphabetic character. Changing this updates the stack's name.
:param pulumi.Input[list] notification_topics: List of notification topics for stack.
:param pulumi.Input[list] outputs: A list of stack outputs.
:param pulumi.Input[dict] parameters: User-defined key/value pairs as parameters to pass
       to the template. Changing this updates the existing stack parameters.
:param pulumi.Input[str] region: The region in which to create the stack. If
       omitted, the `region` argument of the provider is used. Changing this
       creates a new stack.
:param pulumi.Input[str] status: The status of the stack.
:param pulumi.Input[str] status_reason: The reason for the current status of the stack.
:param pulumi.Input[list] tags: A list of tags to assosciate with the Stack
:param pulumi.Input[str] template_description: The description of the stack template.
:param pulumi.Input[dict] template_opts: Template key/value pairs to associate with the
       stack which contains either the template file or url.
       Allowed keys: Bin, URL, Files. Changing this updates the existing stack
       Template Opts.
:param pulumi.Input[float] timeout: The timeout for stack action in minutes.
:param pulumi.Input[str] updated_time: The date and time when the resource was updated. The date
       and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm
       For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included,
       is the time zone as an offset from UTC.

The **outputs** object supports the following:

  * `description` (`pulumi.Input[str]`) - The description of the stack resource.
  * `outputKey` (`pulumi.Input[str]`)
  * `outputValue` (`pulumi.Input[str]`)

capabilities: pulumi.Output[list] = None¶: List of stack capabilities for stack.

creation_time: pulumi.Output[str] = None¶: The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.

description: pulumi.Output[str] = None¶: The description of the stack resource.

disable_rollback: pulumi.Output[bool] = None¶: Enables or disables deletion of all stack resources when a stack creation fails. Default is true, meaning all resources are not deleted when stack creation fails.

environment_opts: pulumi.Output[dict] = None¶: Environment key/value pairs to associate with the stack which contains details for the environment of the stack. Allowed keys: Bin, URL, Files. Changing this updates the existing stack Environment Opts.

name: pulumi.Output[str] = None¶: A unique name for the stack. It must start with an alphabetic character. Changing this updates the stack’s name.

notification_topics: pulumi.Output[list] = None¶: List of notification topics for stack.

outputs: pulumi.Output[list] = None¶

A list of stack outputs.

description (str) - The description of the stack resource.
outputKey (str)
outputValue (str)

parameters: pulumi.Output[dict] = None¶: User-defined key/value pairs as parameters to pass to the template. Changing this updates the existing stack parameters.

region: pulumi.Output[str] = None¶: The region in which to create the stack. If omitted, the region argument of the provider is used. Changing this creates a new stack.

status: pulumi.Output[str] = None¶: The status of the stack.

status_reason: pulumi.Output[str] = None¶: The reason for the current status of the stack.

tags: pulumi.Output[list] = None¶: A list of tags to assosciate with the Stack

template_description: pulumi.Output[str] = None¶: The description of the stack template.

template_opts: pulumi.Output[dict] = None¶: Template key/value pairs to associate with the stack which contains either the template file or url. Allowed keys: Bin, URL, Files. Changing this updates the existing stack Template Opts.

timeout: pulumi.Output[float] = None¶: The timeout for stack action in minutes.

updated_time: pulumi.Output[str] = None¶: The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.

static get(resource_name, id, opts=None, capabilities=None, creation_time=None, description=None, disable_rollback=None, environment_opts=None, name=None, notification_topics=None, outputs=None, parameters=None, region=None, status=None, status_reason=None, tags=None, template_description=None, template_opts=None, timeout=None, updated_time=None)¶

Get an existing StackV1 resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
capabilities (pulumi.Input[list]) – List of stack capabilities for stack.
creation_time (pulumi.Input[str]) – The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.
description (pulumi.Input[str]) – The description of the stack resource.
disable_rollback (pulumi.Input[bool]) – Enables or disables deletion of all stack resources when a stack creation fails. Default is true, meaning all resources are not deleted when stack creation fails.
environment_opts (pulumi.Input[dict]) – Environment key/value pairs to associate with the stack which contains details for the environment of the stack. Allowed keys: Bin, URL, Files. Changing this updates the existing stack Environment Opts.
name (pulumi.Input[str]) – A unique name for the stack. It must start with an alphabetic character. Changing this updates the stack’s name.
notification_topics (pulumi.Input[list]) – List of notification topics for stack.
outputs (pulumi.Input[list]) – A list of stack outputs.
parameters (pulumi.Input[dict]) – User-defined key/value pairs as parameters to pass to the template. Changing this updates the existing stack parameters.
region (pulumi.Input[str]) – The region in which to create the stack. If omitted, the region argument of the provider is used. Changing this creates a new stack.
status (pulumi.Input[str]) – The status of the stack.
status_reason (pulumi.Input[str]) – The reason for the current status of the stack.
tags (pulumi.Input[list]) – A list of tags to assosciate with the Stack
template_description (pulumi.Input[str]) – The description of the stack template.
template_opts (pulumi.Input[dict]) – Template key/value pairs to associate with the stack which contains either the template file or url. Allowed keys: Bin, URL, Files. Changing this updates the existing stack Template Opts.
timeout (pulumi.Input[float]) – The timeout for stack action in minutes.
updated_time (pulumi.Input[str]) – The date and time when the resource was updated. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm For example, 2015-08-27T09:49:58-05:00. The ±hh:mm value, if included, is the time zone as an offset from UTC.

The outputs object supports the following:

description (pulumi.Input[str]) - The description of the stack resource.
outputKey (pulumi.Input[str])
outputValue (pulumi.Input[str])

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

orchestration¶

On This Page