1. Docs
  2. Reference
  3. API
  4. @pulumi/openstack
  5. orchestration

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

Resources

Others

Resources

Resource StackV1

class StackV1 extends CustomResource

Manages a V1 stack resource within OpenStack.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const stack1 = new openstack.orchestration.StackV1("stack1", {
    disableRollback: true,
    environmentOpts: {
        Bin: "\n",
    },
    parameters: {
        length: 4,
    },
    templateOpts: {
        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,
});

constructor

new StackV1(name: string, args: StackV1Args, opts?: pulumi.CustomResourceOptions)

Create a StackV1 resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: StackV1State, opts?: pulumi.CustomResourceOptions): StackV1

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is StackV1

Returns true if the given object is an instance of StackV1. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property capabilities

public capabilities: pulumi.Output<string[]>;

List of stack capabilities for stack.

property creationTime

public creationTime: pulumi.Output<string>;

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.

property description

public description: pulumi.Output<string>;

The description of the stack resource.

property disableRollback

public disableRollback: pulumi.Output<boolean>;

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.

property environmentOpts

public environmentOpts: pulumi.Output<{[key: string]: any} | undefined>;

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.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

A unique name for the stack. It must start with an alphabetic character. Changing this updates the stack’s name.

property notificationTopics

public notificationTopics: pulumi.Output<string[]>;

List of notification topics for stack.

property outputs

public outputs: pulumi.Output<StackV1Output[]>;

A list of stack outputs.

property parameters

public parameters: pulumi.Output<{[key: string]: any} | undefined>;

User-defined key/value pairs as parameters to pass to the template. Changing this updates the existing stack parameters.

property region

public region: pulumi.Output<string>;

The region in which to create the stack. If omitted, the region argument of the provider is used. Changing this creates a new stack.

property status

public status: pulumi.Output<string>;

The status of the stack.

property statusReason

public statusReason: pulumi.Output<string>;

The reason for the current status of the stack.

property tags

public tags: pulumi.Output<string[]>;

A list of tags to assosciate with the Stack

property templateDescription

public templateDescription: pulumi.Output<string>;

The description of the stack template.

property templateOpts

public templateOpts: pulumi.Output<{[key: string]: any}>;

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.

property timeout

public timeout: pulumi.Output<number>;

The timeout for stack action in minutes.

property updatedTime

public updatedTime: pulumi.Output<string>;

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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface StackV1Args

interface StackV1Args

The set of arguments for constructing a StackV1 resource.

property capabilities

capabilities?: pulumi.Input<pulumi.Input<string>[]>;

List of stack capabilities for stack.

property creationTime

creationTime?: pulumi.Input<string>;

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.

property description

description?: pulumi.Input<string>;

The description of the stack resource.

property disableRollback

disableRollback?: pulumi.Input<boolean>;

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.

property environmentOpts

environmentOpts?: pulumi.Input<{[key: string]: any}>;

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.

property name

name?: pulumi.Input<string>;

A unique name for the stack. It must start with an alphabetic character. Changing this updates the stack’s name.

property notificationTopics

notificationTopics?: pulumi.Input<pulumi.Input<string>[]>;

List of notification topics for stack.

property outputs

outputs?: pulumi.Input<pulumi.Input<StackV1Output>[]>;

A list of stack outputs.

property parameters

parameters?: pulumi.Input<{[key: string]: any}>;

User-defined key/value pairs as parameters to pass to the template. Changing this updates the existing stack parameters.

property region

region?: pulumi.Input<string>;

The region in which to create the stack. If omitted, the region argument of the provider is used. Changing this creates a new stack.

property status

status?: pulumi.Input<string>;

The status of the stack.

property statusReason

statusReason?: pulumi.Input<string>;

The reason for the current status of the stack.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A list of tags to assosciate with the Stack

property templateDescription

templateDescription?: pulumi.Input<string>;

The description of the stack template.

property templateOpts

templateOpts: pulumi.Input<{[key: string]: any}>;

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.

property timeout

timeout?: pulumi.Input<number>;

The timeout for stack action in minutes.

property updatedTime

updatedTime?: pulumi.Input<string>;

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.

interface StackV1State

interface StackV1State

Input properties used for looking up and filtering StackV1 resources.

property capabilities

capabilities?: pulumi.Input<pulumi.Input<string>[]>;

List of stack capabilities for stack.

property creationTime

creationTime?: pulumi.Input<string>;

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.

property description

description?: pulumi.Input<string>;

The description of the stack resource.

property disableRollback

disableRollback?: pulumi.Input<boolean>;

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.

property environmentOpts

environmentOpts?: pulumi.Input<{[key: string]: any}>;

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.

property name

name?: pulumi.Input<string>;

A unique name for the stack. It must start with an alphabetic character. Changing this updates the stack’s name.

property notificationTopics

notificationTopics?: pulumi.Input<pulumi.Input<string>[]>;

List of notification topics for stack.

property outputs

outputs?: pulumi.Input<pulumi.Input<StackV1Output>[]>;

A list of stack outputs.

property parameters

parameters?: pulumi.Input<{[key: string]: any}>;

User-defined key/value pairs as parameters to pass to the template. Changing this updates the existing stack parameters.

property region

region?: pulumi.Input<string>;

The region in which to create the stack. If omitted, the region argument of the provider is used. Changing this creates a new stack.

property status

status?: pulumi.Input<string>;

The status of the stack.

property statusReason

statusReason?: pulumi.Input<string>;

The reason for the current status of the stack.

property tags

tags?: pulumi.Input<pulumi.Input<string>[]>;

A list of tags to assosciate with the Stack

property templateDescription

templateDescription?: pulumi.Input<string>;

The description of the stack template.

property templateOpts

templateOpts?: pulumi.Input<{[key: string]: any}>;

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.

property timeout

timeout?: pulumi.Input<number>;

The timeout for stack action in minutes.

property updatedTime

updatedTime?: pulumi.Input<string>;

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.