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

Package @pulumi/openstack

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.

var openstack = require("@pulumi/openstack");

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

Modules

Resources

Others

Resources

Resource Provider

class Provider extends ProviderResource

The provider type for the openstack package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

constructor

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider 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 getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

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

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

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

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 urn

urn: Output<URN>;

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

Others

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

function getVersion

getVersion(): string

interface ProviderArgs

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property allowReauth

allowReauth?: pulumi.Input<boolean>;

If set to false, OpenStack authorization won’t be perfomed automatically, if the initial auth token get expired. Defaults to true

property applicationCredentialId

applicationCredentialId?: pulumi.Input<string>;

Application Credential ID to login with.

property applicationCredentialName

applicationCredentialName?: pulumi.Input<string>;

Application Credential name to login with.

property applicationCredentialSecret

applicationCredentialSecret?: pulumi.Input<string>;

Application Credential secret to login with.

property authUrl

authUrl?: pulumi.Input<string>;

The Identity authentication URL.

property cacertFile

cacertFile?: pulumi.Input<string>;

A Custom CA certificate.

property cert

cert?: pulumi.Input<string>;

A client certificate to authenticate with.

property cloud

cloud?: pulumi.Input<string>;

An entry in a clouds.yaml file to use.

property defaultDomain

defaultDomain?: pulumi.Input<string>;

The name of the Domain ID to scope to if no other domain is specified. Defaults to default (Identity v3).

property delayedAuth

delayedAuth?: pulumi.Input<boolean>;

If set to false, OpenStack authorization will be perfomed, every time the service provider client is called. Defaults to true.

property disableNoCacheHeader

disableNoCacheHeader?: pulumi.Input<boolean>;

If set to true, the HTTP Cache-Control: no-cache header will not be added by default to all API requests.

property domainId

domainId?: pulumi.Input<string>;

The ID of the Domain to scope to (Identity v3).

property domainName

domainName?: pulumi.Input<string>;

The name of the Domain to scope to (Identity v3).

property endpointOverrides

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

A map of services with an endpoint to override what was from the Keystone catalog

property endpointType

endpointType?: pulumi.Input<string>;

property insecure

insecure?: pulumi.Input<boolean>;

Trust self-signed certificates.

property key

key?: pulumi.Input<string>;

A client private key to authenticate with.

property maxRetries

maxRetries?: pulumi.Input<number>;

How many times HTTP connection should be retried until giving up.

property password

password?: pulumi.Input<string>;

Password to login with.

property projectDomainId

projectDomainId?: pulumi.Input<string>;

The ID of the domain where the proejct resides (Identity v3).

property projectDomainName

projectDomainName?: pulumi.Input<string>;

The name of the domain where the project resides (Identity v3).

property region

region?: pulumi.Input<string>;

The OpenStack region to connect to.

property swauth

swauth?: pulumi.Input<boolean>;

Use Swift’s authentication system instead of Keystone. Only used for interaction with Swift.

property tenantId

tenantId?: pulumi.Input<string>;

The ID of the Tenant (Identity v2) or Project (Identity v3) to login with.

property tenantName

tenantName?: pulumi.Input<string>;

The name of the Tenant (Identity v2) or Project (Identity v3) to login with.

property token

token?: pulumi.Input<string>;

Authentication token to use as an alternative to username/password.

property useOctavia

useOctavia?: pulumi.Input<boolean>;

If set to true, API requests will go the Load Balancer service (Octavia) instead of the Networking service (Neutron).

property userDomainId

userDomainId?: pulumi.Input<string>;

The ID of the domain where the user resides (Identity v3).

property userDomainName

userDomainName?: pulumi.Input<string>;

The name of the domain where the user resides (Identity v3).

property userId

userId?: pulumi.Input<string>;

Username to login with.

property userName

userName?: pulumi.Input<string>;

Username to login with.