Fork me on GitHub

Module compute

@pulumi/openstack > compute

Index

compute/flavor.ts compute/floatingIp.ts compute/floatingIpAssociate.ts compute/getFlavor.ts compute/getKeypair.ts compute/instance.ts compute/keypair.ts compute/secGroup.ts compute/serverGroup.ts compute/volumeAttach.ts

class Flavor

Manages a V2 flavor resource within OpenStack.

constructor

new Flavor(name: string, args: FlavorArgs, opts?: pulumi.CustomResourceOptions)

Create a Flavor 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?: FlavorState): Flavor

Get an existing Flavor 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

static isInstance(obj: any): boolean

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

property disk

public disk: pulumi.Output<number>;

The amount of disk space in gigabytes to use for the root (/) partition. Changing this creates a new flavor.

property ephemeral

public ephemeral: pulumi.Output<number | undefined>;

property extraSpecs

public extraSpecs: pulumi.Output<{ ... }>;

Key/Value pairs of metadata for the flavor.

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 isPublic

public isPublic: pulumi.Output<boolean | undefined>;

Whether the flavor is public. Changing this creates a new flavor.

property name

public name: pulumi.Output<string>;

A unique name for the flavor. Changing this creates a new flavor.

property ram

public ram: pulumi.Output<number>;

The amount of RAM to use, in megabytes. Changing this creates a new flavor.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Compute client. Flavors are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new flavor.

property rxTxFactor

public rxTxFactor: pulumi.Output<number | undefined>;

RX/TX bandwith factor. The default is 1. Changing this creates a new flavor.

property swap

public swap: pulumi.Output<number | undefined>;

The amount of disk space in megabytes to use. If unspecified, the default is 0. Changing this creates a new flavor.

property urn

urn: Output<URN>;

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

property vcpus

public vcpus: pulumi.Output<number>;

The number of virtual CPUs to use. Changing this creates a new flavor.

class FloatingIp

Manages a V2 floating IP resource within OpenStack Nova (compute) that can be used for compute instances.

Please note that managing floating IPs through the OpenStack Compute API has been deprecated. Unless you are using an older OpenStack environment, it is recommended to use the openstack_networking_floatingip_v2 resource instead, which uses the OpenStack Networking API.

constructor

new FloatingIp(name: string, args: FloatingIpArgs, opts?: pulumi.CustomResourceOptions)

Create a FloatingIp 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?: FloatingIpState): FloatingIp

Get an existing FloatingIp 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

static isInstance(obj: any): boolean

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

property address

public address: pulumi.Output<string>;

The actual floating IP address itself.

property fixedIp

public fixedIp: pulumi.Output<string>;

The fixed IP address corresponding to the floating IP.

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 instanceId

public instanceId: pulumi.Output<string>;

UUID of the compute instance associated with the floating IP.

property pool

public pool: pulumi.Output<string>;

The name of the pool from which to obtain the floating IP. Changing this creates a new floating IP.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Compute client. A Compute client is needed to create a floating IP that can be used with a compute instance. If omitted, the region argument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).

property urn

urn: Output<URN>;

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

class FloatingIpAssociate

Associate a floating IP to an instance. This can be used instead of the floating_ip options in openstack_compute_instance_v2.

constructor

new FloatingIpAssociate(name: string, args: FloatingIpAssociateArgs, opts?: pulumi.CustomResourceOptions)

Create a FloatingIpAssociate 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?: FloatingIpAssociateState): FloatingIpAssociate

Get an existing FloatingIpAssociate 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

static isInstance(obj: any): boolean

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

property fixedIp

public fixedIp: pulumi.Output<string | undefined>;

The specific IP address to direct traffic to.

property floatingIp

public floatingIp: pulumi.Output<string>;

The floating IP to associate.

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 instanceId

public instanceId: pulumi.Output<string>;

The instance to associte the floating IP with.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Compute client. Keypairs are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new floatingip_associate.

property urn

urn: Output<URN>;

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

property waitUntilAssociated

public waitUntilAssociated: pulumi.Output<boolean | undefined>;

In cases where the OpenStack environment does not automatically wait until the association has finished, set this option to have Terraform poll the instance until the floating IP has been associated. Defaults to false.

class Instance

Manages a V2 VM instance resource within OpenStack.

constructor

new Instance(name: string, args?: InstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a Instance 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?: InstanceState): Instance

Get an existing Instance 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

static isInstance(obj: any): boolean

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

property accessIpV4

public accessIpV4: pulumi.Output<string>;

The first detected Fixed IPv4 address or the Floating IP.

property accessIpV6

public accessIpV6: pulumi.Output<string>;

The first detected Fixed IPv6 address.

property adminPass

public adminPass: pulumi.Output<string | undefined>;

The administrative password to assign to the server. Changing this changes the root password on the existing server.

property allMetadata

public allMetadata: pulumi.Output<{ ... }>;

Contains all instance metadata, even metadata not set by Terraform.

property availabilityZone

public availabilityZone: pulumi.Output<string>;

The availability zone in which to create the server. Changing this creates a new server.

property blockDevices

public blockDevices: pulumi.Output<{ ... }[] | undefined>;

Configuration of block devices. The block_device structure is documented below. Changing this creates a new server. You can specify multiple block devices which will create an instance with multiple disks. This configuration is very flexible, so please see the following reference for more information.

property configDrive

public configDrive: pulumi.Output<boolean | undefined>;

Whether to use the config_drive feature to configure the instance. Changing this creates a new server.

property flavorId

public flavorId: pulumi.Output<string>;

The flavor ID of the desired flavor for the server. Changing this resizes the existing server.

property flavorName

public flavorName: pulumi.Output<string>;

The name of the desired flavor for the server. Changing this resizes the existing server.

property forceDelete

public forceDelete: pulumi.Output<boolean | undefined>;

Whether to force the OpenStack instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.

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 imageId

public imageId: pulumi.Output<string>;

(Optional; Required if image_name is empty and not booting from a volume. Do not specify if booting from a volume.) The image ID of the desired image for the server. Changing this creates a new server.

property imageName

public imageName: pulumi.Output<string>;

(Optional; Required if image_id is empty and not booting from a volume. Do not specify if booting from a volume.) The name of the desired image for the server. Changing this creates a new server.

property keyPair

public keyPair: pulumi.Output<string | undefined>;

The name of a key pair to put on the server. The key pair must already be created and associated with the tenant’s account. Changing this creates a new server.

property metadata

public metadata: pulumi.Output<{ ... } | undefined>;

Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.

property name

public name: pulumi.Output<string>;

A unique name for the resource.

property networks

public networks: pulumi.Output<{ ... }[]>;

An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new server.

property personalities

public personalities: pulumi.Output<{ ... }[] | undefined>;

Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below.

property powerState

public powerState: pulumi.Output<string | undefined>;

Provide the VM state. Only ‘active’ and ‘shutoff’ are supported values. Note: If the initial power_state is the shutoff the VM will be stopped immediately after build and the provisioners like remote-exec or files are not supported.

property region

public region: pulumi.Output<string>;

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

property schedulerHints

public schedulerHints: pulumi.Output<{ ... }[] | undefined>;

Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.

property securityGroups

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

An array of one or more security group names to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance.

property stopBeforeDestroy

public stopBeforeDestroy: pulumi.Output<boolean | undefined>;

Whether to try stop instance gracefully before destroying it, thus giving chance for guest OS daemons to stop correctly. If instance doesn’t stop within timeout, it will be destroyed anyway.

property urn

urn: Output<URN>;

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

property userData

public userData: pulumi.Output<string | undefined>;

The user data to provide when launching the instance. Changing this creates a new server.

class Keypair

Manages a V2 keypair resource within OpenStack.

~> Important Security Notice The private key generated by this resource will be stored unencrypted in your Terraform state file. Use of this resource for production deployments is not recommended. Instead, generate a private key file outside of Terraform and distribute it securely to the system where Terraform will be run.

constructor

new Keypair(name: string, args?: KeypairArgs, opts?: pulumi.CustomResourceOptions)

Create a Keypair 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?: KeypairState): Keypair

Get an existing Keypair 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

static isInstance(obj: any): boolean

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

property fingerprint

public fingerprint: pulumi.Output<string>;

The fingerprint of the public key.

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 keypair. Changing this creates a new keypair.

property privateKey

public privateKey: pulumi.Output<string>;

The generated private key when no public key is specified.

property publicKey

public publicKey: pulumi.Output<string>;

A pregenerated OpenSSH-formatted public key. Changing this creates a new keypair. If a public key is not specified, then a public/private key pair will be automatically generated. If a pair is created, then destroying this resource means you will lose access to that keypair forever.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Compute client. Keypairs are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new keypair.

property urn

urn: Output<URN>;

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

property valueSpecs

public valueSpecs: pulumi.Output<{ ... } | undefined>;

Map of additional options.

class SecGroup

Manages a V2 security group resource within OpenStack.

Please note that managing security groups through the OpenStack Compute API has been deprecated. Unless you are using an older OpenStack environment, it is recommended to use the openstack_networking_secgroup_v2 and openstack_networking_secgroup_rule_v2 resources instead, which uses the OpenStack Networking API.

constructor

new SecGroup(name: string, args: SecGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a SecGroup 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?: SecGroupState): SecGroup

Get an existing SecGroup 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

static isInstance(obj: any): boolean

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

property description

public description: pulumi.Output<string>;

A description for the security group. Changing this updates the description of an existing security group.

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 security group. Changing this updates the name of an existing security group.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Compute client. A Compute client is needed to create a security group. If omitted, the region argument of the provider is used. Changing this creates a new security group.

property rules

public rules: pulumi.Output<{ ... }[]>;

A rule describing how the security group operates. The rule object structure is documented below. Changing this updates the security group rules. As shown in the example above, multiple rule blocks may be used.

property urn

urn: Output<URN>;

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

class ServerGroup

Manages a V2 Server Group resource within OpenStack.

constructor

new ServerGroup(name: string, args?: ServerGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ServerGroup 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?: ServerGroupState): ServerGroup

Get an existing ServerGroup 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

static isInstance(obj: any): boolean

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

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 members

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

The instances that are part of this server group.

property name

public name: pulumi.Output<string>;

A unique name for the server group. Changing this creates a new server group.

property policies

public policies: pulumi.Output<string[] | undefined>;

The set of policies for the server group. Only two two policies are available right now, and both are mutually exclusive. See the Policies section for more information. Changing this creates a new server group.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Compute client. If omitted, the region argument of the provider is used. Changing this creates a new server group.

property urn

urn: Output<URN>;

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

property valueSpecs

public valueSpecs: pulumi.Output<{ ... } | undefined>;

Map of additional options.

class VolumeAttach

Attaches a Block Storage Volume to an Instance using the OpenStack Compute (Nova) v2 API.

constructor

new VolumeAttach(name: string, args: VolumeAttachArgs, opts?: pulumi.CustomResourceOptions)

Create a VolumeAttach 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?: VolumeAttachState): VolumeAttach

Get an existing VolumeAttach 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

static isInstance(obj: any): boolean

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

property device

public device: pulumi.Output<string>;

The device of the volume attachment (ex: /dev/vdc). NOTE: Being able to specify a device is dependent upon the hypervisor in use. There is a chance that the device specified in Terraform will not be the same device the hypervisor chose. If this happens, Terraform will wish to update the device upon subsequent applying which will cause the volume to be detached and reattached indefinitely. Please use with caution.

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 instanceId

public instanceId: pulumi.Output<string>;

The ID of the Instance to attach the Volume to.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Compute client. A Compute client is needed to create a volume attachment. If omitted, the region argument of the provider is used. Changing this creates a new volume attachment.

property urn

urn: Output<URN>;

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

property volumeId

public volumeId: pulumi.Output<string>;

The ID of the Volume to attach to an Instance.

function getFlavor

getFlavor(args?: GetFlavorArgs, opts?: pulumi.InvokeOptions): Promise<GetFlavorResult>

Use this data source to get the ID of an available OpenStack flavor.

function getKeypair

getKeypair(args: GetKeypairArgs, opts?: pulumi.InvokeOptions): Promise<GetKeypairResult>

Use this data source to get the ID and public key of an OpenStack keypair.

interface FlavorArgs

The set of arguments for constructing a Flavor resource.

property disk

disk: pulumi.Input<number>;

The amount of disk space in gigabytes to use for the root (/) partition. Changing this creates a new flavor.

property ephemeral

ephemeral?: pulumi.Input<number>;

property extraSpecs

extraSpecs?: pulumi.Input<{ ... }>;

Key/Value pairs of metadata for the flavor.

property isPublic

isPublic?: pulumi.Input<boolean>;

Whether the flavor is public. Changing this creates a new flavor.

property name

name?: pulumi.Input<string>;

A unique name for the flavor. Changing this creates a new flavor.

property ram

ram: pulumi.Input<number>;

The amount of RAM to use, in megabytes. Changing this creates a new flavor.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Compute client. Flavors are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new flavor.

property rxTxFactor

rxTxFactor?: pulumi.Input<number>;

RX/TX bandwith factor. The default is 1. Changing this creates a new flavor.

property swap

swap?: pulumi.Input<number>;

The amount of disk space in megabytes to use. If unspecified, the default is 0. Changing this creates a new flavor.

property vcpus

vcpus: pulumi.Input<number>;

The number of virtual CPUs to use. Changing this creates a new flavor.

interface FlavorState

Input properties used for looking up and filtering Flavor resources.

property disk

disk?: pulumi.Input<number>;

The amount of disk space in gigabytes to use for the root (/) partition. Changing this creates a new flavor.

property ephemeral

ephemeral?: pulumi.Input<number>;

property extraSpecs

extraSpecs?: pulumi.Input<{ ... }>;

Key/Value pairs of metadata for the flavor.

property isPublic

isPublic?: pulumi.Input<boolean>;

Whether the flavor is public. Changing this creates a new flavor.

property name

name?: pulumi.Input<string>;

A unique name for the flavor. Changing this creates a new flavor.

property ram

ram?: pulumi.Input<number>;

The amount of RAM to use, in megabytes. Changing this creates a new flavor.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Compute client. Flavors are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new flavor.

property rxTxFactor

rxTxFactor?: pulumi.Input<number>;

RX/TX bandwith factor. The default is 1. Changing this creates a new flavor.

property swap

swap?: pulumi.Input<number>;

The amount of disk space in megabytes to use. If unspecified, the default is 0. Changing this creates a new flavor.

property vcpus

vcpus?: pulumi.Input<number>;

The number of virtual CPUs to use. Changing this creates a new flavor.

interface FloatingIpArgs

The set of arguments for constructing a FloatingIp resource.

property pool

pool: pulumi.Input<string>;

The name of the pool from which to obtain the floating IP. Changing this creates a new floating IP.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Compute client. A Compute client is needed to create a floating IP that can be used with a compute instance. If omitted, the region argument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).

interface FloatingIpAssociateArgs

The set of arguments for constructing a FloatingIpAssociate resource.

property fixedIp

fixedIp?: pulumi.Input<string>;

The specific IP address to direct traffic to.

property floatingIp

floatingIp: pulumi.Input<string>;

The floating IP to associate.

property instanceId

instanceId: pulumi.Input<string>;

The instance to associte the floating IP with.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Compute client. Keypairs are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new floatingip_associate.

property waitUntilAssociated

waitUntilAssociated?: pulumi.Input<boolean>;

In cases where the OpenStack environment does not automatically wait until the association has finished, set this option to have Terraform poll the instance until the floating IP has been associated. Defaults to false.

interface FloatingIpAssociateState

Input properties used for looking up and filtering FloatingIpAssociate resources.

property fixedIp

fixedIp?: pulumi.Input<string>;

The specific IP address to direct traffic to.

property floatingIp

floatingIp?: pulumi.Input<string>;

The floating IP to associate.

property instanceId

instanceId?: pulumi.Input<string>;

The instance to associte the floating IP with.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Compute client. Keypairs are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new floatingip_associate.

property waitUntilAssociated

waitUntilAssociated?: pulumi.Input<boolean>;

In cases where the OpenStack environment does not automatically wait until the association has finished, set this option to have Terraform poll the instance until the floating IP has been associated. Defaults to false.

interface FloatingIpState

Input properties used for looking up and filtering FloatingIp resources.

property address

address?: pulumi.Input<string>;

The actual floating IP address itself.

property fixedIp

fixedIp?: pulumi.Input<string>;

The fixed IP address corresponding to the floating IP.

property instanceId

instanceId?: pulumi.Input<string>;

UUID of the compute instance associated with the floating IP.

property pool

pool?: pulumi.Input<string>;

The name of the pool from which to obtain the floating IP. Changing this creates a new floating IP.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Compute client. A Compute client is needed to create a floating IP that can be used with a compute instance. If omitted, the region argument of the provider is used. Changing this creates a new floating IP (which may or may not have a different address).

interface GetFlavorArgs

A collection of arguments for invoking getFlavor.

property disk

disk?: number;

The exact amount of disk (in gigabytes).

property minDisk

minDisk?: number;

The minimum amount of disk (in gigabytes).

property minRam

minRam?: number;

The minimum amount of RAM (in megabytes).

property name

name?: string;

The name of the flavor.

property ram

ram?: number;

The exact amount of RAM (in megabytes).

property region

region?: string;

The region in which to obtain the V2 Compute client. If omitted, the region argument of the provider is used.

property rxTxFactor

rxTxFactor?: number;

The rx_tx_factor of the flavor.

property swap

swap?: number;

The amount of swap (in gigabytes).

property vcpus

vcpus?: number;

The amount of VCPUs.

interface GetFlavorResult

A collection of values returned by getFlavor.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property isPublic

isPublic: boolean;

Whether the flavor is public or private.

property region

region: string;

interface GetKeypairArgs

A collection of arguments for invoking getKeypair.

property name

name: string;

The unique name of the keypair.

property region

region?: string;

The region in which to obtain the V2 Compute client. If omitted, the region argument of the provider is used.

interface GetKeypairResult

A collection of values returned by getKeypair.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property publicKey

publicKey: string;

The OpenSSH-formatted public key of the keypair.

property region

region: string;

See Argument Reference above.

interface InstanceArgs

The set of arguments for constructing a Instance resource.

property accessIpV4

accessIpV4?: pulumi.Input<string>;

The first detected Fixed IPv4 address or the Floating IP.

property accessIpV6

accessIpV6?: pulumi.Input<string>;

The first detected Fixed IPv6 address.

property adminPass

adminPass?: pulumi.Input<string>;

The administrative password to assign to the server. Changing this changes the root password on the existing server.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The availability zone in which to create the server. Changing this creates a new server.

property blockDevices

blockDevices?: pulumi.Input<pulumi.Input<{ ... }>[]>;

Configuration of block devices. The block_device structure is documented below. Changing this creates a new server. You can specify multiple block devices which will create an instance with multiple disks. This configuration is very flexible, so please see the following reference for more information.

property configDrive

configDrive?: pulumi.Input<boolean>;

Whether to use the config_drive feature to configure the instance. Changing this creates a new server.

property flavorId

flavorId?: pulumi.Input<string>;

The flavor ID of the desired flavor for the server. Changing this resizes the existing server.

property flavorName

flavorName?: pulumi.Input<string>;

The name of the desired flavor for the server. Changing this resizes the existing server.

property forceDelete

forceDelete?: pulumi.Input<boolean>;

Whether to force the OpenStack instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.

property imageId

imageId?: pulumi.Input<string>;

(Optional; Required if image_name is empty and not booting from a volume. Do not specify if booting from a volume.) The image ID of the desired image for the server. Changing this creates a new server.

property imageName

imageName?: pulumi.Input<string>;

(Optional; Required if image_id is empty and not booting from a volume. Do not specify if booting from a volume.) The name of the desired image for the server. Changing this creates a new server.

property keyPair

keyPair?: pulumi.Input<string>;

The name of a key pair to put on the server. The key pair must already be created and associated with the tenant’s account. Changing this creates a new server.

property metadata

metadata?: pulumi.Input<{ ... }>;

Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.

property name

name?: pulumi.Input<string>;

A unique name for the resource.

property networks

networks?: pulumi.Input<pulumi.Input<{ ... }>[]>;

An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new server.

property personalities

personalities?: pulumi.Input<pulumi.Input<{ ... }>[]>;

Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below.

property powerState

powerState?: pulumi.Input<string>;

Provide the VM state. Only ‘active’ and ‘shutoff’ are supported values. Note: If the initial power_state is the shutoff the VM will be stopped immediately after build and the provisioners like remote-exec or files are not supported.

property region

region?: pulumi.Input<string>;

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

property schedulerHints

schedulerHints?: pulumi.Input<pulumi.Input<{ ... }>[]>;

Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.

property securityGroups

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

An array of one or more security group names to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance.

property stopBeforeDestroy

stopBeforeDestroy?: pulumi.Input<boolean>;

Whether to try stop instance gracefully before destroying it, thus giving chance for guest OS daemons to stop correctly. If instance doesn’t stop within timeout, it will be destroyed anyway.

property userData

userData?: pulumi.Input<string>;

The user data to provide when launching the instance. Changing this creates a new server.

interface InstanceState

Input properties used for looking up and filtering Instance resources.

property accessIpV4

accessIpV4?: pulumi.Input<string>;

The first detected Fixed IPv4 address or the Floating IP.

property accessIpV6

accessIpV6?: pulumi.Input<string>;

The first detected Fixed IPv6 address.

property adminPass

adminPass?: pulumi.Input<string>;

The administrative password to assign to the server. Changing this changes the root password on the existing server.

property allMetadata

allMetadata?: pulumi.Input<{ ... }>;

Contains all instance metadata, even metadata not set by Terraform.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The availability zone in which to create the server. Changing this creates a new server.

property blockDevices

blockDevices?: pulumi.Input<pulumi.Input<{ ... }>[]>;

Configuration of block devices. The block_device structure is documented below. Changing this creates a new server. You can specify multiple block devices which will create an instance with multiple disks. This configuration is very flexible, so please see the following reference for more information.

property configDrive

configDrive?: pulumi.Input<boolean>;

Whether to use the config_drive feature to configure the instance. Changing this creates a new server.

property flavorId

flavorId?: pulumi.Input<string>;

The flavor ID of the desired flavor for the server. Changing this resizes the existing server.

property flavorName

flavorName?: pulumi.Input<string>;

The name of the desired flavor for the server. Changing this resizes the existing server.

property forceDelete

forceDelete?: pulumi.Input<boolean>;

Whether to force the OpenStack instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.

property imageId

imageId?: pulumi.Input<string>;

(Optional; Required if image_name is empty and not booting from a volume. Do not specify if booting from a volume.) The image ID of the desired image for the server. Changing this creates a new server.

property imageName

imageName?: pulumi.Input<string>;

(Optional; Required if image_id is empty and not booting from a volume. Do not specify if booting from a volume.) The name of the desired image for the server. Changing this creates a new server.

property keyPair

keyPair?: pulumi.Input<string>;

The name of a key pair to put on the server. The key pair must already be created and associated with the tenant’s account. Changing this creates a new server.

property metadata

metadata?: pulumi.Input<{ ... }>;

Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.

property name

name?: pulumi.Input<string>;

A unique name for the resource.

property networks

networks?: pulumi.Input<pulumi.Input<{ ... }>[]>;

An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new server.

property personalities

personalities?: pulumi.Input<pulumi.Input<{ ... }>[]>;

Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below.

property powerState

powerState?: pulumi.Input<string>;

Provide the VM state. Only ‘active’ and ‘shutoff’ are supported values. Note: If the initial power_state is the shutoff the VM will be stopped immediately after build and the provisioners like remote-exec or files are not supported.

property region

region?: pulumi.Input<string>;

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

property schedulerHints

schedulerHints?: pulumi.Input<pulumi.Input<{ ... }>[]>;

Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.

property securityGroups

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

An array of one or more security group names to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance.

property stopBeforeDestroy

stopBeforeDestroy?: pulumi.Input<boolean>;

Whether to try stop instance gracefully before destroying it, thus giving chance for guest OS daemons to stop correctly. If instance doesn’t stop within timeout, it will be destroyed anyway.

property userData

userData?: pulumi.Input<string>;

The user data to provide when launching the instance. Changing this creates a new server.

interface KeypairArgs

The set of arguments for constructing a Keypair resource.

property name

name?: pulumi.Input<string>;

A unique name for the keypair. Changing this creates a new keypair.

property publicKey

publicKey?: pulumi.Input<string>;

A pregenerated OpenSSH-formatted public key. Changing this creates a new keypair. If a public key is not specified, then a public/private key pair will be automatically generated. If a pair is created, then destroying this resource means you will lose access to that keypair forever.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Compute client. Keypairs are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new keypair.

property valueSpecs

valueSpecs?: pulumi.Input<{ ... }>;

Map of additional options.

interface KeypairState

Input properties used for looking up and filtering Keypair resources.

property fingerprint

fingerprint?: pulumi.Input<string>;

The fingerprint of the public key.

property name

name?: pulumi.Input<string>;

A unique name for the keypair. Changing this creates a new keypair.

property privateKey

privateKey?: pulumi.Input<string>;

The generated private key when no public key is specified.

property publicKey

publicKey?: pulumi.Input<string>;

A pregenerated OpenSSH-formatted public key. Changing this creates a new keypair. If a public key is not specified, then a public/private key pair will be automatically generated. If a pair is created, then destroying this resource means you will lose access to that keypair forever.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Compute client. Keypairs are associated with accounts, but a Compute client is needed to create one. If omitted, the region argument of the provider is used. Changing this creates a new keypair.

property valueSpecs

valueSpecs?: pulumi.Input<{ ... }>;

Map of additional options.

interface SecGroupArgs

The set of arguments for constructing a SecGroup resource.

property description

description: pulumi.Input<string>;

A description for the security group. Changing this updates the description of an existing security group.

property name

name?: pulumi.Input<string>;

A unique name for the security group. Changing this updates the name of an existing security group.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Compute client. A Compute client is needed to create a security group. If omitted, the region argument of the provider is used. Changing this creates a new security group.

property rules

rules?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A rule describing how the security group operates. The rule object structure is documented below. Changing this updates the security group rules. As shown in the example above, multiple rule blocks may be used.

interface SecGroupState

Input properties used for looking up and filtering SecGroup resources.

property description

description?: pulumi.Input<string>;

A description for the security group. Changing this updates the description of an existing security group.

property name

name?: pulumi.Input<string>;

A unique name for the security group. Changing this updates the name of an existing security group.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Compute client. A Compute client is needed to create a security group. If omitted, the region argument of the provider is used. Changing this creates a new security group.

property rules

rules?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A rule describing how the security group operates. The rule object structure is documented below. Changing this updates the security group rules. As shown in the example above, multiple rule blocks may be used.

interface ServerGroupArgs

The set of arguments for constructing a ServerGroup resource.

property name

name?: pulumi.Input<string>;

A unique name for the server group. Changing this creates a new server group.

property policies

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

The set of policies for the server group. Only two two policies are available right now, and both are mutually exclusive. See the Policies section for more information. Changing this creates a new server group.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Compute client. If omitted, the region argument of the provider is used. Changing this creates a new server group.

property valueSpecs

valueSpecs?: pulumi.Input<{ ... }>;

Map of additional options.

interface ServerGroupState

Input properties used for looking up and filtering ServerGroup resources.

property members

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

The instances that are part of this server group.

property name

name?: pulumi.Input<string>;

A unique name for the server group. Changing this creates a new server group.

property policies

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

The set of policies for the server group. Only two two policies are available right now, and both are mutually exclusive. See the Policies section for more information. Changing this creates a new server group.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Compute client. If omitted, the region argument of the provider is used. Changing this creates a new server group.

property valueSpecs

valueSpecs?: pulumi.Input<{ ... }>;

Map of additional options.

interface VolumeAttachArgs

The set of arguments for constructing a VolumeAttach resource.

property device

device?: pulumi.Input<string>;

The device of the volume attachment (ex: /dev/vdc). NOTE: Being able to specify a device is dependent upon the hypervisor in use. There is a chance that the device specified in Terraform will not be the same device the hypervisor chose. If this happens, Terraform will wish to update the device upon subsequent applying which will cause the volume to be detached and reattached indefinitely. Please use with caution.

property instanceId

instanceId: pulumi.Input<string>;

The ID of the Instance to attach the Volume to.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Compute client. A Compute client is needed to create a volume attachment. If omitted, the region argument of the provider is used. Changing this creates a new volume attachment.

property volumeId

volumeId: pulumi.Input<string>;

The ID of the Volume to attach to an Instance.

interface VolumeAttachState

Input properties used for looking up and filtering VolumeAttach resources.

property device

device?: pulumi.Input<string>;

The device of the volume attachment (ex: /dev/vdc). NOTE: Being able to specify a device is dependent upon the hypervisor in use. There is a chance that the device specified in Terraform will not be the same device the hypervisor chose. If this happens, Terraform will wish to update the device upon subsequent applying which will cause the volume to be detached and reattached indefinitely. Please use with caution.

property instanceId

instanceId?: pulumi.Input<string>;

The ID of the Instance to attach the Volume to.

property region

region?: pulumi.Input<string>;

The region in which to obtain the V2 Compute client. A Compute client is needed to create a volume attachment. If omitted, the region argument of the provider is used. Changing this creates a new volume attachment.

property volumeId

volumeId?: pulumi.Input<string>;

The ID of the Volume to attach to an Instance.