Oracle Cloud Infrastructure

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

getInstancePool

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

Gets the specified instance pool

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testInstancePool = Oci.Core.GetInstancePool.Invoke(new()
    {
        InstancePoolId = oci_core_instance_pool.Test_instance_pool.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.GetInstancePool(ctx, &core.GetInstancePoolArgs{
			InstancePoolId: oci_core_instance_pool.Test_instance_pool.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.GetInstancePoolArgs;
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 testInstancePool = CoreFunctions.getInstancePool(GetInstancePoolArgs.builder()
            .instancePoolId(oci_core_instance_pool.test_instance_pool().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_instance_pool = oci.Core.get_instance_pool(instance_pool_id=oci_core_instance_pool["test_instance_pool"]["id"])

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

const testInstancePool = oci.Core.getInstancePool({
    instancePoolId: oci_core_instance_pool.test_instance_pool.id,
});

variables:
  testInstancePool:
    Fn::Invoke:
      Function: oci:Core:getInstancePool
      Arguments:
        instancePoolId: ${oci_core_instance_pool.test_instance_pool.id}

Using getInstancePool

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 getInstancePool(args: GetInstancePoolArgs, opts?: InvokeOptions): Promise<GetInstancePoolResult>
function getInstancePoolOutput(args: GetInstancePoolOutputArgs, opts?: InvokeOptions): Output<GetInstancePoolResult>

def get_instance_pool(instance_pool_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetInstancePoolResult
def get_instance_pool_output(instance_pool_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetInstancePoolResult]

func GetInstancePool(ctx *Context, args *GetInstancePoolArgs, opts ...InvokeOption) (*GetInstancePoolResult, error)
func GetInstancePoolOutput(ctx *Context, args *GetInstancePoolOutputArgs, opts ...InvokeOption) GetInstancePoolResultOutput

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

public static class GetInstancePool 
{
    public static Task<GetInstancePoolResult> InvokeAsync(GetInstancePoolArgs args, InvokeOptions? opts = null)
    public static Output<GetInstancePoolResult> Invoke(GetInstancePoolInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInstancePoolResult> getInstancePool(GetInstancePoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

InstancePoolId string: The OCID of the instance pool.

InstancePoolId string: The OCID of the instance pool.

instancePoolId String: The OCID of the instance pool.

instancePoolId string: The OCID of the instance pool.

instance_pool_id str: The OCID of the instance pool.

instancePoolId String: The OCID of the instance pool.

getInstancePool Result

The following output properties are available:

ActualSize int
CompartmentId string: The OCID of the compartment containing the instance pool.
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: The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
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"}
Id string: The OCID of the load balancer attachment.
InstanceConfigurationId string: The OCID of the instance configuration associated with the instance pool.
InstancePoolId string: The OCID of the instance pool of the load balancer attachment.
LoadBalancers List<GetInstancePoolLoadBalancer>: The load balancers attached to the instance pool.
PlacementConfigurations List<GetInstancePoolPlacementConfiguration>: The placement configurations for the instance pool.
Size int: The number of actual instances in the instance pool on the cloud. This attribute will be different when instance pool is used along with autoScaling Configuration.
State string: The current state of the instance pool.
TimeCreated string: The date and time the instance pool was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

ActualSize int
CompartmentId string: The OCID of the compartment containing the instance pool.
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: The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
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"}
Id string: The OCID of the load balancer attachment.
InstanceConfigurationId string: The OCID of the instance configuration associated with the instance pool.
InstancePoolId string: The OCID of the instance pool of the load balancer attachment.
LoadBalancers []GetInstancePoolLoadBalancer: The load balancers attached to the instance pool.
PlacementConfigurations []GetInstancePoolPlacementConfiguration: The placement configurations for the instance pool.
Size int: The number of actual instances in the instance pool on the cloud. This attribute will be different when instance pool is used along with autoScaling Configuration.
State string: The current state of the instance pool.
TimeCreated string: The date and time the instance pool was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

actualSize Integer
compartmentId String: The OCID of the compartment containing the instance pool.
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: The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
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"}
id String: The OCID of the load balancer attachment.
instanceConfigurationId String: The OCID of the instance configuration associated with the instance pool.
instancePoolId String: The OCID of the instance pool of the load balancer attachment.
loadBalancers List<GetInstancePoolLoadBalancer>: The load balancers attached to the instance pool.
placementConfigurations List<GetInstancePoolPlacementConfiguration>: The placement configurations for the instance pool.
size Integer: The number of actual instances in the instance pool on the cloud. This attribute will be different when instance pool is used along with autoScaling Configuration.
state String: The current state of the instance pool.
timeCreated String: The date and time the instance pool was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

actualSize number
compartmentId string: The OCID of the compartment containing the instance pool.
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: The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
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"}
id string: The OCID of the load balancer attachment.
instanceConfigurationId string: The OCID of the instance configuration associated with the instance pool.
instancePoolId string: The OCID of the instance pool of the load balancer attachment.
loadBalancers GetInstancePoolLoadBalancer[]: The load balancers attached to the instance pool.
placementConfigurations GetInstancePoolPlacementConfiguration[]: The placement configurations for the instance pool.
size number: The number of actual instances in the instance pool on the cloud. This attribute will be different when instance pool is used along with autoScaling Configuration.
state string: The current state of the instance pool.
timeCreated string: The date and time the instance pool was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

actual_size int
compartment_id str: The OCID of the compartment containing the instance pool.
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: The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
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"}
id str: The OCID of the load balancer attachment.
instance_configuration_id str: The OCID of the instance configuration associated with the instance pool.
instance_pool_id str: The OCID of the instance pool of the load balancer attachment.
load_balancers GetInstancePoolLoadBalancer]: The load balancers attached to the instance pool.
placement_configurations GetInstancePoolPlacementConfiguration]: The placement configurations for the instance pool.
size int: The number of actual instances in the instance pool on the cloud. This attribute will be different when instance pool is used along with autoScaling Configuration.
state str: The current state of the instance pool.
time_created str: The date and time the instance pool was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

actualSize Number
compartmentId String: The OCID of the compartment containing the instance pool.
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: The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
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"}
id String: The OCID of the load balancer attachment.
instanceConfigurationId String: The OCID of the instance configuration associated with the instance pool.
instancePoolId String: The OCID of the instance pool of the load balancer attachment.
loadBalancers List<Property Map>: The load balancers attached to the instance pool.
placementConfigurations List<Property Map>: The placement configurations for the instance pool.
size Number: The number of actual instances in the instance pool on the cloud. This attribute will be different when instance pool is used along with autoScaling Configuration.
state String: The current state of the instance pool.
timeCreated String: The date and time the instance pool was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Supporting Types

GetInstancePoolLoadBalancer

BackendSetName string: The name of the backend set on the load balancer.
Id string: The OCID of the load balancer attachment.
InstancePoolId string: The OCID of the instance pool.
LoadBalancerId string: The OCID of the load balancer attached to the instance pool.
Port int: The port value used for the backends.
State string: The current state of the instance pool.
VnicSelection string: Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. Possible values are "PrimaryVnic" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.

BackendSetName string: The name of the backend set on the load balancer.
Id string: The OCID of the load balancer attachment.
InstancePoolId string: The OCID of the instance pool.
LoadBalancerId string: The OCID of the load balancer attached to the instance pool.
Port int: The port value used for the backends.
State string: The current state of the instance pool.
VnicSelection string: Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. Possible values are "PrimaryVnic" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.

backendSetName String: The name of the backend set on the load balancer.
id String: The OCID of the load balancer attachment.
instancePoolId String: The OCID of the instance pool.
loadBalancerId String: The OCID of the load balancer attached to the instance pool.
port Integer: The port value used for the backends.
state String: The current state of the instance pool.
vnicSelection String: Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. Possible values are "PrimaryVnic" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.

backendSetName string: The name of the backend set on the load balancer.
id string: The OCID of the load balancer attachment.
instancePoolId string: The OCID of the instance pool.
loadBalancerId string: The OCID of the load balancer attached to the instance pool.
port number: The port value used for the backends.
state string: The current state of the instance pool.
vnicSelection string: Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. Possible values are "PrimaryVnic" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.

backend_set_name str: The name of the backend set on the load balancer.
id str: The OCID of the load balancer attachment.
instance_pool_id str: The OCID of the instance pool.
load_balancer_id str: The OCID of the load balancer attached to the instance pool.
port int: The port value used for the backends.
state str: The current state of the instance pool.
vnic_selection str: Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. Possible values are "PrimaryVnic" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.

backendSetName String: The name of the backend set on the load balancer.
id String: The OCID of the load balancer attachment.
instancePoolId String: The OCID of the instance pool.
loadBalancerId String: The OCID of the load balancer attached to the instance pool.
port Number: The port value used for the backends.
state String: The current state of the instance pool.
vnicSelection String: Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. Possible values are "PrimaryVnic" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.

GetInstancePoolPlacementConfiguration

AvailabilityDomain string: The availability domain to place instances. Example: Uocm:PHX-AD-1
FaultDomains List<string>: The fault domains to place instances.
PrimarySubnetId string: The OCID of the primary subnet to place instances.
SecondaryVnicSubnets List<GetInstancePoolPlacementConfigurationSecondaryVnicSubnet>: The set of secondary VNIC data for instances in the pool.

AvailabilityDomain string: The availability domain to place instances. Example: Uocm:PHX-AD-1
FaultDomains []string: The fault domains to place instances.
PrimarySubnetId string: The OCID of the primary subnet to place instances.
SecondaryVnicSubnets []GetInstancePoolPlacementConfigurationSecondaryVnicSubnet: The set of secondary VNIC data for instances in the pool.

availabilityDomain String: The availability domain to place instances. Example: Uocm:PHX-AD-1
faultDomains List<String>: The fault domains to place instances.
primarySubnetId String: The OCID of the primary subnet to place instances.
secondaryVnicSubnets List<GetInstancePoolPlacementConfigurationSecondaryVnicSubnet>: The set of secondary VNIC data for instances in the pool.

availabilityDomain string: The availability domain to place instances. Example: Uocm:PHX-AD-1
faultDomains string[]: The fault domains to place instances.
primarySubnetId string: The OCID of the primary subnet to place instances.
secondaryVnicSubnets GetInstancePoolPlacementConfigurationSecondaryVnicSubnet[]: The set of secondary VNIC data for instances in the pool.

availability_domain str: The availability domain to place instances. Example: Uocm:PHX-AD-1
fault_domains Sequence[str]: The fault domains to place instances.
primary_subnet_id str: The OCID of the primary subnet to place instances.
secondary_vnic_subnets GetInstancePoolPlacementConfigurationSecondaryVnicSubnet]: The set of secondary VNIC data for instances in the pool.

availabilityDomain String: The availability domain to place instances. Example: Uocm:PHX-AD-1
faultDomains List<String>: The fault domains to place instances.
primarySubnetId String: The OCID of the primary subnet to place instances.
secondaryVnicSubnets List<Property Map>: The set of secondary VNIC data for instances in the pool.

GetInstancePoolPlacementConfigurationSecondaryVnicSubnet

DisplayName string: The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
SubnetId string: The subnet OCID for the secondary VNIC.

DisplayName string: The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
SubnetId string: The subnet OCID for the secondary VNIC.

displayName String: The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
subnetId String: The subnet OCID for the secondary VNIC.

displayName string: The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
subnetId string: The subnet OCID for the secondary VNIC.

display_name str: The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
subnet_id str: The subnet OCID for the secondary VNIC.

displayName String: The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
subnetId String: The subnet OCID for the secondary VNIC.

Package Details

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