OpenStack v4.1.3 published on Wednesday, Aug 21, 2024 by Pulumi
openstack.compute.Instance
Explore with Pulumi AI
Create Instance Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Instance(name: string, args?: InstanceArgs, opts?: CustomResourceOptions);
@overload
def Instance(resource_name: str,
args: Optional[InstanceArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Instance(resource_name: str,
opts: Optional[ResourceOptions] = None,
access_ip_v4: Optional[str] = None,
access_ip_v6: Optional[str] = None,
admin_pass: Optional[str] = None,
availability_zone: Optional[str] = None,
availability_zone_hints: Optional[str] = None,
block_devices: Optional[Sequence[InstanceBlockDeviceArgs]] = None,
config_drive: Optional[bool] = None,
flavor_id: Optional[str] = None,
flavor_name: Optional[str] = None,
force_delete: Optional[bool] = None,
image_id: Optional[str] = None,
image_name: Optional[str] = None,
key_pair: Optional[str] = None,
metadata: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
network_mode: Optional[str] = None,
networks: Optional[Sequence[InstanceNetworkArgs]] = None,
personalities: Optional[Sequence[InstancePersonalityArgs]] = None,
power_state: Optional[str] = None,
region: Optional[str] = None,
scheduler_hints: Optional[Sequence[InstanceSchedulerHintArgs]] = None,
security_groups: Optional[Sequence[str]] = None,
stop_before_destroy: Optional[bool] = None,
tags: Optional[Sequence[str]] = None,
user_data: Optional[str] = None,
vendor_options: Optional[InstanceVendorOptionsArgs] = None)
func NewInstance(ctx *Context, name string, args *InstanceArgs, opts ...ResourceOption) (*Instance, error)
public Instance(string name, InstanceArgs? args = null, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)
type: openstack:compute:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var instanceResource = new OpenStack.Compute.Instance("instanceResource", new()
{
AccessIpV4 = "string",
AccessIpV6 = "string",
AdminPass = "string",
AvailabilityZone = "string",
AvailabilityZoneHints = "string",
BlockDevices = new[]
{
new OpenStack.Compute.Inputs.InstanceBlockDeviceArgs
{
SourceType = "string",
BootIndex = 0,
DeleteOnTermination = false,
DestinationType = "string",
DeviceType = "string",
DiskBus = "string",
GuestFormat = "string",
Multiattach = false,
Uuid = "string",
VolumeSize = 0,
VolumeType = "string",
},
},
ConfigDrive = false,
FlavorId = "string",
FlavorName = "string",
ForceDelete = false,
ImageId = "string",
ImageName = "string",
KeyPair = "string",
Metadata =
{
{ "string", "string" },
},
Name = "string",
NetworkMode = "string",
Networks = new[]
{
new OpenStack.Compute.Inputs.InstanceNetworkArgs
{
AccessNetwork = false,
FixedIpV4 = "string",
FixedIpV6 = "string",
Mac = "string",
Name = "string",
Port = "string",
Uuid = "string",
},
},
Personalities = new[]
{
new OpenStack.Compute.Inputs.InstancePersonalityArgs
{
Content = "string",
File = "string",
},
},
PowerState = "string",
Region = "string",
SchedulerHints = new[]
{
new OpenStack.Compute.Inputs.InstanceSchedulerHintArgs
{
AdditionalProperties =
{
{ "string", "string" },
},
BuildNearHostIp = "string",
DifferentCells = new[]
{
"string",
},
DifferentHosts = new[]
{
"string",
},
Group = "string",
Queries = new[]
{
"string",
},
SameHosts = new[]
{
"string",
},
TargetCell = "string",
},
},
SecurityGroups = new[]
{
"string",
},
StopBeforeDestroy = false,
Tags = new[]
{
"string",
},
UserData = "string",
VendorOptions = new OpenStack.Compute.Inputs.InstanceVendorOptionsArgs
{
DetachPortsBeforeDestroy = false,
IgnoreResizeConfirmation = false,
},
});
example, err := compute.NewInstance(ctx, "instanceResource", &compute.InstanceArgs{
AccessIpV4: pulumi.String("string"),
AccessIpV6: pulumi.String("string"),
AdminPass: pulumi.String("string"),
AvailabilityZone: pulumi.String("string"),
AvailabilityZoneHints: pulumi.String("string"),
BlockDevices: compute.InstanceBlockDeviceArray{
&compute.InstanceBlockDeviceArgs{
SourceType: pulumi.String("string"),
BootIndex: pulumi.Int(0),
DeleteOnTermination: pulumi.Bool(false),
DestinationType: pulumi.String("string"),
DeviceType: pulumi.String("string"),
DiskBus: pulumi.String("string"),
GuestFormat: pulumi.String("string"),
Multiattach: pulumi.Bool(false),
Uuid: pulumi.String("string"),
VolumeSize: pulumi.Int(0),
VolumeType: pulumi.String("string"),
},
},
ConfigDrive: pulumi.Bool(false),
FlavorId: pulumi.String("string"),
FlavorName: pulumi.String("string"),
ForceDelete: pulumi.Bool(false),
ImageId: pulumi.String("string"),
ImageName: pulumi.String("string"),
KeyPair: pulumi.String("string"),
Metadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
NetworkMode: pulumi.String("string"),
Networks: compute.InstanceNetworkArray{
&compute.InstanceNetworkArgs{
AccessNetwork: pulumi.Bool(false),
FixedIpV4: pulumi.String("string"),
FixedIpV6: pulumi.String("string"),
Mac: pulumi.String("string"),
Name: pulumi.String("string"),
Port: pulumi.String("string"),
Uuid: pulumi.String("string"),
},
},
Personalities: compute.InstancePersonalityArray{
&compute.InstancePersonalityArgs{
Content: pulumi.String("string"),
File: pulumi.String("string"),
},
},
PowerState: pulumi.String("string"),
Region: pulumi.String("string"),
SchedulerHints: compute.InstanceSchedulerHintArray{
&compute.InstanceSchedulerHintArgs{
AdditionalProperties: pulumi.StringMap{
"string": pulumi.String("string"),
},
BuildNearHostIp: pulumi.String("string"),
DifferentCells: pulumi.StringArray{
pulumi.String("string"),
},
DifferentHosts: pulumi.StringArray{
pulumi.String("string"),
},
Group: pulumi.String("string"),
Queries: pulumi.StringArray{
pulumi.String("string"),
},
SameHosts: pulumi.StringArray{
pulumi.String("string"),
},
TargetCell: pulumi.String("string"),
},
},
SecurityGroups: pulumi.StringArray{
pulumi.String("string"),
},
StopBeforeDestroy: pulumi.Bool(false),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
UserData: pulumi.String("string"),
VendorOptions: &compute.InstanceVendorOptionsArgs{
DetachPortsBeforeDestroy: pulumi.Bool(false),
IgnoreResizeConfirmation: pulumi.Bool(false),
},
})
var instanceResource = new Instance("instanceResource", InstanceArgs.builder()
.accessIpV4("string")
.accessIpV6("string")
.adminPass("string")
.availabilityZone("string")
.availabilityZoneHints("string")
.blockDevices(InstanceBlockDeviceArgs.builder()
.sourceType("string")
.bootIndex(0)
.deleteOnTermination(false)
.destinationType("string")
.deviceType("string")
.diskBus("string")
.guestFormat("string")
.multiattach(false)
.uuid("string")
.volumeSize(0)
.volumeType("string")
.build())
.configDrive(false)
.flavorId("string")
.flavorName("string")
.forceDelete(false)
.imageId("string")
.imageName("string")
.keyPair("string")
.metadata(Map.of("string", "string"))
.name("string")
.networkMode("string")
.networks(InstanceNetworkArgs.builder()
.accessNetwork(false)
.fixedIpV4("string")
.fixedIpV6("string")
.mac("string")
.name("string")
.port("string")
.uuid("string")
.build())
.personalities(InstancePersonalityArgs.builder()
.content("string")
.file("string")
.build())
.powerState("string")
.region("string")
.schedulerHints(InstanceSchedulerHintArgs.builder()
.additionalProperties(Map.of("string", "string"))
.buildNearHostIp("string")
.differentCells("string")
.differentHosts("string")
.group("string")
.queries("string")
.sameHosts("string")
.targetCell("string")
.build())
.securityGroups("string")
.stopBeforeDestroy(false)
.tags("string")
.userData("string")
.vendorOptions(InstanceVendorOptionsArgs.builder()
.detachPortsBeforeDestroy(false)
.ignoreResizeConfirmation(false)
.build())
.build());
instance_resource = openstack.compute.Instance("instanceResource",
access_ip_v4="string",
access_ip_v6="string",
admin_pass="string",
availability_zone="string",
availability_zone_hints="string",
block_devices=[openstack.compute.InstanceBlockDeviceArgs(
source_type="string",
boot_index=0,
delete_on_termination=False,
destination_type="string",
device_type="string",
disk_bus="string",
guest_format="string",
multiattach=False,
uuid="string",
volume_size=0,
volume_type="string",
)],
config_drive=False,
flavor_id="string",
flavor_name="string",
force_delete=False,
image_id="string",
image_name="string",
key_pair="string",
metadata={
"string": "string",
},
name="string",
network_mode="string",
networks=[openstack.compute.InstanceNetworkArgs(
access_network=False,
fixed_ip_v4="string",
fixed_ip_v6="string",
mac="string",
name="string",
port="string",
uuid="string",
)],
personalities=[openstack.compute.InstancePersonalityArgs(
content="string",
file="string",
)],
power_state="string",
region="string",
scheduler_hints=[openstack.compute.InstanceSchedulerHintArgs(
additional_properties={
"string": "string",
},
build_near_host_ip="string",
different_cells=["string"],
different_hosts=["string"],
group="string",
queries=["string"],
same_hosts=["string"],
target_cell="string",
)],
security_groups=["string"],
stop_before_destroy=False,
tags=["string"],
user_data="string",
vendor_options=openstack.compute.InstanceVendorOptionsArgs(
detach_ports_before_destroy=False,
ignore_resize_confirmation=False,
))
const instanceResource = new openstack.compute.Instance("instanceResource", {
accessIpV4: "string",
accessIpV6: "string",
adminPass: "string",
availabilityZone: "string",
availabilityZoneHints: "string",
blockDevices: [{
sourceType: "string",
bootIndex: 0,
deleteOnTermination: false,
destinationType: "string",
deviceType: "string",
diskBus: "string",
guestFormat: "string",
multiattach: false,
uuid: "string",
volumeSize: 0,
volumeType: "string",
}],
configDrive: false,
flavorId: "string",
flavorName: "string",
forceDelete: false,
imageId: "string",
imageName: "string",
keyPair: "string",
metadata: {
string: "string",
},
name: "string",
networkMode: "string",
networks: [{
accessNetwork: false,
fixedIpV4: "string",
fixedIpV6: "string",
mac: "string",
name: "string",
port: "string",
uuid: "string",
}],
personalities: [{
content: "string",
file: "string",
}],
powerState: "string",
region: "string",
schedulerHints: [{
additionalProperties: {
string: "string",
},
buildNearHostIp: "string",
differentCells: ["string"],
differentHosts: ["string"],
group: "string",
queries: ["string"],
sameHosts: ["string"],
targetCell: "string",
}],
securityGroups: ["string"],
stopBeforeDestroy: false,
tags: ["string"],
userData: "string",
vendorOptions: {
detachPortsBeforeDestroy: false,
ignoreResizeConfirmation: false,
},
});
type: openstack:compute:Instance
properties:
accessIpV4: string
accessIpV6: string
adminPass: string
availabilityZone: string
availabilityZoneHints: string
blockDevices:
- bootIndex: 0
deleteOnTermination: false
destinationType: string
deviceType: string
diskBus: string
guestFormat: string
multiattach: false
sourceType: string
uuid: string
volumeSize: 0
volumeType: string
configDrive: false
flavorId: string
flavorName: string
forceDelete: false
imageId: string
imageName: string
keyPair: string
metadata:
string: string
name: string
networkMode: string
networks:
- accessNetwork: false
fixedIpV4: string
fixedIpV6: string
mac: string
name: string
port: string
uuid: string
personalities:
- content: string
file: string
powerState: string
region: string
schedulerHints:
- additionalProperties:
string: string
buildNearHostIp: string
differentCells:
- string
differentHosts:
- string
group: string
queries:
- string
sameHosts:
- string
targetCell: string
securityGroups:
- string
stopBeforeDestroy: false
tags:
- string
userData: string
vendorOptions:
detachPortsBeforeDestroy: false
ignoreResizeConfirmation: false
Instance Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Instance resource accepts the following input properties:
- Access
Ip stringV4 - The first detected Fixed IPv4 address.
- Access
Ip stringV6 - The first detected Fixed IPv6 address.
- Admin
Pass string - The administrative password to assign to the server. Changing this changes the root password on the existing server.
- Availability
Zone string - The availability zone in which to create
the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - Availability
Zone stringHints - 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 withavailability_zone
. Changing this creates a new server. - Block
Devices List<Pulumi.Open Stack. Compute. Inputs. Instance Block Device> - 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.
- Config
Drive bool - Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- Flavor
Id string - The flavor ID of the desired flavor for the server. Changing this resizes the existing server.
- Flavor
Name string - The name of the desired flavor for the server. Changing this resizes the existing server.
- Force
Delete bool - Whether to force the OpenStack instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- Image
Id 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 rebuilds the existing server. - Image
Name 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 rebuilds the existing server. - Key
Pair 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.
- Metadata Dictionary<string, string>
- Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- Name string
- A unique name for the resource.
- Network
Mode string - Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - Networks
List<Pulumi.
Open Stack. Compute. Inputs. Instance Network> - 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.
- Personalities
List<Pulumi.
Open Stack. Compute. Inputs. Instance Personality> - Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Changing this rebuilds the existing server.
- Power
State string - Provide the VM state. Only 'active', 'shutoff' and 'shelved_offloaded' 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.
- Region 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. - Scheduler
Hints List<Pulumi.Open Stack. Compute. Inputs. Instance Scheduler Hint> - Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- Security
Groups List<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. Note: Names should be used and not ids, as ids trigger unnecessary updates.
- Stop
Before boolDestroy - 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.
- List<string>
- A set of string tags for the instance. Changing this updates the existing instance tags.
- User
Data string - The user data to provide when launching the instance. Changing this creates a new server.
- Vendor
Options Pulumi.Open Stack. Compute. Inputs. Instance Vendor Options - Map of additional vendor-specific options. Supported options are described below.
- Access
Ip stringV4 - The first detected Fixed IPv4 address.
- Access
Ip stringV6 - The first detected Fixed IPv6 address.
- Admin
Pass string - The administrative password to assign to the server. Changing this changes the root password on the existing server.
- Availability
Zone string - The availability zone in which to create
the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - Availability
Zone stringHints - 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 withavailability_zone
. Changing this creates a new server. - Block
Devices []InstanceBlock Device Args - 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.
- Config
Drive bool - Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- Flavor
Id string - The flavor ID of the desired flavor for the server. Changing this resizes the existing server.
- Flavor
Name string - The name of the desired flavor for the server. Changing this resizes the existing server.
- Force
Delete bool - Whether to force the OpenStack instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- Image
Id 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 rebuilds the existing server. - Image
Name 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 rebuilds the existing server. - Key
Pair 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.
- Metadata map[string]string
- Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- Name string
- A unique name for the resource.
- Network
Mode string - Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - Networks
[]Instance
Network Args - 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.
- Personalities
[]Instance
Personality Args - Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Changing this rebuilds the existing server.
- Power
State string - Provide the VM state. Only 'active', 'shutoff' and 'shelved_offloaded' 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.
- Region 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. - Scheduler
Hints []InstanceScheduler Hint Args - Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- Security
Groups []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. Note: Names should be used and not ids, as ids trigger unnecessary updates.
- Stop
Before boolDestroy - 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.
- []string
- A set of string tags for the instance. Changing this updates the existing instance tags.
- User
Data string - The user data to provide when launching the instance. Changing this creates a new server.
- Vendor
Options InstanceVendor Options Args - Map of additional vendor-specific options. Supported options are described below.
- access
Ip StringV4 - The first detected Fixed IPv4 address.
- access
Ip StringV6 - The first detected Fixed IPv6 address.
- admin
Pass String - The administrative password to assign to the server. Changing this changes the root password on the existing server.
- availability
Zone String - The availability zone in which to create
the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - availability
Zone StringHints - 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 withavailability_zone
. Changing this creates a new server. - block
Devices List<InstanceBlock Device> - 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.
- config
Drive Boolean - Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- flavor
Id String - The flavor ID of the desired flavor for the server. Changing this resizes the existing server.
- flavor
Name String - The name of the desired flavor for the server. Changing this resizes the existing server.
- force
Delete Boolean - Whether to force the OpenStack instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- image
Id 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 rebuilds the existing server. - image
Name 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 rebuilds the existing server. - key
Pair 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.
- metadata Map<String,String>
- Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- name String
- A unique name for the resource.
- network
Mode String - Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - networks
List<Instance
Network> - 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.
- personalities
List<Instance
Personality> - Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Changing this rebuilds the existing server.
- power
State String - Provide the VM state. Only 'active', 'shutoff' and 'shelved_offloaded' 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.
- region 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. - scheduler
Hints List<InstanceScheduler Hint> - Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- security
Groups List<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. Note: Names should be used and not ids, as ids trigger unnecessary updates.
- stop
Before BooleanDestroy - 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.
- List<String>
- A set of string tags for the instance. Changing this updates the existing instance tags.
- user
Data String - The user data to provide when launching the instance. Changing this creates a new server.
- vendor
Options InstanceVendor Options - Map of additional vendor-specific options. Supported options are described below.
- access
Ip stringV4 - The first detected Fixed IPv4 address.
- access
Ip stringV6 - The first detected Fixed IPv6 address.
- admin
Pass string - The administrative password to assign to the server. Changing this changes the root password on the existing server.
- availability
Zone string - The availability zone in which to create
the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - availability
Zone stringHints - 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 withavailability_zone
. Changing this creates a new server. - block
Devices InstanceBlock Device[] - 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.
- config
Drive boolean - Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- flavor
Id string - The flavor ID of the desired flavor for the server. Changing this resizes the existing server.
- flavor
Name string - The name of the desired flavor for the server. Changing this resizes the existing server.
- force
Delete boolean - Whether to force the OpenStack instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- image
Id 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 rebuilds the existing server. - image
Name 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 rebuilds the existing server. - key
Pair 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.
- metadata {[key: string]: string}
- Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- name string
- A unique name for the resource.
- network
Mode string - Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - networks
Instance
Network[] - 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.
- personalities
Instance
Personality[] - Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Changing this rebuilds the existing server.
- power
State string - Provide the VM state. Only 'active', 'shutoff' and 'shelved_offloaded' 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.
- region 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. - scheduler
Hints InstanceScheduler Hint[] - Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- security
Groups 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. Note: Names should be used and not ids, as ids trigger unnecessary updates.
- stop
Before booleanDestroy - 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.
- string[]
- A set of string tags for the instance. Changing this updates the existing instance tags.
- user
Data string - The user data to provide when launching the instance. Changing this creates a new server.
- vendor
Options InstanceVendor Options - Map of additional vendor-specific options. Supported options are described below.
- access_
ip_ strv4 - The first detected Fixed IPv4 address.
- access_
ip_ strv6 - The first detected Fixed IPv6 address.
- admin_
pass str - The administrative password to assign to the server. Changing this changes the root password on the existing server.
- availability_
zone str - The availability zone in which to create
the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - availability_
zone_ strhints - 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 withavailability_zone
. Changing this creates a new server. - block_
devices Sequence[InstanceBlock Device Args] - 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.
- config_
drive bool - Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- flavor_
id str - The flavor ID of the desired flavor for the server. Changing this resizes the existing server.
- flavor_
name str - The name of the desired flavor for the server. Changing this resizes the existing server.
- force_
delete bool - Whether to force the OpenStack instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- image_
id str - (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 rebuilds the existing server. - image_
name str - (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 rebuilds the existing server. - key_
pair str - 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.
- metadata Mapping[str, str]
- Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- name str
- A unique name for the resource.
- network_
mode str - Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - networks
Sequence[Instance
Network Args] - 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.
- personalities
Sequence[Instance
Personality Args] - Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Changing this rebuilds the existing server.
- power_
state str - Provide the VM state. Only 'active', 'shutoff' and 'shelved_offloaded' 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.
- region str
- 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. - scheduler_
hints Sequence[InstanceScheduler Hint Args] - Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- security_
groups Sequence[str] - 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. Note: Names should be used and not ids, as ids trigger unnecessary updates.
- stop_
before_ booldestroy - 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.
- Sequence[str]
- A set of string tags for the instance. Changing this updates the existing instance tags.
- user_
data str - The user data to provide when launching the instance. Changing this creates a new server.
- vendor_
options InstanceVendor Options Args - Map of additional vendor-specific options. Supported options are described below.
- access
Ip StringV4 - The first detected Fixed IPv4 address.
- access
Ip StringV6 - The first detected Fixed IPv6 address.
- admin
Pass String - The administrative password to assign to the server. Changing this changes the root password on the existing server.
- availability
Zone String - The availability zone in which to create
the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - availability
Zone StringHints - 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 withavailability_zone
. Changing this creates a new server. - block
Devices List<Property Map> - 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.
- config
Drive Boolean - Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- flavor
Id String - The flavor ID of the desired flavor for the server. Changing this resizes the existing server.
- flavor
Name String - The name of the desired flavor for the server. Changing this resizes the existing server.
- force
Delete Boolean - Whether to force the OpenStack instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- image
Id 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 rebuilds the existing server. - image
Name 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 rebuilds the existing server. - key
Pair 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.
- metadata Map<String>
- Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- name String
- A unique name for the resource.
- network
Mode String - Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - networks List<Property Map>
- 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.
- personalities List<Property Map>
- Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Changing this rebuilds the existing server.
- power
State String - Provide the VM state. Only 'active', 'shutoff' and 'shelved_offloaded' 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.
- region 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. - scheduler
Hints List<Property Map> - Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- security
Groups List<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. Note: Names should be used and not ids, as ids trigger unnecessary updates.
- stop
Before BooleanDestroy - 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.
- List<String>
- A set of string tags for the instance. Changing this updates the existing instance tags.
- user
Data String - The user data to provide when launching the instance. Changing this creates a new server.
- vendor
Options Property Map - Map of additional vendor-specific options. Supported options are described below.
Outputs
All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:
- All
Metadata Dictionary<string, string> - List<string>
- The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- Created string
- The creation time of the instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Updated string
- The time when the instance was last updated.
- All
Metadata map[string]string - []string
- The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- Created string
- The creation time of the instance.
- Id string
- The provider-assigned unique ID for this managed resource.
- Updated string
- The time when the instance was last updated.
- all
Metadata Map<String,String> - List<String>
- The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- created String
- The creation time of the instance.
- id String
- The provider-assigned unique ID for this managed resource.
- updated String
- The time when the instance was last updated.
- all
Metadata {[key: string]: string} - string[]
- The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- created string
- The creation time of the instance.
- id string
- The provider-assigned unique ID for this managed resource.
- updated string
- The time when the instance was last updated.
- all_
metadata Mapping[str, str] - Sequence[str]
- The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- created str
- The creation time of the instance.
- id str
- The provider-assigned unique ID for this managed resource.
- updated str
- The time when the instance was last updated.
- all
Metadata Map<String> - List<String>
- The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- created String
- The creation time of the instance.
- id String
- The provider-assigned unique ID for this managed resource.
- updated String
- The time when the instance was last updated.
Look up Existing Instance Resource
Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
access_ip_v4: Optional[str] = None,
access_ip_v6: Optional[str] = None,
admin_pass: Optional[str] = None,
all_metadata: Optional[Mapping[str, str]] = None,
all_tags: Optional[Sequence[str]] = None,
availability_zone: Optional[str] = None,
availability_zone_hints: Optional[str] = None,
block_devices: Optional[Sequence[InstanceBlockDeviceArgs]] = None,
config_drive: Optional[bool] = None,
created: Optional[str] = None,
flavor_id: Optional[str] = None,
flavor_name: Optional[str] = None,
force_delete: Optional[bool] = None,
image_id: Optional[str] = None,
image_name: Optional[str] = None,
key_pair: Optional[str] = None,
metadata: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
network_mode: Optional[str] = None,
networks: Optional[Sequence[InstanceNetworkArgs]] = None,
personalities: Optional[Sequence[InstancePersonalityArgs]] = None,
power_state: Optional[str] = None,
region: Optional[str] = None,
scheduler_hints: Optional[Sequence[InstanceSchedulerHintArgs]] = None,
security_groups: Optional[Sequence[str]] = None,
stop_before_destroy: Optional[bool] = None,
tags: Optional[Sequence[str]] = None,
updated: Optional[str] = None,
user_data: Optional[str] = None,
vendor_options: Optional[InstanceVendorOptionsArgs] = None) -> Instance
func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Access
Ip stringV4 - The first detected Fixed IPv4 address.
- Access
Ip stringV6 - The first detected Fixed IPv6 address.
- Admin
Pass string - The administrative password to assign to the server. Changing this changes the root password on the existing server.
- All
Metadata Dictionary<string, string> - List<string>
- The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- Availability
Zone string - The availability zone in which to create
the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - Availability
Zone stringHints - 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 withavailability_zone
. Changing this creates a new server. - Block
Devices List<Pulumi.Open Stack. Compute. Inputs. Instance Block Device> - 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.
- Config
Drive bool - Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- Created string
- The creation time of the instance.
- Flavor
Id string - The flavor ID of the desired flavor for the server. Changing this resizes the existing server.
- Flavor
Name string - The name of the desired flavor for the server. Changing this resizes the existing server.
- Force
Delete bool - Whether to force the OpenStack instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- Image
Id 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 rebuilds the existing server. - Image
Name 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 rebuilds the existing server. - Key
Pair 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.
- Metadata Dictionary<string, string>
- Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- Name string
- A unique name for the resource.
- Network
Mode string - Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - Networks
List<Pulumi.
Open Stack. Compute. Inputs. Instance Network> - 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.
- Personalities
List<Pulumi.
Open Stack. Compute. Inputs. Instance Personality> - Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Changing this rebuilds the existing server.
- Power
State string - Provide the VM state. Only 'active', 'shutoff' and 'shelved_offloaded' 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.
- Region 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. - Scheduler
Hints List<Pulumi.Open Stack. Compute. Inputs. Instance Scheduler Hint> - Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- Security
Groups List<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. Note: Names should be used and not ids, as ids trigger unnecessary updates.
- Stop
Before boolDestroy - 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.
- List<string>
- A set of string tags for the instance. Changing this updates the existing instance tags.
- Updated string
- The time when the instance was last updated.
- User
Data string - The user data to provide when launching the instance. Changing this creates a new server.
- Vendor
Options Pulumi.Open Stack. Compute. Inputs. Instance Vendor Options - Map of additional vendor-specific options. Supported options are described below.
- Access
Ip stringV4 - The first detected Fixed IPv4 address.
- Access
Ip stringV6 - The first detected Fixed IPv6 address.
- Admin
Pass string - The administrative password to assign to the server. Changing this changes the root password on the existing server.
- All
Metadata map[string]string - []string
- The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- Availability
Zone string - The availability zone in which to create
the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - Availability
Zone stringHints - 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 withavailability_zone
. Changing this creates a new server. - Block
Devices []InstanceBlock Device Args - 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.
- Config
Drive bool - Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- Created string
- The creation time of the instance.
- Flavor
Id string - The flavor ID of the desired flavor for the server. Changing this resizes the existing server.
- Flavor
Name string - The name of the desired flavor for the server. Changing this resizes the existing server.
- Force
Delete bool - Whether to force the OpenStack instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- Image
Id 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 rebuilds the existing server. - Image
Name 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 rebuilds the existing server. - Key
Pair 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.
- Metadata map[string]string
- Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- Name string
- A unique name for the resource.
- Network
Mode string - Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - Networks
[]Instance
Network Args - 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.
- Personalities
[]Instance
Personality Args - Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Changing this rebuilds the existing server.
- Power
State string - Provide the VM state. Only 'active', 'shutoff' and 'shelved_offloaded' 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.
- Region 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. - Scheduler
Hints []InstanceScheduler Hint Args - Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- Security
Groups []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. Note: Names should be used and not ids, as ids trigger unnecessary updates.
- Stop
Before boolDestroy - 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.
- []string
- A set of string tags for the instance. Changing this updates the existing instance tags.
- Updated string
- The time when the instance was last updated.
- User
Data string - The user data to provide when launching the instance. Changing this creates a new server.
- Vendor
Options InstanceVendor Options Args - Map of additional vendor-specific options. Supported options are described below.
- access
Ip StringV4 - The first detected Fixed IPv4 address.
- access
Ip StringV6 - The first detected Fixed IPv6 address.
- admin
Pass String - The administrative password to assign to the server. Changing this changes the root password on the existing server.
- all
Metadata Map<String,String> - List<String>
- The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- availability
Zone String - The availability zone in which to create
the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - availability
Zone StringHints - 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 withavailability_zone
. Changing this creates a new server. - block
Devices List<InstanceBlock Device> - 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.
- config
Drive Boolean - Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- created String
- The creation time of the instance.
- flavor
Id String - The flavor ID of the desired flavor for the server. Changing this resizes the existing server.
- flavor
Name String - The name of the desired flavor for the server. Changing this resizes the existing server.
- force
Delete Boolean - Whether to force the OpenStack instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- image
Id 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 rebuilds the existing server. - image
Name 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 rebuilds the existing server. - key
Pair 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.
- metadata Map<String,String>
- Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- name String
- A unique name for the resource.
- network
Mode String - Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - networks
List<Instance
Network> - 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.
- personalities
List<Instance
Personality> - Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Changing this rebuilds the existing server.
- power
State String - Provide the VM state. Only 'active', 'shutoff' and 'shelved_offloaded' 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.
- region 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. - scheduler
Hints List<InstanceScheduler Hint> - Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- security
Groups List<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. Note: Names should be used and not ids, as ids trigger unnecessary updates.
- stop
Before BooleanDestroy - 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.
- List<String>
- A set of string tags for the instance. Changing this updates the existing instance tags.
- updated String
- The time when the instance was last updated.
- user
Data String - The user data to provide when launching the instance. Changing this creates a new server.
- vendor
Options InstanceVendor Options - Map of additional vendor-specific options. Supported options are described below.
- access
Ip stringV4 - The first detected Fixed IPv4 address.
- access
Ip stringV6 - The first detected Fixed IPv6 address.
- admin
Pass string - The administrative password to assign to the server. Changing this changes the root password on the existing server.
- all
Metadata {[key: string]: string} - string[]
- The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- availability
Zone string - The availability zone in which to create
the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - availability
Zone stringHints - 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 withavailability_zone
. Changing this creates a new server. - block
Devices InstanceBlock Device[] - 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.
- config
Drive boolean - Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- created string
- The creation time of the instance.
- flavor
Id string - The flavor ID of the desired flavor for the server. Changing this resizes the existing server.
- flavor
Name string - The name of the desired flavor for the server. Changing this resizes the existing server.
- force
Delete boolean - Whether to force the OpenStack instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- image
Id 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 rebuilds the existing server. - image
Name 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 rebuilds the existing server. - key
Pair 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.
- metadata {[key: string]: string}
- Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- name string
- A unique name for the resource.
- network
Mode string - Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - networks
Instance
Network[] - 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.
- personalities
Instance
Personality[] - Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Changing this rebuilds the existing server.
- power
State string - Provide the VM state. Only 'active', 'shutoff' and 'shelved_offloaded' 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.
- region 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. - scheduler
Hints InstanceScheduler Hint[] - Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- security
Groups 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. Note: Names should be used and not ids, as ids trigger unnecessary updates.
- stop
Before booleanDestroy - 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.
- string[]
- A set of string tags for the instance. Changing this updates the existing instance tags.
- updated string
- The time when the instance was last updated.
- user
Data string - The user data to provide when launching the instance. Changing this creates a new server.
- vendor
Options InstanceVendor Options - Map of additional vendor-specific options. Supported options are described below.
- access_
ip_ strv4 - The first detected Fixed IPv4 address.
- access_
ip_ strv6 - The first detected Fixed IPv6 address.
- admin_
pass str - The administrative password to assign to the server. Changing this changes the root password on the existing server.
- all_
metadata Mapping[str, str] - Sequence[str]
- The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- availability_
zone str - The availability zone in which to create
the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - availability_
zone_ strhints - 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 withavailability_zone
. Changing this creates a new server. - block_
devices Sequence[InstanceBlock Device Args] - 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.
- config_
drive bool - Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- created str
- The creation time of the instance.
- flavor_
id str - The flavor ID of the desired flavor for the server. Changing this resizes the existing server.
- flavor_
name str - The name of the desired flavor for the server. Changing this resizes the existing server.
- force_
delete bool - Whether to force the OpenStack instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- image_
id str - (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 rebuilds the existing server. - image_
name str - (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 rebuilds the existing server. - key_
pair str - 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.
- metadata Mapping[str, str]
- Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- name str
- A unique name for the resource.
- network_
mode str - Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - networks
Sequence[Instance
Network Args] - 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.
- personalities
Sequence[Instance
Personality Args] - Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Changing this rebuilds the existing server.
- power_
state str - Provide the VM state. Only 'active', 'shutoff' and 'shelved_offloaded' 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.
- region str
- 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. - scheduler_
hints Sequence[InstanceScheduler Hint Args] - Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- security_
groups Sequence[str] - 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. Note: Names should be used and not ids, as ids trigger unnecessary updates.
- stop_
before_ booldestroy - 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.
- Sequence[str]
- A set of string tags for the instance. Changing this updates the existing instance tags.
- updated str
- The time when the instance was last updated.
- user_
data str - The user data to provide when launching the instance. Changing this creates a new server.
- vendor_
options InstanceVendor Options Args - Map of additional vendor-specific options. Supported options are described below.
- access
Ip StringV4 - The first detected Fixed IPv4 address.
- access
Ip StringV6 - The first detected Fixed IPv6 address.
- admin
Pass String - The administrative password to assign to the server. Changing this changes the root password on the existing server.
- all
Metadata Map<String> - List<String>
- The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- availability
Zone String - The availability zone in which to create
the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - availability
Zone StringHints - 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 withavailability_zone
. Changing this creates a new server. - block
Devices List<Property Map> - 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.
- config
Drive Boolean - Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- created String
- The creation time of the instance.
- flavor
Id String - The flavor ID of the desired flavor for the server. Changing this resizes the existing server.
- flavor
Name String - The name of the desired flavor for the server. Changing this resizes the existing server.
- force
Delete Boolean - Whether to force the OpenStack instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- image
Id 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 rebuilds the existing server. - image
Name 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 rebuilds the existing server. - key
Pair 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.
- metadata Map<String>
- Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- name String
- A unique name for the resource.
- network
Mode String - Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - networks List<Property Map>
- 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.
- personalities List<Property Map>
- Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Changing this rebuilds the existing server.
- power
State String - Provide the VM state. Only 'active', 'shutoff' and 'shelved_offloaded' 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.
- region 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. - scheduler
Hints List<Property Map> - Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- security
Groups List<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. Note: Names should be used and not ids, as ids trigger unnecessary updates.
- stop
Before BooleanDestroy - 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.
- List<String>
- A set of string tags for the instance. Changing this updates the existing instance tags.
- updated String
- The time when the instance was last updated.
- user
Data String - The user data to provide when launching the instance. Changing this creates a new server.
- vendor
Options Property Map - Map of additional vendor-specific options. Supported options are described below.
Supporting Types
InstanceBlockDevice, InstanceBlockDeviceArgs
- Source
Type string - The source type of the device. Must be one of "blank", "image", "volume", or "snapshot". Changing this creates a new server.
- Boot
Index int - The boot index of the volume. It defaults to 0. Changing this creates a new server.
- Delete
On boolTermination - Delete the volume / block device upon termination of the instance. Defaults to false. Changing this creates a new server.
- Destination
Type string - The type that gets created. Possible values are "volume" and "local". Changing this creates a new server.
- Device
Type string - The low-level device type that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- Disk
Bus string - The low-level disk bus that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- Guest
Format string - Specifies the guest server disk file system format,
such as
ext2
,ext3
,ext4
,xfs
orswap
. Swap block device mappings have the following restrictions: source_type must be blank and destination_type must be local and only one swap disk per server and the size of the swap disk must be less than or equal to the swap size of the flavor. Changing this creates a new server. - Multiattach bool
- Enable the attachment of multiattach-capable volumes.
- Uuid string
- The UUID of the image, volume, or snapshot. Changing this creates a new server.
- Volume
Size int - The size of the volume to create (in gigabytes). Required in the following combinations: source=image and destination=volume, source=blank and destination=local, and source=blank and destination=volume. Changing this creates a new server.
- Volume
Type string - The volume type that will be used, for example SSD or HDD storage. The available options depend on how your specific OpenStack cloud is configured and what classes of storage are provided. Changing this creates a new server.
- Source
Type string - The source type of the device. Must be one of "blank", "image", "volume", or "snapshot". Changing this creates a new server.
- Boot
Index int - The boot index of the volume. It defaults to 0. Changing this creates a new server.
- Delete
On boolTermination - Delete the volume / block device upon termination of the instance. Defaults to false. Changing this creates a new server.
- Destination
Type string - The type that gets created. Possible values are "volume" and "local". Changing this creates a new server.
- Device
Type string - The low-level device type that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- Disk
Bus string - The low-level disk bus that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- Guest
Format string - Specifies the guest server disk file system format,
such as
ext2
,ext3
,ext4
,xfs
orswap
. Swap block device mappings have the following restrictions: source_type must be blank and destination_type must be local and only one swap disk per server and the size of the swap disk must be less than or equal to the swap size of the flavor. Changing this creates a new server. - Multiattach bool
- Enable the attachment of multiattach-capable volumes.
- Uuid string
- The UUID of the image, volume, or snapshot. Changing this creates a new server.
- Volume
Size int - The size of the volume to create (in gigabytes). Required in the following combinations: source=image and destination=volume, source=blank and destination=local, and source=blank and destination=volume. Changing this creates a new server.
- Volume
Type string - The volume type that will be used, for example SSD or HDD storage. The available options depend on how your specific OpenStack cloud is configured and what classes of storage are provided. Changing this creates a new server.
- source
Type String - The source type of the device. Must be one of "blank", "image", "volume", or "snapshot". Changing this creates a new server.
- boot
Index Integer - The boot index of the volume. It defaults to 0. Changing this creates a new server.
- delete
On BooleanTermination - Delete the volume / block device upon termination of the instance. Defaults to false. Changing this creates a new server.
- destination
Type String - The type that gets created. Possible values are "volume" and "local". Changing this creates a new server.
- device
Type String - The low-level device type that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- disk
Bus String - The low-level disk bus that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- guest
Format String - Specifies the guest server disk file system format,
such as
ext2
,ext3
,ext4
,xfs
orswap
. Swap block device mappings have the following restrictions: source_type must be blank and destination_type must be local and only one swap disk per server and the size of the swap disk must be less than or equal to the swap size of the flavor. Changing this creates a new server. - multiattach Boolean
- Enable the attachment of multiattach-capable volumes.
- uuid String
- The UUID of the image, volume, or snapshot. Changing this creates a new server.
- volume
Size Integer - The size of the volume to create (in gigabytes). Required in the following combinations: source=image and destination=volume, source=blank and destination=local, and source=blank and destination=volume. Changing this creates a new server.
- volume
Type String - The volume type that will be used, for example SSD or HDD storage. The available options depend on how your specific OpenStack cloud is configured and what classes of storage are provided. Changing this creates a new server.
- source
Type string - The source type of the device. Must be one of "blank", "image", "volume", or "snapshot". Changing this creates a new server.
- boot
Index number - The boot index of the volume. It defaults to 0. Changing this creates a new server.
- delete
On booleanTermination - Delete the volume / block device upon termination of the instance. Defaults to false. Changing this creates a new server.
- destination
Type string - The type that gets created. Possible values are "volume" and "local". Changing this creates a new server.
- device
Type string - The low-level device type that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- disk
Bus string - The low-level disk bus that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- guest
Format string - Specifies the guest server disk file system format,
such as
ext2
,ext3
,ext4
,xfs
orswap
. Swap block device mappings have the following restrictions: source_type must be blank and destination_type must be local and only one swap disk per server and the size of the swap disk must be less than or equal to the swap size of the flavor. Changing this creates a new server. - multiattach boolean
- Enable the attachment of multiattach-capable volumes.
- uuid string
- The UUID of the image, volume, or snapshot. Changing this creates a new server.
- volume
Size number - The size of the volume to create (in gigabytes). Required in the following combinations: source=image and destination=volume, source=blank and destination=local, and source=blank and destination=volume. Changing this creates a new server.
- volume
Type string - The volume type that will be used, for example SSD or HDD storage. The available options depend on how your specific OpenStack cloud is configured and what classes of storage are provided. Changing this creates a new server.
- source_
type str - The source type of the device. Must be one of "blank", "image", "volume", or "snapshot". Changing this creates a new server.
- boot_
index int - The boot index of the volume. It defaults to 0. Changing this creates a new server.
- delete_
on_ booltermination - Delete the volume / block device upon termination of the instance. Defaults to false. Changing this creates a new server.
- destination_
type str - The type that gets created. Possible values are "volume" and "local". Changing this creates a new server.
- device_
type str - The low-level device type that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- disk_
bus str - The low-level disk bus that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- guest_
format str - Specifies the guest server disk file system format,
such as
ext2
,ext3
,ext4
,xfs
orswap
. Swap block device mappings have the following restrictions: source_type must be blank and destination_type must be local and only one swap disk per server and the size of the swap disk must be less than or equal to the swap size of the flavor. Changing this creates a new server. - multiattach bool
- Enable the attachment of multiattach-capable volumes.
- uuid str
- The UUID of the image, volume, or snapshot. Changing this creates a new server.
- volume_
size int - The size of the volume to create (in gigabytes). Required in the following combinations: source=image and destination=volume, source=blank and destination=local, and source=blank and destination=volume. Changing this creates a new server.
- volume_
type str - The volume type that will be used, for example SSD or HDD storage. The available options depend on how your specific OpenStack cloud is configured and what classes of storage are provided. Changing this creates a new server.
- source
Type String - The source type of the device. Must be one of "blank", "image", "volume", or "snapshot". Changing this creates a new server.
- boot
Index Number - The boot index of the volume. It defaults to 0. Changing this creates a new server.
- delete
On BooleanTermination - Delete the volume / block device upon termination of the instance. Defaults to false. Changing this creates a new server.
- destination
Type String - The type that gets created. Possible values are "volume" and "local". Changing this creates a new server.
- device
Type String - The low-level device type that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- disk
Bus String - The low-level disk bus that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- guest
Format String - Specifies the guest server disk file system format,
such as
ext2
,ext3
,ext4
,xfs
orswap
. Swap block device mappings have the following restrictions: source_type must be blank and destination_type must be local and only one swap disk per server and the size of the swap disk must be less than or equal to the swap size of the flavor. Changing this creates a new server. - multiattach Boolean
- Enable the attachment of multiattach-capable volumes.
- uuid String
- The UUID of the image, volume, or snapshot. Changing this creates a new server.
- volume
Size Number - The size of the volume to create (in gigabytes). Required in the following combinations: source=image and destination=volume, source=blank and destination=local, and source=blank and destination=volume. Changing this creates a new server.
- volume
Type String - The volume type that will be used, for example SSD or HDD storage. The available options depend on how your specific OpenStack cloud is configured and what classes of storage are provided. Changing this creates a new server.
InstanceNetwork, InstanceNetworkArgs
- Access
Network bool - Specifies if this network should be used for provisioning access. Accepts true or false. Defaults to false.
- Fixed
Ip stringV4 - Specifies a fixed IPv4 address to be used on this network. Changing this creates a new server.
- Fixed
Ip stringV6 - Mac string
- Name string
- The human-readable name of the network. Changing this creates a new server.
- Port string
- The port UUID of a network to attach to the server. Changing this creates a new server.
- Uuid string
- The network UUID to attach to the server. Changing this creates a new server.
- Access
Network bool - Specifies if this network should be used for provisioning access. Accepts true or false. Defaults to false.
- Fixed
Ip stringV4 - Specifies a fixed IPv4 address to be used on this network. Changing this creates a new server.
- Fixed
Ip stringV6 - Mac string
- Name string
- The human-readable name of the network. Changing this creates a new server.
- Port string
- The port UUID of a network to attach to the server. Changing this creates a new server.
- Uuid string
- The network UUID to attach to the server. Changing this creates a new server.
- access
Network Boolean - Specifies if this network should be used for provisioning access. Accepts true or false. Defaults to false.
- fixed
Ip StringV4 - Specifies a fixed IPv4 address to be used on this network. Changing this creates a new server.
- fixed
Ip StringV6 - mac String
- name String
- The human-readable name of the network. Changing this creates a new server.
- port String
- The port UUID of a network to attach to the server. Changing this creates a new server.
- uuid String
- The network UUID to attach to the server. Changing this creates a new server.
- access
Network boolean - Specifies if this network should be used for provisioning access. Accepts true or false. Defaults to false.
- fixed
Ip stringV4 - Specifies a fixed IPv4 address to be used on this network. Changing this creates a new server.
- fixed
Ip stringV6 - mac string
- name string
- The human-readable name of the network. Changing this creates a new server.
- port string
- The port UUID of a network to attach to the server. Changing this creates a new server.
- uuid string
- The network UUID to attach to the server. Changing this creates a new server.
- access_
network bool - Specifies if this network should be used for provisioning access. Accepts true or false. Defaults to false.
- fixed_
ip_ strv4 - Specifies a fixed IPv4 address to be used on this network. Changing this creates a new server.
- fixed_
ip_ strv6 - mac str
- name str
- The human-readable name of the network. Changing this creates a new server.
- port str
- The port UUID of a network to attach to the server. Changing this creates a new server.
- uuid str
- The network UUID to attach to the server. Changing this creates a new server.
- access
Network Boolean - Specifies if this network should be used for provisioning access. Accepts true or false. Defaults to false.
- fixed
Ip StringV4 - Specifies a fixed IPv4 address to be used on this network. Changing this creates a new server.
- fixed
Ip StringV6 - mac String
- name String
- The human-readable name of the network. Changing this creates a new server.
- port String
- The port UUID of a network to attach to the server. Changing this creates a new server.
- uuid String
- The network UUID to attach to the server. Changing this creates a new server.
InstancePersonality, InstancePersonalityArgs
InstanceSchedulerHint, InstanceSchedulerHintArgs
- Additional
Properties Dictionary<string, string> - Arbitrary key/value pairs of additional properties to pass to the scheduler.
- Build
Near stringHost Ip - An IP Address in CIDR form. The instance will be placed on a compute node that is in the same subnet.
- Different
Cells List<string> - The names of cells where not to build the instance.
- Different
Hosts List<string> - A list of instance UUIDs. The instance will be scheduled on a different host than all other instances.
- Group string
- A UUID of a Server Group. The instance will be placed into that group. See reference for details on managing servergroup resources
- Queries List<string>
- A conditional query that a compute node must pass in
order to host an instance. The query must use the
JsonFilter
syntax which is described here. At this time, only simple queries are supported. Compound queries usingand
,or
, ornot
are not supported. An example of a simple query is:[">=", "$free_ram_mb", "1024"]
- Same
Hosts List<string> - A list of instance UUIDs. The instance will be scheduled on the same host of those specified.
- Target
Cell string - The name of a cell to host the instance.
- Additional
Properties map[string]string - Arbitrary key/value pairs of additional properties to pass to the scheduler.
- Build
Near stringHost Ip - An IP Address in CIDR form. The instance will be placed on a compute node that is in the same subnet.
- Different
Cells []string - The names of cells where not to build the instance.
- Different
Hosts []string - A list of instance UUIDs. The instance will be scheduled on a different host than all other instances.
- Group string
- A UUID of a Server Group. The instance will be placed into that group. See reference for details on managing servergroup resources
- Queries []string
- A conditional query that a compute node must pass in
order to host an instance. The query must use the
JsonFilter
syntax which is described here. At this time, only simple queries are supported. Compound queries usingand
,or
, ornot
are not supported. An example of a simple query is:[">=", "$free_ram_mb", "1024"]
- Same
Hosts []string - A list of instance UUIDs. The instance will be scheduled on the same host of those specified.
- Target
Cell string - The name of a cell to host the instance.
- additional
Properties Map<String,String> - Arbitrary key/value pairs of additional properties to pass to the scheduler.
- build
Near StringHost Ip - An IP Address in CIDR form. The instance will be placed on a compute node that is in the same subnet.
- different
Cells List<String> - The names of cells where not to build the instance.
- different
Hosts List<String> - A list of instance UUIDs. The instance will be scheduled on a different host than all other instances.
- group String
- A UUID of a Server Group. The instance will be placed into that group. See reference for details on managing servergroup resources
- queries List<String>
- A conditional query that a compute node must pass in
order to host an instance. The query must use the
JsonFilter
syntax which is described here. At this time, only simple queries are supported. Compound queries usingand
,or
, ornot
are not supported. An example of a simple query is:[">=", "$free_ram_mb", "1024"]
- same
Hosts List<String> - A list of instance UUIDs. The instance will be scheduled on the same host of those specified.
- target
Cell String - The name of a cell to host the instance.
- additional
Properties {[key: string]: string} - Arbitrary key/value pairs of additional properties to pass to the scheduler.
- build
Near stringHost Ip - An IP Address in CIDR form. The instance will be placed on a compute node that is in the same subnet.
- different
Cells string[] - The names of cells where not to build the instance.
- different
Hosts string[] - A list of instance UUIDs. The instance will be scheduled on a different host than all other instances.
- group string
- A UUID of a Server Group. The instance will be placed into that group. See reference for details on managing servergroup resources
- queries string[]
- A conditional query that a compute node must pass in
order to host an instance. The query must use the
JsonFilter
syntax which is described here. At this time, only simple queries are supported. Compound queries usingand
,or
, ornot
are not supported. An example of a simple query is:[">=", "$free_ram_mb", "1024"]
- same
Hosts string[] - A list of instance UUIDs. The instance will be scheduled on the same host of those specified.
- target
Cell string - The name of a cell to host the instance.
- additional_
properties Mapping[str, str] - Arbitrary key/value pairs of additional properties to pass to the scheduler.
- build_
near_ strhost_ ip - An IP Address in CIDR form. The instance will be placed on a compute node that is in the same subnet.
- different_
cells Sequence[str] - The names of cells where not to build the instance.
- different_
hosts Sequence[str] - A list of instance UUIDs. The instance will be scheduled on a different host than all other instances.
- group str
- A UUID of a Server Group. The instance will be placed into that group. See reference for details on managing servergroup resources
- queries Sequence[str]
- A conditional query that a compute node must pass in
order to host an instance. The query must use the
JsonFilter
syntax which is described here. At this time, only simple queries are supported. Compound queries usingand
,or
, ornot
are not supported. An example of a simple query is:[">=", "$free_ram_mb", "1024"]
- same_
hosts Sequence[str] - A list of instance UUIDs. The instance will be scheduled on the same host of those specified.
- target_
cell str - The name of a cell to host the instance.
- additional
Properties Map<String> - Arbitrary key/value pairs of additional properties to pass to the scheduler.
- build
Near StringHost Ip - An IP Address in CIDR form. The instance will be placed on a compute node that is in the same subnet.
- different
Cells List<String> - The names of cells where not to build the instance.
- different
Hosts List<String> - A list of instance UUIDs. The instance will be scheduled on a different host than all other instances.
- group String
- A UUID of a Server Group. The instance will be placed into that group. See reference for details on managing servergroup resources
- queries List<String>
- A conditional query that a compute node must pass in
order to host an instance. The query must use the
JsonFilter
syntax which is described here. At this time, only simple queries are supported. Compound queries usingand
,or
, ornot
are not supported. An example of a simple query is:[">=", "$free_ram_mb", "1024"]
- same
Hosts List<String> - A list of instance UUIDs. The instance will be scheduled on the same host of those specified.
- target
Cell String - The name of a cell to host the instance.
InstanceVendorOptions, InstanceVendorOptionsArgs
- Detach
Ports boolBefore Destroy - Whether to try to detach all attached ports to the vm before destroying it to make sure the port state is correct after the vm destruction. This is helpful when the port is not deleted.
- Ignore
Resize boolConfirmation - Boolean to control whether to ignore manual confirmation of the instance resizing. This can be helpful to work with some OpenStack clouds which automatically confirm resizing of instances after some timeout.
- Detach
Ports boolBefore Destroy - Whether to try to detach all attached ports to the vm before destroying it to make sure the port state is correct after the vm destruction. This is helpful when the port is not deleted.
- Ignore
Resize boolConfirmation - Boolean to control whether to ignore manual confirmation of the instance resizing. This can be helpful to work with some OpenStack clouds which automatically confirm resizing of instances after some timeout.
- detach
Ports BooleanBefore Destroy - Whether to try to detach all attached ports to the vm before destroying it to make sure the port state is correct after the vm destruction. This is helpful when the port is not deleted.
- ignore
Resize BooleanConfirmation - Boolean to control whether to ignore manual confirmation of the instance resizing. This can be helpful to work with some OpenStack clouds which automatically confirm resizing of instances after some timeout.
- detach
Ports booleanBefore Destroy - Whether to try to detach all attached ports to the vm before destroying it to make sure the port state is correct after the vm destruction. This is helpful when the port is not deleted.
- ignore
Resize booleanConfirmation - Boolean to control whether to ignore manual confirmation of the instance resizing. This can be helpful to work with some OpenStack clouds which automatically confirm resizing of instances after some timeout.
- detach_
ports_ boolbefore_ destroy - Whether to try to detach all attached ports to the vm before destroying it to make sure the port state is correct after the vm destruction. This is helpful when the port is not deleted.
- ignore_
resize_ boolconfirmation - Boolean to control whether to ignore manual confirmation of the instance resizing. This can be helpful to work with some OpenStack clouds which automatically confirm resizing of instances after some timeout.
- detach
Ports BooleanBefore Destroy - Whether to try to detach all attached ports to the vm before destroying it to make sure the port state is correct after the vm destruction. This is helpful when the port is not deleted.
- ignore
Resize BooleanConfirmation - Boolean to control whether to ignore manual confirmation of the instance resizing. This can be helpful to work with some OpenStack clouds which automatically confirm resizing of instances after some timeout.
Package Details
- Repository
- OpenStack pulumi/pulumi-openstack
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
openstack
Terraform Provider.