Oracle Cloud Infrastructure v2.11.0, Sep 19 24

Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

oci.DataFlow.getPool

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

Example Usage

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

const testPool = oci.DataFlow.getPool({
    poolId: testPoolOciDataflowPool.id,
});

import pulumi
import pulumi_oci as oci

test_pool = oci.DataFlow.get_pool(pool_id=test_pool_oci_dataflow_pool["id"])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataFlow.GetPool(ctx, &dataflow.GetPoolArgs{
			PoolId: testPoolOciDataflowPool.Id,
		}, 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 testPool = Oci.DataFlow.GetPool.Invoke(new()
    {
        PoolId = testPoolOciDataflowPool.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataFlow.DataFlowFunctions;
import com.pulumi.oci.DataFlow.inputs.GetPoolArgs;
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 testPool = DataFlowFunctions.getPool(GetPoolArgs.builder()
            .poolId(testPoolOciDataflowPool.id())
            .build());

    }
}

variables:
  testPool:
    fn::invoke:
      Function: oci:DataFlow:getPool
      Arguments:
        poolId: ${testPoolOciDataflowPool.id}

Using getPool

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 getPool(args: GetPoolArgs, opts?: InvokeOptions): Promise<GetPoolResult>
function getPoolOutput(args: GetPoolOutputArgs, opts?: InvokeOptions): Output<GetPoolResult>

def get_pool(pool_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetPoolResult
def get_pool_output(pool_id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetPoolResult]

func GetPool(ctx *Context, args *GetPoolArgs, opts ...InvokeOption) (*GetPoolResult, error)
func GetPoolOutput(ctx *Context, args *GetPoolOutputArgs, opts ...InvokeOption) GetPoolResultOutput

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

public static class GetPool 
{
    public static Task<GetPoolResult> InvokeAsync(GetPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetPoolResult> Invoke(GetPoolInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:DataFlow/getPool:getPool
  arguments:
    # arguments dictionary

The following arguments are supported:

PoolId string: The unique ID for a pool.

PoolId string: The unique ID for a pool.

poolId String: The unique ID for a pool.

poolId string: The unique ID for a pool.

pool_id str: The unique ID for a pool.

poolId String: The unique ID for a pool.

getPool Result

The following output properties are available:

CompartmentId string: The OCID of a compartment.
Configurations List<GetPoolConfiguration>: List of PoolConfig items.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: A user-friendly description. Avoid entering confidential information.
DisplayName string: A user-friendly name. It does not have to be unique. Avoid entering confidential information.
FreeformTags Dictionary<string, string>: 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 a pool. Unique Id to indentify a dataflow pool resource.
IdleTimeoutInMinutes int: Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period. If value not set, pool will not be auto stopped auto.
LifecycleDetails string: The detailed messages about the lifecycle state.
OwnerPrincipalId string: The OCID of the user who created the resource.
OwnerUserName string: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
PoolId string
PoolMetrics List<GetPoolPoolMetric>: A collection of metrics related to a particular pool.
Schedules List<GetPoolSchedule>: A list of schedules for pool to auto start and stop.
State string: The current state of this pool.
TimeCreated string: The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
TimeUpdated string: The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

CompartmentId string: The OCID of a compartment.
Configurations []GetPoolConfiguration: List of PoolConfig items.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: A user-friendly description. Avoid entering confidential information.
DisplayName string: A user-friendly name. It does not have to be unique. Avoid entering confidential information.
FreeformTags map[string]string: 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 a pool. Unique Id to indentify a dataflow pool resource.
IdleTimeoutInMinutes int: Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period. If value not set, pool will not be auto stopped auto.
LifecycleDetails string: The detailed messages about the lifecycle state.
OwnerPrincipalId string: The OCID of the user who created the resource.
OwnerUserName string: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
PoolId string
PoolMetrics []GetPoolPoolMetric: A collection of metrics related to a particular pool.
Schedules []GetPoolSchedule: A list of schedules for pool to auto start and stop.
State string: The current state of this pool.
TimeCreated string: The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
TimeUpdated string: The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

compartmentId String: The OCID of a compartment.
configurations List<GetPoolConfiguration>: List of PoolConfig items.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: A user-friendly description. Avoid entering confidential information.
displayName String: A user-friendly name. It does not have to be unique. Avoid entering confidential information.
freeformTags Map<String,String>: 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 a pool. Unique Id to indentify a dataflow pool resource.
idleTimeoutInMinutes Integer: Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period. If value not set, pool will not be auto stopped auto.
lifecycleDetails String: The detailed messages about the lifecycle state.
ownerPrincipalId String: The OCID of the user who created the resource.
ownerUserName String: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
poolId String
poolMetrics List<GetPoolPoolMetric>: A collection of metrics related to a particular pool.
schedules List<GetPoolSchedule>: A list of schedules for pool to auto start and stop.
state String: The current state of this pool.
timeCreated String: The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeUpdated String: The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

compartmentId string: The OCID of a compartment.
configurations GetPoolConfiguration[]: List of PoolConfig items.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description string: A user-friendly description. Avoid entering confidential information.
displayName string: A user-friendly name. It does not have to be unique. Avoid entering confidential information.
freeformTags {[key: string]: string}: 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 a pool. Unique Id to indentify a dataflow pool resource.
idleTimeoutInMinutes number: Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period. If value not set, pool will not be auto stopped auto.
lifecycleDetails string: The detailed messages about the lifecycle state.
ownerPrincipalId string: The OCID of the user who created the resource.
ownerUserName string: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
poolId string
poolMetrics GetPoolPoolMetric[]: A collection of metrics related to a particular pool.
schedules GetPoolSchedule[]: A list of schedules for pool to auto start and stop.
state string: The current state of this pool.
timeCreated string: The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeUpdated string: The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

compartment_id str: The OCID of a compartment.
configurations Sequence[dataflow.GetPoolConfiguration]: List of PoolConfig items.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description str: A user-friendly description. Avoid entering confidential information.
display_name str: A user-friendly name. It does not have to be unique. Avoid entering confidential information.
freeform_tags Mapping[str, str]: 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 a pool. Unique Id to indentify a dataflow pool resource.
idle_timeout_in_minutes int: Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period. If value not set, pool will not be auto stopped auto.
lifecycle_details str: The detailed messages about the lifecycle state.
owner_principal_id str: The OCID of the user who created the resource.
owner_user_name str: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
pool_id str
pool_metrics Sequence[dataflow.GetPoolPoolMetric]: A collection of metrics related to a particular pool.
schedules Sequence[dataflow.GetPoolSchedule]: A list of schedules for pool to auto start and stop.
state str: The current state of this pool.
time_created str: The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
time_updated str: The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

compartmentId String: The OCID of a compartment.
configurations List<Property Map>: List of PoolConfig items.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: A user-friendly description. Avoid entering confidential information.
displayName String: A user-friendly name. It does not have to be unique. Avoid entering confidential information.
freeformTags Map<String>: 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 a pool. Unique Id to indentify a dataflow pool resource.
idleTimeoutInMinutes Number: Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period. If value not set, pool will not be auto stopped auto.
lifecycleDetails String: The detailed messages about the lifecycle state.
ownerPrincipalId String: The OCID of the user who created the resource.
ownerUserName String: The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
poolId String
poolMetrics List<Property Map>: A collection of metrics related to a particular pool.
schedules List<Property Map>: A list of schedules for pool to auto start and stop.
state String: The current state of this pool.
timeCreated String: The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeUpdated String: The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Supporting Types

GetPoolConfiguration

Max int: Maximum number of compute instances in the pool for a given compute shape.
Min int: Minimum number of compute instances in the pool for a given compute shape.
Shape string: The compute shape of the resources you would like to provision.
ShapeConfigs List<GetPoolConfigurationShapeConfig>: This is used to configure the shape of the driver or executor if a flexible shape is used.

Max int: Maximum number of compute instances in the pool for a given compute shape.
Min int: Minimum number of compute instances in the pool for a given compute shape.
Shape string: The compute shape of the resources you would like to provision.
ShapeConfigs []GetPoolConfigurationShapeConfig: This is used to configure the shape of the driver or executor if a flexible shape is used.

max Integer: Maximum number of compute instances in the pool for a given compute shape.
min Integer: Minimum number of compute instances in the pool for a given compute shape.
shape String: The compute shape of the resources you would like to provision.
shapeConfigs List<GetPoolConfigurationShapeConfig>: This is used to configure the shape of the driver or executor if a flexible shape is used.

max number: Maximum number of compute instances in the pool for a given compute shape.
min number: Minimum number of compute instances in the pool for a given compute shape.
shape string: The compute shape of the resources you would like to provision.
shapeConfigs GetPoolConfigurationShapeConfig[]: This is used to configure the shape of the driver or executor if a flexible shape is used.

max int: Maximum number of compute instances in the pool for a given compute shape.
min int: Minimum number of compute instances in the pool for a given compute shape.
shape str: The compute shape of the resources you would like to provision.
shape_configs Sequence[dataflow.GetPoolConfigurationShapeConfig]: This is used to configure the shape of the driver or executor if a flexible shape is used.

max Number: Maximum number of compute instances in the pool for a given compute shape.
min Number: Minimum number of compute instances in the pool for a given compute shape.
shape String: The compute shape of the resources you would like to provision.
shapeConfigs List<Property Map>: This is used to configure the shape of the driver or executor if a flexible shape is used.

GetPoolConfigurationShapeConfig

MemoryInGbs double: The amount of memory used for the driver or executors.
Ocpus double: The total number of OCPUs used for the driver or executors. See here for details.

MemoryInGbs float64: The amount of memory used for the driver or executors.
Ocpus float64: The total number of OCPUs used for the driver or executors. See here for details.

memoryInGbs Double: The amount of memory used for the driver or executors.
ocpus Double: The total number of OCPUs used for the driver or executors. See here for details.

memoryInGbs number: The amount of memory used for the driver or executors.
ocpus number: The total number of OCPUs used for the driver or executors. See here for details.

memory_in_gbs float: The amount of memory used for the driver or executors.
ocpus float: The total number of OCPUs used for the driver or executors. See here for details.

memoryInGbs Number: The amount of memory used for the driver or executors.
ocpus Number: The total number of OCPUs used for the driver or executors. See here for details.

GetPoolPoolMetric

ActiveRunsCount string: The number of runs that are currently running that are using this pool.
ActivelyUsedNodeCounts List<GetPoolPoolMetricActivelyUsedNodeCount>: A count of the nodes that are currently being used for each shape in this pool.
TimeLastMetricsUpdated string: The last time the mertics were updated for this.
TimeLastStarted string: The last time this pool was started.
TimeLastStopped string: The last time this pool was stopped.
TimeLastUsed string: The last time a run used this pool.

ActiveRunsCount string: The number of runs that are currently running that are using this pool.
ActivelyUsedNodeCounts []GetPoolPoolMetricActivelyUsedNodeCount: A count of the nodes that are currently being used for each shape in this pool.
TimeLastMetricsUpdated string: The last time the mertics were updated for this.
TimeLastStarted string: The last time this pool was started.
TimeLastStopped string: The last time this pool was stopped.
TimeLastUsed string: The last time a run used this pool.

activeRunsCount String: The number of runs that are currently running that are using this pool.
activelyUsedNodeCounts List<GetPoolPoolMetricActivelyUsedNodeCount>: A count of the nodes that are currently being used for each shape in this pool.
timeLastMetricsUpdated String: The last time the mertics were updated for this.
timeLastStarted String: The last time this pool was started.
timeLastStopped String: The last time this pool was stopped.
timeLastUsed String: The last time a run used this pool.

activeRunsCount string: The number of runs that are currently running that are using this pool.
activelyUsedNodeCounts GetPoolPoolMetricActivelyUsedNodeCount[]: A count of the nodes that are currently being used for each shape in this pool.
timeLastMetricsUpdated string: The last time the mertics were updated for this.
timeLastStarted string: The last time this pool was started.
timeLastStopped string: The last time this pool was stopped.
timeLastUsed string: The last time a run used this pool.

active_runs_count str: The number of runs that are currently running that are using this pool.
actively_used_node_counts Sequence[dataflow.GetPoolPoolMetricActivelyUsedNodeCount]: A count of the nodes that are currently being used for each shape in this pool.
time_last_metrics_updated str: The last time the mertics were updated for this.
time_last_started str: The last time this pool was started.
time_last_stopped str: The last time this pool was stopped.
time_last_used str: The last time a run used this pool.

activeRunsCount String: The number of runs that are currently running that are using this pool.
activelyUsedNodeCounts List<Property Map>: A count of the nodes that are currently being used for each shape in this pool.
timeLastMetricsUpdated String: The last time the mertics were updated for this.
timeLastStarted String: The last time this pool was started.
timeLastStopped String: The last time this pool was stopped.
timeLastUsed String: The last time a run used this pool.

GetPoolPoolMetricActivelyUsedNodeCount

LogicalShape string: The compute shape of the nodes that the count is for.
PoolCount int: The node count of this compute shape.

LogicalShape string: The compute shape of the nodes that the count is for.
PoolCount int: The node count of this compute shape.

logicalShape String: The compute shape of the nodes that the count is for.
poolCount Integer: The node count of this compute shape.

logicalShape string: The compute shape of the nodes that the count is for.
poolCount number: The node count of this compute shape.

logical_shape str: The compute shape of the nodes that the count is for.
pool_count int: The node count of this compute shape.

logicalShape String: The compute shape of the nodes that the count is for.
poolCount Number: The node count of this compute shape.

GetPoolSchedule

DayOfWeek string: Day of the week SUN-SAT
StartTime int: Hour of the day to start or stop pool.
StopTime int: Hour of the day to stop the pool.

DayOfWeek string: Day of the week SUN-SAT
StartTime int: Hour of the day to start or stop pool.
StopTime int: Hour of the day to stop the pool.

dayOfWeek String: Day of the week SUN-SAT
startTime Integer: Hour of the day to start or stop pool.
stopTime Integer: Hour of the day to stop the pool.

dayOfWeek string: Day of the week SUN-SAT
startTime number: Hour of the day to start or stop pool.
stopTime number: Hour of the day to stop the pool.

day_of_week str: Day of the week SUN-SAT
start_time int: Hour of the day to start or stop pool.
stop_time int: Hour of the day to stop the pool.

dayOfWeek String: Day of the week SUN-SAT
startTime Number: Hour of the day to start or stop pool.
stopTime Number: Hour of the day to stop the pool.

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.11.0 published on Thursday, Sep 19, 2024 by Pulumi

pulumi/pulumi-oci

oci.DataFlow.getPool

On this page

On this page

Example Usage

Using getPool

getPool Result

Supporting Types

GetPoolConfiguration

GetPoolConfigurationShapeConfig

GetPoolPoolMetric

GetPoolPoolMetricActivelyUsedNodeCount

GetPoolSchedule

Package Details

On this page

On this page