Oracle Cloud Infrastructure
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 Pulumi;
using Oci = Pulumi.Oci;
class MyStack : Stack
{
public MyStack()
{
var testInstancePool = Output.Create(Oci.Core.GetInstancePool.InvokeAsync(new Oci.Core.GetInstancePoolArgs
{
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
})
}
Coming soon!
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,
});
Coming soon!
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:
- Instance
Pool stringId The OCID of the instance pool.
- Instance
Pool stringId The OCID of the instance pool.
- instance
Pool StringId The OCID of the instance pool.
- instance
Pool stringId The OCID of the instance pool.
- instance_
pool_ strid The OCID of the instance pool.
- instance
Pool StringId The OCID of the instance pool.
getInstancePool Result
The following output properties are available:
- Actual
Size int - Compartment
Id string The OCID of the compartment containing the instance pool.
- 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"}
- Display
Name string The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
- 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.
- Instance
Configuration stringId The OCID of the instance configuration associated with the instance pool.
- Instance
Pool stringId The OCID of the instance pool of the load balancer attachment.
- Load
Balancers List<GetInstance Pool Load Balancer> The load balancers attached to the instance pool.
- Placement
Configurations List<GetInstance Pool Placement Configuration> 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.
- Time
Created 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 string The OCID of the compartment containing the instance pool.
- 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"}
- Display
Name string The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
- 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.
- Instance
Configuration stringId The OCID of the instance configuration associated with the instance pool.
- Instance
Pool stringId The OCID of the instance pool of the load balancer attachment.
- Load
Balancers []GetInstance Pool Load Balancer The load balancers attached to the instance pool.
- Placement
Configurations []GetInstance Pool Placement Configuration 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.
- Time
Created 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 Integer - compartment
Id String The OCID of the compartment containing the instance pool.
- 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"}
- display
Name String The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
- 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.
- instance
Configuration StringId The OCID of the instance configuration associated with the instance pool.
- instance
Pool StringId The OCID of the instance pool of the load balancer attachment.
- load
Balancers List<GetInstance Pool Load Balancer> The load balancers attached to the instance pool.
- placement
Configurations List<GetInstance Pool Placement Configuration> 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.
- time
Created 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 number - compartment
Id string The OCID of the compartment containing the instance pool.
- {[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"}
- display
Name string The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
- {[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.
- instance
Configuration stringId The OCID of the instance configuration associated with the instance pool.
- instance
Pool stringId The OCID of the instance pool of the load balancer attachment.
- load
Balancers GetInstance Pool Load Balancer[] The load balancers attached to the instance pool.
- placement
Configurations GetInstance Pool Placement Configuration[] 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.
- time
Created 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.
- 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.
- 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_ strid The OCID of the instance configuration associated with the instance pool.
- instance_
pool_ strid The OCID of the instance pool of the load balancer attachment.
- load_
balancers GetInstance Pool Load Balancer] The load balancers attached to the instance pool.
- placement_
configurations GetInstance Pool Placement Configuration] 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
- actual
Size Number - compartment
Id String The OCID of the compartment containing the instance pool.
- 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"}
- display
Name String The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
- 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.
- instance
Configuration StringId The OCID of the instance configuration associated with the instance pool.
- instance
Pool StringId The OCID of the instance pool of the load balancer attachment.
- load
Balancers List<Property Map> The load balancers attached to the instance pool.
- placement
Configurations 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.
- time
Created 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
- Backend
Set stringName The name of the backend set on the load balancer.
- Id string
The OCID of the load balancer attachment.
- Instance
Pool stringId The OCID of the instance pool.
- Load
Balancer stringId 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.
- Vnic
Selection 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 stringName The name of the backend set on the load balancer.
- Id string
The OCID of the load balancer attachment.
- Instance
Pool stringId The OCID of the instance pool.
- Load
Balancer stringId 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.
- Vnic
Selection 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 StringName The name of the backend set on the load balancer.
- id String
The OCID of the load balancer attachment.
- instance
Pool StringId The OCID of the instance pool.
- load
Balancer StringId 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.
- vnic
Selection 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 stringName The name of the backend set on the load balancer.
- id string
The OCID of the load balancer attachment.
- instance
Pool stringId The OCID of the instance pool.
- load
Balancer stringId 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.
- vnic
Selection 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_ strname The name of the backend set on the load balancer.
- id str
The OCID of the load balancer attachment.
- instance_
pool_ strid The OCID of the instance pool.
- load_
balancer_ strid 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.
- backend
Set StringName The name of the backend set on the load balancer.
- id String
The OCID of the load balancer attachment.
- instance
Pool StringId The OCID of the instance pool.
- load
Balancer StringId 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.
- vnic
Selection 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
- Availability
Domain string The availability domain to place instances. Example:
Uocm:PHX-AD-1
- Fault
Domains List<string> The fault domains to place instances.
- Primary
Subnet stringId The OCID of the primary subnet to place instances.
- Secondary
Vnic List<GetSubnets Instance Pool Placement Configuration Secondary Vnic Subnet> The set of secondary VNIC data for instances in the pool.
- Availability
Domain string The availability domain to place instances. Example:
Uocm:PHX-AD-1
- Fault
Domains []string The fault domains to place instances.
- Primary
Subnet stringId The OCID of the primary subnet to place instances.
- Secondary
Vnic []GetSubnets Instance Pool Placement Configuration Secondary Vnic Subnet The set of secondary VNIC data for instances in the pool.
- availability
Domain String The availability domain to place instances. Example:
Uocm:PHX-AD-1
- fault
Domains List<String> The fault domains to place instances.
- primary
Subnet StringId The OCID of the primary subnet to place instances.
- secondary
Vnic List<GetSubnets Instance Pool Placement Configuration Secondary Vnic Subnet> The set of secondary VNIC data for instances in the pool.
- availability
Domain string The availability domain to place instances. Example:
Uocm:PHX-AD-1
- fault
Domains string[] The fault domains to place instances.
- primary
Subnet stringId The OCID of the primary subnet to place instances.
- secondary
Vnic GetSubnets Instance Pool Placement Configuration Secondary Vnic Subnet[] 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_ strid The OCID of the primary subnet to place instances.
- secondary_
vnic_ Getsubnets Instance Pool Placement Configuration Secondary Vnic Subnet] The set of secondary VNIC data for instances in the pool.
- availability
Domain String The availability domain to place instances. Example:
Uocm:PHX-AD-1
- fault
Domains List<String> The fault domains to place instances.
- primary
Subnet StringId The OCID of the primary subnet to place instances.
- secondary
Vnic List<Property Map>Subnets The set of secondary VNIC data for instances in the pool.
GetInstancePoolPlacementConfigurationSecondaryVnicSubnet
- Display
Name string The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
- Subnet
Id string The subnet OCID for the secondary VNIC.
- Display
Name string The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
- Subnet
Id string The subnet OCID for the secondary VNIC.
- display
Name String The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
- subnet
Id String The subnet OCID for the secondary VNIC.
- display
Name string The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
- subnet
Id 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.
- display
Name String The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.
- subnet
Id 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.