Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Core.getInstancePoolInstances

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testInstancePoolInstances = oci.Core.getInstancePoolInstances({
    compartmentId: compartmentId,
    instancePoolId: testInstancePool.id,
    displayName: instancePoolInstanceDisplayName,
});

import pulumi
import pulumi_oci as oci

test_instance_pool_instances = oci.Core.get_instance_pool_instances(compartment_id=compartment_id,
    instance_pool_id=test_instance_pool["id"],
    display_name=instance_pool_instance_display_name)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.GetInstancePoolInstances(ctx, &core.GetInstancePoolInstancesArgs{
			CompartmentId:  compartmentId,
			InstancePoolId: testInstancePool.Id,
			DisplayName:    pulumi.StringRef(instancePoolInstanceDisplayName),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testInstancePoolInstances = Oci.Core.GetInstancePoolInstances.Invoke(new()
    {
        CompartmentId = compartmentId,
        InstancePoolId = testInstancePool.Id,
        DisplayName = instancePoolInstanceDisplayName,
    });

});

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.GetInstancePoolInstancesArgs;
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 testInstancePoolInstances = CoreFunctions.getInstancePoolInstances(GetInstancePoolInstancesArgs.builder()
            .compartmentId(compartmentId)
            .instancePoolId(testInstancePool.id())
            .displayName(instancePoolInstanceDisplayName)
            .build());

    }
}

variables:
  testInstancePoolInstances:
    fn::invoke:
      function: oci:Core:getInstancePoolInstances
      arguments:
        compartmentId: ${compartmentId}
        instancePoolId: ${testInstancePool.id}
        displayName: ${instancePoolInstanceDisplayName}

Using getInstancePoolInstances

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.

TypeScript
Python
Go
C#
Java
YAML

function getInstancePoolInstances(args: GetInstancePoolInstancesArgs, opts?: InvokeOptions): Promise<GetInstancePoolInstancesResult>
function getInstancePoolInstancesOutput(args: GetInstancePoolInstancesOutputArgs, opts?: InvokeOptions): Output<GetInstancePoolInstancesResult>

def get_instance_pool_instances(compartment_id: Optional[str] = None,
                                display_name: Optional[str] = None,
                                filters: Optional[Sequence[_core.GetInstancePoolInstancesFilter]] = None,
                                instance_pool_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetInstancePoolInstancesResult
def get_instance_pool_instances_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                display_name: Optional[pulumi.Input[str]] = None,
                                filters: Optional[pulumi.Input[Sequence[pulumi.Input[_core.GetInstancePoolInstancesFilterArgs]]]] = None,
                                instance_pool_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetInstancePoolInstancesResult]

func GetInstancePoolInstances(ctx *Context, args *GetInstancePoolInstancesArgs, opts ...InvokeOption) (*GetInstancePoolInstancesResult, error)
func GetInstancePoolInstancesOutput(ctx *Context, args *GetInstancePoolInstancesOutputArgs, opts ...InvokeOption) GetInstancePoolInstancesResultOutput

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

public static class GetInstancePoolInstances 
{
    public static Task<GetInstancePoolInstancesResult> InvokeAsync(GetInstancePoolInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetInstancePoolInstancesResult> Invoke(GetInstancePoolInstancesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInstancePoolInstancesResult> getInstancePoolInstances(GetInstancePoolInstancesArgs args, InvokeOptions options)
public static Output<GetInstancePoolInstancesResult> getInstancePoolInstances(GetInstancePoolInstancesArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Core/getInstancePoolInstances:getInstancePoolInstances
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment.
InstancePoolId string: The OCID of the instance pool.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters List<GetInstancePoolInstancesFilter>

CompartmentId string: The OCID of the compartment.
InstancePoolId string: The OCID of the instance pool.
DisplayName string: A filter to return only resources that match the given display name exactly.
Filters []GetInstancePoolInstancesFilter

compartmentId String: The OCID of the compartment.
instancePoolId String: The OCID of the instance pool.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<GetInstancePoolInstancesFilter>

compartmentId string: The OCID of the compartment.
instancePoolId string: The OCID of the instance pool.
displayName string: A filter to return only resources that match the given display name exactly.
filters GetInstancePoolInstancesFilter[]

compartment_id str: The OCID of the compartment.
instance_pool_id str: The OCID of the instance pool.
display_name str: A filter to return only resources that match the given display name exactly.
filters Sequence[core.GetInstancePoolInstancesFilter]

compartmentId String: The OCID of the compartment.
instancePoolId String: The OCID of the instance pool.
displayName String: A filter to return only resources that match the given display name exactly.
filters List<Property Map>

getInstancePoolInstances Result

The following output properties are available:

CompartmentId string: The OCID of the compartment that contains the instance.
Id string: The provider-assigned unique ID for this managed resource.
InstancePoolId string
Instances List<GetInstancePoolInstancesInstance>: The list of instances.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters List<GetInstancePoolInstancesFilter>

CompartmentId string: The OCID of the compartment that contains the instance.
Id string: The provider-assigned unique ID for this managed resource.
InstancePoolId string
Instances []GetInstancePoolInstancesInstance: The list of instances.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters []GetInstancePoolInstancesFilter

compartmentId String: The OCID of the compartment that contains the instance.
id String: The provider-assigned unique ID for this managed resource.
instancePoolId String
instances List<GetInstancePoolInstancesInstance>: The list of instances.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<GetInstancePoolInstancesFilter>

compartmentId string: The OCID of the compartment that contains the instance.
id string: The provider-assigned unique ID for this managed resource.
instancePoolId string
instances GetInstancePoolInstancesInstance[]: The list of instances.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters GetInstancePoolInstancesFilter[]

compartment_id str: The OCID of the compartment that contains the instance.
id str: The provider-assigned unique ID for this managed resource.
instance_pool_id str
instances Sequence[core.GetInstancePoolInstancesInstance]: The list of instances.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters Sequence[core.GetInstancePoolInstancesFilter]

compartmentId String: The OCID of the compartment that contains the instance.
id String: The provider-assigned unique ID for this managed resource.
instancePoolId String
instances List<Property Map>: The list of instances.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<Property Map>

Supporting Types

GetInstancePoolInstancesFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

GetInstancePoolInstancesInstance

AutoTerminateInstanceOnDelete bool
AvailabilityDomain string: The availability domain the instance is running in.
CompartmentId string: The OCID of the compartment.
DecrementSizeOnDelete bool
DisplayName string: A filter to return only resources that match the given display name exactly.
FaultDomain string: The fault domain the instance is running in.
Id string: The OCID of the instance.
InstanceConfigurationId string: The OCID of the instance configuration used to create the instance.
InstanceId string
InstancePoolId string: The OCID of the instance pool.
LoadBalancerBackends List<GetInstancePoolInstancesInstanceLoadBalancerBackend>: The load balancer backends that are configured for the instance pool instance.
Region string: The region that contains the availability domain the instance is running in.
Shape string: The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.
State string: The lifecycle state of the instance. Refer to lifecycleState in the Instance resource.
TimeCreated string: The date and time the instance pool instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

AutoTerminateInstanceOnDelete bool
AvailabilityDomain string: The availability domain the instance is running in.
CompartmentId string: The OCID of the compartment.
DecrementSizeOnDelete bool
DisplayName string: A filter to return only resources that match the given display name exactly.
FaultDomain string: The fault domain the instance is running in.
Id string: The OCID of the instance.
InstanceConfigurationId string: The OCID of the instance configuration used to create the instance.
InstanceId string
InstancePoolId string: The OCID of the instance pool.
LoadBalancerBackends []GetInstancePoolInstancesInstanceLoadBalancerBackend: The load balancer backends that are configured for the instance pool instance.
Region string: The region that contains the availability domain the instance is running in.
Shape string: The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.
State string: The lifecycle state of the instance. Refer to lifecycleState in the Instance resource.
TimeCreated string: The date and time the instance pool instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

autoTerminateInstanceOnDelete Boolean
availabilityDomain String: The availability domain the instance is running in.
compartmentId String: The OCID of the compartment.
decrementSizeOnDelete Boolean
displayName String: A filter to return only resources that match the given display name exactly.
faultDomain String: The fault domain the instance is running in.
id String: The OCID of the instance.
instanceConfigurationId String: The OCID of the instance configuration used to create the instance.
instanceId String
instancePoolId String: The OCID of the instance pool.
loadBalancerBackends List<GetInstancePoolInstancesInstanceLoadBalancerBackend>: The load balancer backends that are configured for the instance pool instance.
region String: The region that contains the availability domain the instance is running in.
shape String: The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.
state String: The lifecycle state of the instance. Refer to lifecycleState in the Instance resource.
timeCreated String: The date and time the instance pool instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

autoTerminateInstanceOnDelete boolean
availabilityDomain string: The availability domain the instance is running in.
compartmentId string: The OCID of the compartment.
decrementSizeOnDelete boolean
displayName string: A filter to return only resources that match the given display name exactly.
faultDomain string: The fault domain the instance is running in.
id string: The OCID of the instance.
instanceConfigurationId string: The OCID of the instance configuration used to create the instance.
instanceId string
instancePoolId string: The OCID of the instance pool.
loadBalancerBackends GetInstancePoolInstancesInstanceLoadBalancerBackend[]: The load balancer backends that are configured for the instance pool instance.
region string: The region that contains the availability domain the instance is running in.
shape string: The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.
state string: The lifecycle state of the instance. Refer to lifecycleState in the Instance resource.
timeCreated string: The date and time the instance pool instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

auto_terminate_instance_on_delete bool
availability_domain str: The availability domain the instance is running in.
compartment_id str: The OCID of the compartment.
decrement_size_on_delete bool
display_name str: A filter to return only resources that match the given display name exactly.
fault_domain str: The fault domain the instance is running in.
id str: The OCID of the instance.
instance_configuration_id str: The OCID of the instance configuration used to create the instance.
instance_id str
instance_pool_id str: The OCID of the instance pool.
load_balancer_backends Sequence[core.GetInstancePoolInstancesInstanceLoadBalancerBackend]: The load balancer backends that are configured for the instance pool instance.
region str: The region that contains the availability domain the instance is running in.
shape str: The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.
state str: The lifecycle state of the instance. Refer to lifecycleState in the Instance resource.
time_created str: The date and time the instance pool instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

autoTerminateInstanceOnDelete Boolean
availabilityDomain String: The availability domain the instance is running in.
compartmentId String: The OCID of the compartment.
decrementSizeOnDelete Boolean
displayName String: A filter to return only resources that match the given display name exactly.
faultDomain String: The fault domain the instance is running in.
id String: The OCID of the instance.
instanceConfigurationId String: The OCID of the instance configuration used to create the instance.
instanceId String
instancePoolId String: The OCID of the instance pool.
loadBalancerBackends List<Property Map>: The load balancer backends that are configured for the instance pool instance.
region String: The region that contains the availability domain the instance is running in.
shape String: The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.
state String: The lifecycle state of the instance. Refer to lifecycleState in the Instance resource.
timeCreated String: The date and time the instance pool instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

GetInstancePoolInstancesInstanceLoadBalancerBackend

BackendHealthStatus string: The health of the backend as observed by the load balancer.
BackendName string: The name of the backend in the backend set.
BackendSetName string: The name of the backend set on the load balancer.
LoadBalancerId string: The OCID of the load balancer attached to the instance pool.
State string: The lifecycle state of the instance. Refer to lifecycleState in the Instance resource.

BackendHealthStatus string: The health of the backend as observed by the load balancer.
BackendName string: The name of the backend in the backend set.
BackendSetName string: The name of the backend set on the load balancer.
LoadBalancerId string: The OCID of the load balancer attached to the instance pool.
State string: The lifecycle state of the instance. Refer to lifecycleState in the Instance resource.

backendHealthStatus String: The health of the backend as observed by the load balancer.
backendName String: The name of the backend in the backend set.
backendSetName String: The name of the backend set on the load balancer.
loadBalancerId String: The OCID of the load balancer attached to the instance pool.
state String: The lifecycle state of the instance. Refer to lifecycleState in the Instance resource.

backendHealthStatus string: The health of the backend as observed by the load balancer.
backendName string: The name of the backend in the backend set.
backendSetName string: The name of the backend set on the load balancer.
loadBalancerId string: The OCID of the load balancer attached to the instance pool.
state string: The lifecycle state of the instance. Refer to lifecycleState in the Instance resource.

backend_health_status str: The health of the backend as observed by the load balancer.
backend_name str: The name of the backend in the backend set.
backend_set_name str: The name of the backend set on the load balancer.
load_balancer_id str: The OCID of the load balancer attached to the instance pool.
state str: The lifecycle state of the instance. Refer to lifecycleState in the Instance resource.

backendHealthStatus String: The health of the backend as observed by the load balancer.
backendName String: The name of the backend in the backend set.
backendSetName String: The name of the backend set on the load balancer.
loadBalancerId String: The OCID of the load balancer attached to the instance pool.
state String: The lifecycle state of the instance. Refer to lifecycleState in the Instance resource.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.Core.getInstancePoolInstances

On this page

On this page

Example Usage

Using getInstancePoolInstances

getInstancePoolInstances Result

Supporting Types

GetInstancePoolInstancesFilter

GetInstancePoolInstancesInstance

GetInstancePoolInstancesInstanceLoadBalancerBackend

Package Details

On this page

On this page