Class Instance

Inheritance

System.Object

Resource

CustomResource

Instance

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.OpenStack.Compute

Assembly: Pulumi.OpenStack.dll

Syntax

public class Instance : CustomResource

Constructors

Instance(String, InstanceArgs, CustomResourceOptions)

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

Declaration

public Instance(string name, InstanceArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
InstanceArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AccessIpV4

The first detected Fixed IPv4 address.

Declaration

public Output<string> AccessIpV4 { get; }

Property Value

Type	Description
Output<System.String>

AccessIpV6

The first detected Fixed IPv6 address.

Declaration

public Output<string> AccessIpV6 { get; }

Property Value

Type	Description
Output<System.String>

AdminPass

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

Declaration

public Output<string> AdminPass { get; }

Property Value

Type	Description
Output<System.String>

AllMetadata

Declaration

public Output<ImmutableDictionary<string, object>> AllMetadata { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

AllTags

The collection of tags assigned on the instance, which have been explicitly and implicitly added.

Declaration

public Output<ImmutableArray<string>> AllTags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

AvailabilityZone

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

Declaration

public Output<string> AvailabilityZone { get; }

Property Value

Type	Description
Output<System.String>

AvailabilityZoneHints

The availability zone in which to create the server. This argument is preferred to availability_zone, when scheduling the server on a particular host or node. Conflicts with availability_zone. Changing this creates a new server.

Declaration

public Output<string> AvailabilityZoneHints { get; }

Property Value

Type	Description
Output<System.String>

BlockDevices

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.

Declaration

public Output<ImmutableArray<InstanceBlockDevice>> BlockDevices { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<InstanceBlockDevice>>

ConfigDrive

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

Declaration

public Output<bool?> ConfigDrive { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

FlavorId

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

Declaration

public Output<string> FlavorId { get; }

Property Value

Type	Description
Output<System.String>

FlavorName

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

Declaration

public Output<string> FlavorName { get; }

Property Value

Type	Description
Output<System.String>

ForceDelete

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

Declaration

public Output<bool?> ForceDelete { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

ImageId

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

Declaration

public Output<string> ImageId { get; }

Property Value

Type	Description
Output<System.String>

ImageName

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

Declaration

public Output<string> ImageName { get; }

Property Value

Type	Description
Output<System.String>

KeyPair

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.

Declaration

public Output<string> KeyPair { get; }

Property Value

Type	Description
Output<System.String>

Metadata

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

Declaration

public Output<ImmutableDictionary<string, object>> Metadata { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Name

The human-readable name of the network. Changing this creates a new server.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Networks

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.

Declaration

public Output<ImmutableArray<InstanceNetwork>> Networks { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<InstanceNetwork>>

Personalities

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

Declaration

public Output<ImmutableArray<InstancePersonality>> Personalities { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<InstancePersonality>>

PowerState

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.

Declaration

public Output<string> PowerState { get; }

Property Value

Type	Description
Output<System.String>

Region

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.

Declaration

public Output<string> Region { get; }

Property Value

Type	Description
Output<System.String>

SchedulerHints

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

Declaration

public Output<ImmutableArray<InstanceSchedulerHint>> SchedulerHints { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<InstanceSchedulerHint>>

SecurityGroups

An array of one or more security group names or ids 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.

Declaration

public Output<ImmutableArray<string>> SecurityGroups { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

StopBeforeDestroy

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.

Declaration

public Output<bool?> StopBeforeDestroy { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Tags

A set of string tags for the instance. Changing this updates the existing instance tags.

Declaration

public Output<ImmutableArray<string>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

UserData

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

Declaration

public Output<string> UserData { get; }

Property Value

Type	Description
Output<System.String>

VendorOptions

Map of additional vendor-specific options. Supported options are described below.

Declaration

public Output<InstanceVendorOptions> VendorOptions { get; }

Property Value

Type	Description
Output<InstanceVendorOptions>

Methods

Get(String, Input<String>, InstanceState, CustomResourceOptions)

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

Declaration

public static Instance Get(string name, Input<string> id, InstanceState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
InstanceState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Instance