Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getInstance

This data source provides details about a specific Instance resource in Oracle Cloud Infrastructure Core service.

Gets information about the specified instance.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testInstance = Oci.Core.GetInstance.Invoke(new()
    {
        InstanceId = oci_core_instance.Test_instance.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/Core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Core.GetInstance(ctx, &core.GetInstanceArgs{
			InstanceId: oci_core_instance.Test_instance.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CoreFunctions;
import com.pulumi.oci.Core.inputs.GetInstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testInstance = CoreFunctions.getInstance(GetInstanceArgs.builder()
            .instanceId(oci_core_instance.test_instance().id())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_instance = oci.Core.get_instance(instance_id=oci_core_instance["test_instance"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testInstance = oci.Core.getInstance({
    instanceId: oci_core_instance.test_instance.id,
});
variables:
  testInstance:
    Fn::Invoke:
      Function: oci:Core:getInstance
      Arguments:
        instanceId: ${oci_core_instance.test_instance.id}

Using getInstance

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>
def get_instance(instance_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]
func GetInstance(ctx *Context, args *GetInstanceArgs, opts ...InvokeOption) (*GetInstanceResult, error)
func GetInstanceOutput(ctx *Context, args *GetInstanceOutputArgs, opts ...InvokeOption) GetInstanceResultOutput

> Note: This function is named GetInstance in the Go SDK.

public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:Core/getInstance:getInstance
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId string

The OCID of the instance.

InstanceId string

The OCID of the instance.

instanceId String

The OCID of the instance.

instanceId string

The OCID of the instance.

instance_id str

The OCID of the instance.

instanceId String

The OCID of the instance.

getInstance Result

The following output properties are available:

AgentConfigs List<GetInstanceAgentConfig>

Configuration options for the Oracle Cloud Agent software running on the instance.

Async bool
AvailabilityConfigs List<GetInstanceAvailabilityConfig>

Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.

AvailabilityDomain string

The availability domain the instance is running in. Example: Uocm:PHX-AD-1

BootVolumeId string

The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.

CapacityReservationId string

The OCID of the compute capacity reservation this instance is launched under. When this field contains an empty string or is null, the instance is not currently in a capacity reservation. For more information, see Capacity Reservations.

CompartmentId string

The OCID of the compartment that contains the instance.

CreateVnicDetails List<GetInstanceCreateVnicDetail>
DedicatedVmHostId string

The OCID of dedicated VM host.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

ExtendedMetadata Dictionary<string, object>

Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the metadata object.

FaultDomain string

The name of the fault domain the instance is running in.

FreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

HostnameLabel string

The hostname for the instance VNIC's primary private IP.

Deprecated:

The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

Id string

The OCID of the instance.

Image string

Deprecated. Use sourceDetails instead.

Deprecated:

The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

InstanceId string
InstanceOptions List<GetInstanceInstanceOption>

Optional mutable instance options

IpxeScript string

When a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.

IsPvEncryptionInTransitEnabled bool

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

LaunchMode string

Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

LaunchOptions List<GetInstanceLaunchOption>

Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.

Metadata Dictionary<string, object>

Custom metadata that you provide.

PlatformConfigs List<GetInstancePlatformConfig>

The platform configuration for the instance.

PreemptibleInstanceConfigs List<GetInstancePreemptibleInstanceConfig>

(Optional) Configuration options for preemptible instances.

PreserveBootVolume bool

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

PrivateIp string

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

PublicIp string

The public IP address of instance VNIC (if enabled).

Region string

The region that contains the availability domain the instance is running in.

Shape string

The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. You can enumerate all available shapes by calling ListShapes.

ShapeConfigs List<GetInstanceShapeConfig>

The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.

SourceDetails List<GetInstanceSourceDetail>
State string

The current state of the instance.

SubnetId string

Deprecated:

The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

SystemTags Dictionary<string, object>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

TimeCreated string

The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

TimeMaintenanceRebootDue string

The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z

AgentConfigs []GetInstanceAgentConfig

Configuration options for the Oracle Cloud Agent software running on the instance.

Async bool
AvailabilityConfigs []GetInstanceAvailabilityConfig

Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.

AvailabilityDomain string

The availability domain the instance is running in. Example: Uocm:PHX-AD-1

BootVolumeId string

The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.

CapacityReservationId string

The OCID of the compute capacity reservation this instance is launched under. When this field contains an empty string or is null, the instance is not currently in a capacity reservation. For more information, see Capacity Reservations.

CompartmentId string

The OCID of the compartment that contains the instance.

CreateVnicDetails []GetInstanceCreateVnicDetail
DedicatedVmHostId string

The OCID of dedicated VM host.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

ExtendedMetadata map[string]interface{}

Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the metadata object.

FaultDomain string

The name of the fault domain the instance is running in.

FreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

HostnameLabel string

The hostname for the instance VNIC's primary private IP.

Deprecated:

The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

Id string

The OCID of the instance.

Image string

Deprecated. Use sourceDetails instead.

Deprecated:

The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

InstanceId string
InstanceOptions []GetInstanceInstanceOption

Optional mutable instance options

IpxeScript string

When a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.

IsPvEncryptionInTransitEnabled bool

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

LaunchMode string

Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

LaunchOptions []GetInstanceLaunchOption

Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.

Metadata map[string]interface{}

Custom metadata that you provide.

PlatformConfigs []GetInstancePlatformConfig

The platform configuration for the instance.

PreemptibleInstanceConfigs []GetInstancePreemptibleInstanceConfig

(Optional) Configuration options for preemptible instances.

PreserveBootVolume bool

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

PrivateIp string

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

PublicIp string

The public IP address of instance VNIC (if enabled).

Region string

The region that contains the availability domain the instance is running in.

Shape string

The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. You can enumerate all available shapes by calling ListShapes.

ShapeConfigs []GetInstanceShapeConfig

The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.

SourceDetails []GetInstanceSourceDetail
State string

The current state of the instance.

SubnetId string

Deprecated:

The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

SystemTags map[string]interface{}

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

TimeCreated string

The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

TimeMaintenanceRebootDue string

The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z

agentConfigs List<GetInstanceAgentConfig>

Configuration options for the Oracle Cloud Agent software running on the instance.

async Boolean
availabilityConfigs List<GetInstanceAvailabilityConfig>

Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.

availabilityDomain String

The availability domain the instance is running in. Example: Uocm:PHX-AD-1

bootVolumeId String

The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.

capacityReservationId String

The OCID of the compute capacity reservation this instance is launched under. When this field contains an empty string or is null, the instance is not currently in a capacity reservation. For more information, see Capacity Reservations.

compartmentId String

The OCID of the compartment that contains the instance.

createVnicDetails List<GetInstanceCreateVnicDetail>
dedicatedVmHostId String

The OCID of dedicated VM host.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

extendedMetadata Map<String,Object>

Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the metadata object.

faultDomain String

The name of the fault domain the instance is running in.

freeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

hostnameLabel String

The hostname for the instance VNIC's primary private IP.

Deprecated:

The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

id String

The OCID of the instance.

image String

Deprecated. Use sourceDetails instead.

Deprecated:

The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

instanceId String
instanceOptions List<GetInstanceInstanceOption>

Optional mutable instance options

ipxeScript String

When a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.

isPvEncryptionInTransitEnabled Boolean

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

launchMode String

Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

launchOptions List<GetInstanceLaunchOption>

Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.

metadata Map<String,Object>

Custom metadata that you provide.

platformConfigs List<GetInstancePlatformConfig>

The platform configuration for the instance.

preemptibleInstanceConfigs List<GetInstancePreemptibleInstanceConfig>

(Optional) Configuration options for preemptible instances.

preserveBootVolume Boolean

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

privateIp String

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

publicIp String

The public IP address of instance VNIC (if enabled).

region String

The region that contains the availability domain the instance is running in.

shape String

The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. You can enumerate all available shapes by calling ListShapes.

shapeConfigs List<GetInstanceShapeConfig>

The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.

sourceDetails List<GetInstanceSourceDetail>
state String

The current state of the instance.

subnetId String

Deprecated:

The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

systemTags Map<String,Object>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

timeCreated String

The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

timeMaintenanceRebootDue String

The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z

agentConfigs GetInstanceAgentConfig[]

Configuration options for the Oracle Cloud Agent software running on the instance.

async boolean
availabilityConfigs GetInstanceAvailabilityConfig[]

Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.

availabilityDomain string

The availability domain the instance is running in. Example: Uocm:PHX-AD-1

bootVolumeId string

The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.

capacityReservationId string

The OCID of the compute capacity reservation this instance is launched under. When this field contains an empty string or is null, the instance is not currently in a capacity reservation. For more information, see Capacity Reservations.

compartmentId string

The OCID of the compartment that contains the instance.

createVnicDetails GetInstanceCreateVnicDetail[]
dedicatedVmHostId string

The OCID of dedicated VM host.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

extendedMetadata {[key: string]: any}

Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the metadata object.

faultDomain string

The name of the fault domain the instance is running in.

freeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

hostnameLabel string

The hostname for the instance VNIC's primary private IP.

Deprecated:

The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

id string

The OCID of the instance.

image string

Deprecated. Use sourceDetails instead.

Deprecated:

The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

instanceId string
instanceOptions GetInstanceInstanceOption[]

Optional mutable instance options

ipxeScript string

When a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.

isPvEncryptionInTransitEnabled boolean

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

launchMode string

Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

launchOptions GetInstanceLaunchOption[]

Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.

metadata {[key: string]: any}

Custom metadata that you provide.

platformConfigs GetInstancePlatformConfig[]

The platform configuration for the instance.

preemptibleInstanceConfigs GetInstancePreemptibleInstanceConfig[]

(Optional) Configuration options for preemptible instances.

preserveBootVolume boolean

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

privateIp string

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

publicIp string

The public IP address of instance VNIC (if enabled).

region string

The region that contains the availability domain the instance is running in.

shape string

The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. You can enumerate all available shapes by calling ListShapes.

shapeConfigs GetInstanceShapeConfig[]

The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.

sourceDetails GetInstanceSourceDetail[]
state string

The current state of the instance.

subnetId string

Deprecated:

The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

systemTags {[key: string]: any}

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

timeCreated string

The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

timeMaintenanceRebootDue string

The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z

agent_configs GetInstanceAgentConfig]

Configuration options for the Oracle Cloud Agent software running on the instance.

async_ bool
availability_configs GetInstanceAvailabilityConfig]

Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.

availability_domain str

The availability domain the instance is running in. Example: Uocm:PHX-AD-1

boot_volume_id str

The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.

capacity_reservation_id str

The OCID of the compute capacity reservation this instance is launched under. When this field contains an empty string or is null, the instance is not currently in a capacity reservation. For more information, see Capacity Reservations.

compartment_id str

The OCID of the compartment that contains the instance.

create_vnic_details GetInstanceCreateVnicDetail]
dedicated_vm_host_id str

The OCID of dedicated VM host.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

extended_metadata Mapping[str, Any]

Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the metadata object.

fault_domain str

The name of the fault domain the instance is running in.

freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

hostname_label str

The hostname for the instance VNIC's primary private IP.

Deprecated:

The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

id str

The OCID of the instance.

image str

Deprecated. Use sourceDetails instead.

Deprecated:

The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

instance_id str
instance_options GetInstanceInstanceOption]

Optional mutable instance options

ipxe_script str

When a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.

is_pv_encryption_in_transit_enabled bool

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

launch_mode str

Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

launch_options GetInstanceLaunchOption]

Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.

metadata Mapping[str, Any]

Custom metadata that you provide.

platform_configs GetInstancePlatformConfig]

The platform configuration for the instance.

preemptible_instance_configs GetInstancePreemptibleInstanceConfig]

(Optional) Configuration options for preemptible instances.

preserve_boot_volume bool

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

private_ip str

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

public_ip str

The public IP address of instance VNIC (if enabled).

region str

The region that contains the availability domain the instance is running in.

shape str

The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. You can enumerate all available shapes by calling ListShapes.

shape_configs GetInstanceShapeConfig]

The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.

source_details GetInstanceSourceDetail]
state str

The current state of the instance.

subnet_id str

Deprecated:

The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

system_tags Mapping[str, Any]

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

time_created str

The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

time_maintenance_reboot_due str

The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z

agentConfigs List<Property Map>

Configuration options for the Oracle Cloud Agent software running on the instance.

async Boolean
availabilityConfigs List<Property Map>

Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.

availabilityDomain String

The availability domain the instance is running in. Example: Uocm:PHX-AD-1

bootVolumeId String

The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.

capacityReservationId String

The OCID of the compute capacity reservation this instance is launched under. When this field contains an empty string or is null, the instance is not currently in a capacity reservation. For more information, see Capacity Reservations.

compartmentId String

The OCID of the compartment that contains the instance.

createVnicDetails List<Property Map>
dedicatedVmHostId String

The OCID of dedicated VM host.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

extendedMetadata Map<Any>

Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the metadata object.

faultDomain String

The name of the fault domain the instance is running in.

freeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

hostnameLabel String

The hostname for the instance VNIC's primary private IP.

Deprecated:

The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

id String

The OCID of the instance.

image String

Deprecated. Use sourceDetails instead.

Deprecated:

The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

instanceId String
instanceOptions List<Property Map>

Optional mutable instance options

ipxeScript String

When a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.

isPvEncryptionInTransitEnabled Boolean

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

launchMode String

Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:

launchOptions List<Property Map>

Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.

metadata Map<Any>

Custom metadata that you provide.

platformConfigs List<Property Map>

The platform configuration for the instance.

preemptibleInstanceConfigs List<Property Map>

(Optional) Configuration options for preemptible instances.

preserveBootVolume Boolean

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

privateIp String

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

publicIp String

The public IP address of instance VNIC (if enabled).

region String

The region that contains the availability domain the instance is running in.

shape String

The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. You can enumerate all available shapes by calling ListShapes.

shapeConfigs List<Property Map>

The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.

sourceDetails List<Property Map>
state String

The current state of the instance.

subnetId String

Deprecated:

The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

systemTags Map<Any>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

timeCreated String

The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

timeMaintenanceRebootDue String

The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z

Supporting Types

GetInstanceAgentConfig

AreAllPluginsDisabled bool

Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.

IsManagementDisabled bool

Whether Oracle Cloud Agent can run all the available management plugins.

IsMonitoringDisabled bool

Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.

PluginsConfigs List<GetInstanceAgentConfigPluginsConfig>

The configuration of plugins associated with this instance.

AreAllPluginsDisabled bool

Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.

IsManagementDisabled bool

Whether Oracle Cloud Agent can run all the available management plugins.

IsMonitoringDisabled bool

Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.

PluginsConfigs []GetInstanceAgentConfigPluginsConfig

The configuration of plugins associated with this instance.

areAllPluginsDisabled Boolean

Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.

isManagementDisabled Boolean

Whether Oracle Cloud Agent can run all the available management plugins.

isMonitoringDisabled Boolean

Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.

pluginsConfigs List<GetInstanceAgentConfigPluginsConfig>

The configuration of plugins associated with this instance.

areAllPluginsDisabled boolean

Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.

isManagementDisabled boolean

Whether Oracle Cloud Agent can run all the available management plugins.

isMonitoringDisabled boolean

Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.

pluginsConfigs GetInstanceAgentConfigPluginsConfig[]

The configuration of plugins associated with this instance.

are_all_plugins_disabled bool

Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.

is_management_disabled bool

Whether Oracle Cloud Agent can run all the available management plugins.

is_monitoring_disabled bool

Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.

plugins_configs GetInstanceAgentConfigPluginsConfig]

The configuration of plugins associated with this instance.

areAllPluginsDisabled Boolean

Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.

isManagementDisabled Boolean

Whether Oracle Cloud Agent can run all the available management plugins.

isMonitoringDisabled Boolean

Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.

pluginsConfigs List<Property Map>

The configuration of plugins associated with this instance.

GetInstanceAgentConfigPluginsConfig

DesiredState string

Whether the plugin should be enabled or disabled.

Name string

The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

DesiredState string

Whether the plugin should be enabled or disabled.

Name string

The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

desiredState String

Whether the plugin should be enabled or disabled.

name String

The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

desiredState string

Whether the plugin should be enabled or disabled.

name string

The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

desired_state str

Whether the plugin should be enabled or disabled.

name str

The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

desiredState String

Whether the plugin should be enabled or disabled.

name String

The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

GetInstanceAvailabilityConfig

IsLiveMigrationPreferred bool

Whether live migration is preferred for infrastructure maintenance. If null preference is specified, live migration will be preferred for infrastructure maintenance for applicable instances.

RecoveryAction string

The lifecycle state for an instance when it is recovered after infrastructure maintenance.

IsLiveMigrationPreferred bool

Whether live migration is preferred for infrastructure maintenance. If null preference is specified, live migration will be preferred for infrastructure maintenance for applicable instances.

RecoveryAction string

The lifecycle state for an instance when it is recovered after infrastructure maintenance.

isLiveMigrationPreferred Boolean

Whether live migration is preferred for infrastructure maintenance. If null preference is specified, live migration will be preferred for infrastructure maintenance for applicable instances.

recoveryAction String

The lifecycle state for an instance when it is recovered after infrastructure maintenance.

isLiveMigrationPreferred boolean

Whether live migration is preferred for infrastructure maintenance. If null preference is specified, live migration will be preferred for infrastructure maintenance for applicable instances.

recoveryAction string

The lifecycle state for an instance when it is recovered after infrastructure maintenance.

is_live_migration_preferred bool

Whether live migration is preferred for infrastructure maintenance. If null preference is specified, live migration will be preferred for infrastructure maintenance for applicable instances.

recovery_action str

The lifecycle state for an instance when it is recovered after infrastructure maintenance.

isLiveMigrationPreferred Boolean

Whether live migration is preferred for infrastructure maintenance. If null preference is specified, live migration will be preferred for infrastructure maintenance for applicable instances.

recoveryAction String

The lifecycle state for an instance when it is recovered after infrastructure maintenance.

GetInstanceCreateVnicDetail

AssignPrivateDnsRecord bool
AssignPublicIp string
DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

HostnameLabel string

The hostname for the instance VNIC's primary private IP.

NsgIds List<string>
PrivateIp string

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

SkipSourceDestCheck bool
SubnetId string
VlanId string
AssignPrivateDnsRecord bool
AssignPublicIp string
DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

HostnameLabel string

The hostname for the instance VNIC's primary private IP.

NsgIds []string
PrivateIp string

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

SkipSourceDestCheck bool
SubnetId string
VlanId string
assignPrivateDnsRecord Boolean
assignPublicIp String
definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

hostnameLabel String

The hostname for the instance VNIC's primary private IP.

nsgIds List<String>
privateIp String

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

skipSourceDestCheck Boolean
subnetId String
vlanId String
assignPrivateDnsRecord boolean
assignPublicIp string
definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

hostnameLabel string

The hostname for the instance VNIC's primary private IP.

nsgIds string[]
privateIp string

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

skipSourceDestCheck boolean
subnetId string
vlanId string
assign_private_dns_record bool
assign_public_ip str
defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

hostname_label str

The hostname for the instance VNIC's primary private IP.

nsg_ids Sequence[str]
private_ip str

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

skip_source_dest_check bool
subnet_id str
vlan_id str
assignPrivateDnsRecord Boolean
assignPublicIp String
definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

freeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

hostnameLabel String

The hostname for the instance VNIC's primary private IP.

nsgIds List<String>
privateIp String

The private IP address of instance VNIC. To set the private IP address, use the private_ip argument in create_vnic_details.

skipSourceDestCheck Boolean
subnetId String
vlanId String

GetInstanceInstanceOption

AreLegacyImdsEndpointsDisabled bool

Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.

AreLegacyImdsEndpointsDisabled bool

Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.

areLegacyImdsEndpointsDisabled Boolean

Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.

areLegacyImdsEndpointsDisabled boolean

Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.

are_legacy_imds_endpoints_disabled bool

Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.

areLegacyImdsEndpointsDisabled Boolean

Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.

GetInstanceLaunchOption

BootVolumeType string

Emulation type for the boot volume.

Firmware string

Firmware used to boot VM. Select the option that matches your operating system.

IsConsistentVolumeNamingEnabled bool

Whether to enable consistent volume naming feature. Defaults to false.

IsPvEncryptionInTransitEnabled bool

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

NetworkType string

Emulation type for the physical network interface card (NIC).

RemoteDataVolumeType string

Emulation type for volume.

BootVolumeType string

Emulation type for the boot volume.

Firmware string

Firmware used to boot VM. Select the option that matches your operating system.

IsConsistentVolumeNamingEnabled bool

Whether to enable consistent volume naming feature. Defaults to false.

IsPvEncryptionInTransitEnabled bool

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

NetworkType string

Emulation type for the physical network interface card (NIC).

RemoteDataVolumeType string

Emulation type for volume.

bootVolumeType String

Emulation type for the boot volume.

firmware String

Firmware used to boot VM. Select the option that matches your operating system.

isConsistentVolumeNamingEnabled Boolean

Whether to enable consistent volume naming feature. Defaults to false.

isPvEncryptionInTransitEnabled Boolean

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

networkType String

Emulation type for the physical network interface card (NIC).

remoteDataVolumeType String

Emulation type for volume.

bootVolumeType string

Emulation type for the boot volume.

firmware string

Firmware used to boot VM. Select the option that matches your operating system.

isConsistentVolumeNamingEnabled boolean

Whether to enable consistent volume naming feature. Defaults to false.

isPvEncryptionInTransitEnabled boolean

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

networkType string

Emulation type for the physical network interface card (NIC).

remoteDataVolumeType string

Emulation type for volume.

boot_volume_type str

Emulation type for the boot volume.

firmware str

Firmware used to boot VM. Select the option that matches your operating system.

is_consistent_volume_naming_enabled bool

Whether to enable consistent volume naming feature. Defaults to false.

is_pv_encryption_in_transit_enabled bool

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

network_type str

Emulation type for the physical network interface card (NIC).

remote_data_volume_type str

Emulation type for volume.

bootVolumeType String

Emulation type for the boot volume.

firmware String

Firmware used to boot VM. Select the option that matches your operating system.

isConsistentVolumeNamingEnabled Boolean

Whether to enable consistent volume naming feature. Defaults to false.

isPvEncryptionInTransitEnabled Boolean

Deprecated. Instead use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.

networkType String

Emulation type for the physical network interface card (NIC).

remoteDataVolumeType String

Emulation type for volume.

GetInstancePlatformConfig

AreVirtualInstructionsEnabled bool

Whether virtualization instructions are available.

IsAccessControlServiceEnabled bool

Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device passthrough.

IsInputOutputMemoryManagementUnitEnabled bool

Whether the input-output memory management unit is enabled.

IsMeasuredBootEnabled bool

Whether the Measured Boot is to be enabled on the instance

IsSecureBootEnabled bool

Whether the Secure Boot is to be enabled on the instance.

IsSymmetricMultiThreadingEnabled bool

Whether symmetric multi-threading is enabled on the instance.

IsTrustedPlatformModuleEnabled bool

Whether the Trusted Platform Module (TPM) is to be enabled on the instance.

NumaNodesPerSocket string

The number of NUMA nodes per socket (NPS).

PercentageOfCoresEnabled int

The percentage of cores enabled.

Type string

(Required) The type of action to run when the instance is interrupted for eviction.

AreVirtualInstructionsEnabled bool

Whether virtualization instructions are available.

IsAccessControlServiceEnabled bool

Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device passthrough.

IsInputOutputMemoryManagementUnitEnabled bool

Whether the input-output memory management unit is enabled.

IsMeasuredBootEnabled bool

Whether the Measured Boot is to be enabled on the instance

IsSecureBootEnabled bool

Whether the Secure Boot is to be enabled on the instance.

IsSymmetricMultiThreadingEnabled bool

Whether symmetric multi-threading is enabled on the instance.

IsTrustedPlatformModuleEnabled bool

Whether the Trusted Platform Module (TPM) is to be enabled on the instance.

NumaNodesPerSocket string

The number of NUMA nodes per socket (NPS).

PercentageOfCoresEnabled int

The percentage of cores enabled.

Type string

(Required) The type of action to run when the instance is interrupted for eviction.

areVirtualInstructionsEnabled Boolean

Whether virtualization instructions are available.

isAccessControlServiceEnabled Boolean

Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device passthrough.

isInputOutputMemoryManagementUnitEnabled Boolean

Whether the input-output memory management unit is enabled.

isMeasuredBootEnabled Boolean

Whether the Measured Boot is to be enabled on the instance

isSecureBootEnabled Boolean

Whether the Secure Boot is to be enabled on the instance.

isSymmetricMultiThreadingEnabled Boolean

Whether symmetric multi-threading is enabled on the instance.

isTrustedPlatformModuleEnabled Boolean

Whether the Trusted Platform Module (TPM) is to be enabled on the instance.

numaNodesPerSocket String

The number of NUMA nodes per socket (NPS).

percentageOfCoresEnabled Integer

The percentage of cores enabled.

type String

(Required) The type of action to run when the instance is interrupted for eviction.

areVirtualInstructionsEnabled boolean

Whether virtualization instructions are available.

isAccessControlServiceEnabled boolean

Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device passthrough.

isInputOutputMemoryManagementUnitEnabled boolean

Whether the input-output memory management unit is enabled.

isMeasuredBootEnabled boolean

Whether the Measured Boot is to be enabled on the instance

isSecureBootEnabled boolean

Whether the Secure Boot is to be enabled on the instance.

isSymmetricMultiThreadingEnabled boolean

Whether symmetric multi-threading is enabled on the instance.

isTrustedPlatformModuleEnabled boolean

Whether the Trusted Platform Module (TPM) is to be enabled on the instance.

numaNodesPerSocket string

The number of NUMA nodes per socket (NPS).

percentageOfCoresEnabled number

The percentage of cores enabled.

type string

(Required) The type of action to run when the instance is interrupted for eviction.

are_virtual_instructions_enabled bool

Whether virtualization instructions are available.

is_access_control_service_enabled bool

Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device passthrough.

is_input_output_memory_management_unit_enabled bool

Whether the input-output memory management unit is enabled.

is_measured_boot_enabled bool

Whether the Measured Boot is to be enabled on the instance

is_secure_boot_enabled bool

Whether the Secure Boot is to be enabled on the instance.

is_symmetric_multi_threading_enabled bool

Whether symmetric multi-threading is enabled on the instance.

is_trusted_platform_module_enabled bool

Whether the Trusted Platform Module (TPM) is to be enabled on the instance.

numa_nodes_per_socket str

The number of NUMA nodes per socket (NPS).

percentage_of_cores_enabled int

The percentage of cores enabled.

type str

(Required) The type of action to run when the instance is interrupted for eviction.

areVirtualInstructionsEnabled Boolean

Whether virtualization instructions are available.

isAccessControlServiceEnabled Boolean

Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device passthrough.

isInputOutputMemoryManagementUnitEnabled Boolean

Whether the input-output memory management unit is enabled.

isMeasuredBootEnabled Boolean

Whether the Measured Boot is to be enabled on the instance

isSecureBootEnabled Boolean

Whether the Secure Boot is to be enabled on the instance.

isSymmetricMultiThreadingEnabled Boolean

Whether symmetric multi-threading is enabled on the instance.

isTrustedPlatformModuleEnabled Boolean

Whether the Trusted Platform Module (TPM) is to be enabled on the instance.

numaNodesPerSocket String

The number of NUMA nodes per socket (NPS).

percentageOfCoresEnabled Number

The percentage of cores enabled.

type String

(Required) The type of action to run when the instance is interrupted for eviction.

GetInstancePreemptibleInstanceConfig

PreemptionActions List<GetInstancePreemptibleInstanceConfigPreemptionAction>

(Required) The action to run when the preemptible instance is interrupted for eviction.

PreemptionActions []GetInstancePreemptibleInstanceConfigPreemptionAction

(Required) The action to run when the preemptible instance is interrupted for eviction.

preemptionActions List<GetInstancePreemptibleInstanceConfigPreemptionAction>

(Required) The action to run when the preemptible instance is interrupted for eviction.

preemptionActions GetInstancePreemptibleInstanceConfigPreemptionAction[]

(Required) The action to run when the preemptible instance is interrupted for eviction.

preemption_actions GetInstancePreemptibleInstanceConfigPreemptionAction]

(Required) The action to run when the preemptible instance is interrupted for eviction.

preemptionActions List<Property Map>

(Required) The action to run when the preemptible instance is interrupted for eviction.

GetInstancePreemptibleInstanceConfigPreemptionAction

PreserveBootVolume bool

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

Type string

(Required) The type of action to run when the instance is interrupted for eviction.

PreserveBootVolume bool

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

Type string

(Required) The type of action to run when the instance is interrupted for eviction.

preserveBootVolume Boolean

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

type String

(Required) The type of action to run when the instance is interrupted for eviction.

preserveBootVolume boolean

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

type string

(Required) The type of action to run when the instance is interrupted for eviction.

preserve_boot_volume bool

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

type str

(Required) The type of action to run when the instance is interrupted for eviction.

preserveBootVolume Boolean

(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

type String

(Required) The type of action to run when the instance is interrupted for eviction.

GetInstanceShapeConfig

BaselineOcpuUtilization string

The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.

GpuDescription string

A short description of the instance's graphics processing unit (GPU).

Gpus int

The number of GPUs available to the instance.

LocalDiskDescription string

A short description of the local disks available to this instance.

LocalDisks int

The number of local disks available to the instance.

LocalDisksTotalSizeInGbs double

The aggregate size of all local disks, in gigabytes.

MaxVnicAttachments int

The maximum number of VNIC attachments for the instance.

MemoryInGbs double

The total amount of memory available to the instance, in gigabytes.

NetworkingBandwidthInGbps double

The networking bandwidth available to the instance, in gigabits per second.

Nvmes int
Ocpus double

The total number of OCPUs available to the instance.

ProcessorDescription string

A short description of the instance's processor (CPU).

BaselineOcpuUtilization string

The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.

GpuDescription string

A short description of the instance's graphics processing unit (GPU).

Gpus int

The number of GPUs available to the instance.

LocalDiskDescription string

A short description of the local disks available to this instance.

LocalDisks int

The number of local disks available to the instance.

LocalDisksTotalSizeInGbs float64

The aggregate size of all local disks, in gigabytes.

MaxVnicAttachments int

The maximum number of VNIC attachments for the instance.

MemoryInGbs float64

The total amount of memory available to the instance, in gigabytes.

NetworkingBandwidthInGbps float64

The networking bandwidth available to the instance, in gigabits per second.

Nvmes int
Ocpus float64

The total number of OCPUs available to the instance.

ProcessorDescription string

A short description of the instance's processor (CPU).

baselineOcpuUtilization String

The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.

gpuDescription String

A short description of the instance's graphics processing unit (GPU).

gpus Integer

The number of GPUs available to the instance.

localDiskDescription String

A short description of the local disks available to this instance.

localDisks Integer

The number of local disks available to the instance.

localDisksTotalSizeInGbs Double

The aggregate size of all local disks, in gigabytes.

maxVnicAttachments Integer

The maximum number of VNIC attachments for the instance.

memoryInGbs Double

The total amount of memory available to the instance, in gigabytes.

networkingBandwidthInGbps Double

The networking bandwidth available to the instance, in gigabits per second.

nvmes Integer
ocpus Double

The total number of OCPUs available to the instance.

processorDescription String

A short description of the instance's processor (CPU).

baselineOcpuUtilization string

The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.

gpuDescription string

A short description of the instance's graphics processing unit (GPU).

gpus number

The number of GPUs available to the instance.

localDiskDescription string

A short description of the local disks available to this instance.

localDisks number

The number of local disks available to the instance.

localDisksTotalSizeInGbs number

The aggregate size of all local disks, in gigabytes.

maxVnicAttachments number

The maximum number of VNIC attachments for the instance.

memoryInGbs number

The total amount of memory available to the instance, in gigabytes.

networkingBandwidthInGbps number

The networking bandwidth available to the instance, in gigabits per second.

nvmes number
ocpus number

The total number of OCPUs available to the instance.

processorDescription string

A short description of the instance's processor (CPU).

baseline_ocpu_utilization str

The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.

gpu_description str

A short description of the instance's graphics processing unit (GPU).

gpus int

The number of GPUs available to the instance.

local_disk_description str

A short description of the local disks available to this instance.

local_disks int

The number of local disks available to the instance.

local_disks_total_size_in_gbs float

The aggregate size of all local disks, in gigabytes.

max_vnic_attachments int

The maximum number of VNIC attachments for the instance.

memory_in_gbs float

The total amount of memory available to the instance, in gigabytes.

networking_bandwidth_in_gbps float

The networking bandwidth available to the instance, in gigabits per second.

nvmes int
ocpus float

The total number of OCPUs available to the instance.

processor_description str

A short description of the instance's processor (CPU).

baselineOcpuUtilization String

The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.

gpuDescription String

A short description of the instance's graphics processing unit (GPU).

gpus Number

The number of GPUs available to the instance.

localDiskDescription String

A short description of the local disks available to this instance.

localDisks Number

The number of local disks available to the instance.

localDisksTotalSizeInGbs Number

The aggregate size of all local disks, in gigabytes.

maxVnicAttachments Number

The maximum number of VNIC attachments for the instance.

memoryInGbs Number

The total amount of memory available to the instance, in gigabytes.

networkingBandwidthInGbps Number

The networking bandwidth available to the instance, in gigabits per second.

nvmes Number
ocpus Number

The total number of OCPUs available to the instance.

processorDescription String

A short description of the instance's processor (CPU).

GetInstanceSourceDetail

BootVolumeSizeInGbs string

The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).

BootVolumeVpusPerGb string

The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

KmsKeyId string

The OCID of the Key Management key to assign as the master encryption key for the boot volume.

SourceId string

The OCID of an image or a boot volume to use, depending on the value of source_type.

SourceType string

The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.

BootVolumeSizeInGbs string

The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).

BootVolumeVpusPerGb string

The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

KmsKeyId string

The OCID of the Key Management key to assign as the master encryption key for the boot volume.

SourceId string

The OCID of an image or a boot volume to use, depending on the value of source_type.

SourceType string

The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.

bootVolumeSizeInGbs String

The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).

bootVolumeVpusPerGb String

The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

kmsKeyId String

The OCID of the Key Management key to assign as the master encryption key for the boot volume.

sourceId String

The OCID of an image or a boot volume to use, depending on the value of source_type.

sourceType String

The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.

bootVolumeSizeInGbs string

The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).

bootVolumeVpusPerGb string

The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

kmsKeyId string

The OCID of the Key Management key to assign as the master encryption key for the boot volume.

sourceId string

The OCID of an image or a boot volume to use, depending on the value of source_type.

sourceType string

The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.

boot_volume_size_in_gbs str

The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).

boot_volume_vpus_per_gb str

The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

kms_key_id str

The OCID of the Key Management key to assign as the master encryption key for the boot volume.

source_id str

The OCID of an image or a boot volume to use, depending on the value of source_type.

source_type str

The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.

bootVolumeSizeInGbs String

The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).

bootVolumeVpusPerGb String

The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

kmsKeyId String

The OCID of the Key Management key to assign as the master encryption key for the boot volume.

sourceId String

The OCID of an image or a boot volume to use, depending on the value of source_type.

sourceType String

The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.