oci.DataFlow.Pool
Explore with Pulumi AI
This resource provides the Pool resource in Oracle Cloud Infrastructure Data Flow service.
Create a pool to be used by dataflow runs or applications.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testPool = new oci.dataflow.Pool("test_pool", {
    compartmentId: compartmentId,
    configurations: [{
        max: poolConfigurationsMax,
        min: poolConfigurationsMin,
        shape: poolConfigurationsShape,
        shapeConfig: {
            memoryInGbs: poolConfigurationsShapeConfigMemoryInGbs,
            ocpus: poolConfigurationsShapeConfigOcpus,
        },
    }],
    displayName: poolDisplayName,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    description: poolDescription,
    freeformTags: {
        Department: "Finance",
    },
    idleTimeoutInMinutes: poolIdleTimeoutInMinutes,
    schedules: [{
        dayOfWeek: poolSchedulesDayOfWeek,
        startTime: poolSchedulesStartTime,
        stopTime: poolSchedulesStopTime,
    }],
});
import pulumi
import pulumi_oci as oci
test_pool = oci.data_flow.Pool("test_pool",
    compartment_id=compartment_id,
    configurations=[{
        "max": pool_configurations_max,
        "min": pool_configurations_min,
        "shape": pool_configurations_shape,
        "shape_config": {
            "memory_in_gbs": pool_configurations_shape_config_memory_in_gbs,
            "ocpus": pool_configurations_shape_config_ocpus,
        },
    }],
    display_name=pool_display_name,
    defined_tags={
        "Operations.CostCenter": "42",
    },
    description=pool_description,
    freeform_tags={
        "Department": "Finance",
    },
    idle_timeout_in_minutes=pool_idle_timeout_in_minutes,
    schedules=[{
        "day_of_week": pool_schedules_day_of_week,
        "start_time": pool_schedules_start_time,
        "stop_time": pool_schedules_stop_time,
    }])
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.NewPool(ctx, "test_pool", &dataflow.PoolArgs{
			CompartmentId: pulumi.Any(compartmentId),
			Configurations: dataflow.PoolConfigurationArray{
				&dataflow.PoolConfigurationArgs{
					Max:   pulumi.Any(poolConfigurationsMax),
					Min:   pulumi.Any(poolConfigurationsMin),
					Shape: pulumi.Any(poolConfigurationsShape),
					ShapeConfig: &dataflow.PoolConfigurationShapeConfigArgs{
						MemoryInGbs: pulumi.Any(poolConfigurationsShapeConfigMemoryInGbs),
						Ocpus:       pulumi.Any(poolConfigurationsShapeConfigOcpus),
					},
				},
			},
			DisplayName: pulumi.Any(poolDisplayName),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			Description: pulumi.Any(poolDescription),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			IdleTimeoutInMinutes: pulumi.Any(poolIdleTimeoutInMinutes),
			Schedules: dataflow.PoolScheduleArray{
				&dataflow.PoolScheduleArgs{
					DayOfWeek: pulumi.Any(poolSchedulesDayOfWeek),
					StartTime: pulumi.Any(poolSchedulesStartTime),
					StopTime:  pulumi.Any(poolSchedulesStopTime),
				},
			},
		})
		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 = new Oci.DataFlow.Pool("test_pool", new()
    {
        CompartmentId = compartmentId,
        Configurations = new[]
        {
            new Oci.DataFlow.Inputs.PoolConfigurationArgs
            {
                Max = poolConfigurationsMax,
                Min = poolConfigurationsMin,
                Shape = poolConfigurationsShape,
                ShapeConfig = new Oci.DataFlow.Inputs.PoolConfigurationShapeConfigArgs
                {
                    MemoryInGbs = poolConfigurationsShapeConfigMemoryInGbs,
                    Ocpus = poolConfigurationsShapeConfigOcpus,
                },
            },
        },
        DisplayName = poolDisplayName,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        Description = poolDescription,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        IdleTimeoutInMinutes = poolIdleTimeoutInMinutes,
        Schedules = new[]
        {
            new Oci.DataFlow.Inputs.PoolScheduleArgs
            {
                DayOfWeek = poolSchedulesDayOfWeek,
                StartTime = poolSchedulesStartTime,
                StopTime = poolSchedulesStopTime,
            },
        },
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataFlow.Pool;
import com.pulumi.oci.DataFlow.PoolArgs;
import com.pulumi.oci.DataFlow.inputs.PoolConfigurationArgs;
import com.pulumi.oci.DataFlow.inputs.PoolConfigurationShapeConfigArgs;
import com.pulumi.oci.DataFlow.inputs.PoolScheduleArgs;
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) {
        var testPool = new Pool("testPool", PoolArgs.builder()
            .compartmentId(compartmentId)
            .configurations(PoolConfigurationArgs.builder()
                .max(poolConfigurationsMax)
                .min(poolConfigurationsMin)
                .shape(poolConfigurationsShape)
                .shapeConfig(PoolConfigurationShapeConfigArgs.builder()
                    .memoryInGbs(poolConfigurationsShapeConfigMemoryInGbs)
                    .ocpus(poolConfigurationsShapeConfigOcpus)
                    .build())
                .build())
            .displayName(poolDisplayName)
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .description(poolDescription)
            .freeformTags(Map.of("Department", "Finance"))
            .idleTimeoutInMinutes(poolIdleTimeoutInMinutes)
            .schedules(PoolScheduleArgs.builder()
                .dayOfWeek(poolSchedulesDayOfWeek)
                .startTime(poolSchedulesStartTime)
                .stopTime(poolSchedulesStopTime)
                .build())
            .build());
    }
}
resources:
  testPool:
    type: oci:DataFlow:Pool
    name: test_pool
    properties:
      compartmentId: ${compartmentId}
      configurations:
        - max: ${poolConfigurationsMax}
          min: ${poolConfigurationsMin}
          shape: ${poolConfigurationsShape}
          shapeConfig:
            memoryInGbs: ${poolConfigurationsShapeConfigMemoryInGbs}
            ocpus: ${poolConfigurationsShapeConfigOcpus}
      displayName: ${poolDisplayName}
      definedTags:
        Operations.CostCenter: '42'
      description: ${poolDescription}
      freeformTags:
        Department: Finance
      idleTimeoutInMinutes: ${poolIdleTimeoutInMinutes}
      schedules:
        - dayOfWeek: ${poolSchedulesDayOfWeek}
          startTime: ${poolSchedulesStartTime}
          stopTime: ${poolSchedulesStopTime}
Create Pool Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Pool(name: string, args: PoolArgs, opts?: CustomResourceOptions);@overload
def Pool(resource_name: str,
         args: PoolArgs,
         opts: Optional[ResourceOptions] = None)
@overload
def Pool(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         compartment_id: Optional[str] = None,
         configurations: Optional[Sequence[_dataflow.PoolConfigurationArgs]] = None,
         display_name: Optional[str] = None,
         defined_tags: Optional[Mapping[str, str]] = None,
         description: Optional[str] = None,
         freeform_tags: Optional[Mapping[str, str]] = None,
         idle_timeout_in_minutes: Optional[int] = None,
         schedules: Optional[Sequence[_dataflow.PoolScheduleArgs]] = None,
         state: Optional[str] = None)func NewPool(ctx *Context, name string, args PoolArgs, opts ...ResourceOption) (*Pool, error)public Pool(string name, PoolArgs args, CustomResourceOptions? opts = null)type: oci:DataFlow:Pool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args PoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PoolArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PoolArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PoolArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var poolResource = new Oci.DataFlow.Pool("poolResource", new()
{
    CompartmentId = "string",
    Configurations = new[]
    {
        new Oci.DataFlow.Inputs.PoolConfigurationArgs
        {
            Max = 0,
            Min = 0,
            Shape = "string",
            ShapeConfig = new Oci.DataFlow.Inputs.PoolConfigurationShapeConfigArgs
            {
                MemoryInGbs = 0,
                Ocpus = 0,
            },
        },
    },
    DisplayName = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    Description = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    IdleTimeoutInMinutes = 0,
    Schedules = new[]
    {
        new Oci.DataFlow.Inputs.PoolScheduleArgs
        {
            DayOfWeek = "string",
            StartTime = 0,
            StopTime = 0,
        },
    },
    State = "string",
});
example, err := DataFlow.NewPool(ctx, "poolResource", &DataFlow.PoolArgs{
	CompartmentId: pulumi.String("string"),
	Configurations: dataflow.PoolConfigurationArray{
		&dataflow.PoolConfigurationArgs{
			Max:   pulumi.Int(0),
			Min:   pulumi.Int(0),
			Shape: pulumi.String("string"),
			ShapeConfig: &dataflow.PoolConfigurationShapeConfigArgs{
				MemoryInGbs: pulumi.Float64(0),
				Ocpus:       pulumi.Float64(0),
			},
		},
	},
	DisplayName: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IdleTimeoutInMinutes: pulumi.Int(0),
	Schedules: dataflow.PoolScheduleArray{
		&dataflow.PoolScheduleArgs{
			DayOfWeek: pulumi.String("string"),
			StartTime: pulumi.Int(0),
			StopTime:  pulumi.Int(0),
		},
	},
	State: pulumi.String("string"),
})
var poolResource = new Pool("poolResource", PoolArgs.builder()
    .compartmentId("string")
    .configurations(PoolConfigurationArgs.builder()
        .max(0)
        .min(0)
        .shape("string")
        .shapeConfig(PoolConfigurationShapeConfigArgs.builder()
            .memoryInGbs(0)
            .ocpus(0)
            .build())
        .build())
    .displayName("string")
    .definedTags(Map.of("string", "string"))
    .description("string")
    .freeformTags(Map.of("string", "string"))
    .idleTimeoutInMinutes(0)
    .schedules(PoolScheduleArgs.builder()
        .dayOfWeek("string")
        .startTime(0)
        .stopTime(0)
        .build())
    .state("string")
    .build());
pool_resource = oci.data_flow.Pool("poolResource",
    compartment_id="string",
    configurations=[{
        "max": 0,
        "min": 0,
        "shape": "string",
        "shape_config": {
            "memory_in_gbs": 0,
            "ocpus": 0,
        },
    }],
    display_name="string",
    defined_tags={
        "string": "string",
    },
    description="string",
    freeform_tags={
        "string": "string",
    },
    idle_timeout_in_minutes=0,
    schedules=[{
        "day_of_week": "string",
        "start_time": 0,
        "stop_time": 0,
    }],
    state="string")
const poolResource = new oci.dataflow.Pool("poolResource", {
    compartmentId: "string",
    configurations: [{
        max: 0,
        min: 0,
        shape: "string",
        shapeConfig: {
            memoryInGbs: 0,
            ocpus: 0,
        },
    }],
    displayName: "string",
    definedTags: {
        string: "string",
    },
    description: "string",
    freeformTags: {
        string: "string",
    },
    idleTimeoutInMinutes: 0,
    schedules: [{
        dayOfWeek: "string",
        startTime: 0,
        stopTime: 0,
    }],
    state: "string",
});
type: oci:DataFlow:Pool
properties:
    compartmentId: string
    configurations:
        - max: 0
          min: 0
          shape: string
          shapeConfig:
            memoryInGbs: 0
            ocpus: 0
    definedTags:
        string: string
    description: string
    displayName: string
    freeformTags:
        string: string
    idleTimeoutInMinutes: 0
    schedules:
        - dayOfWeek: string
          startTime: 0
          stopTime: 0
    state: string
Pool Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Pool resource accepts the following input properties:
- CompartmentId string
- (Updatable) The OCID of a compartment.
- Configurations
List<PoolConfiguration> 
- (Updatable) List of PoolConfig items.
- DisplayName string
- (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) 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
- (Updatable) A user-friendly description. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) 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"}
- IdleTimeout intIn Minutes 
- (Updatable) 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.
- Schedules
List<PoolSchedule> 
- (Updatable) A list of schedules for pool to auto start and stop.
- State string
- (Updatable) The target state for the Pool. Could be set to - ACTIVEor- DELETED.- ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- CompartmentId string
- (Updatable) The OCID of a compartment.
- Configurations
[]PoolConfiguration Args 
- (Updatable) List of PoolConfig items.
- DisplayName string
- (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- map[string]string
- (Updatable) 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
- (Updatable) A user-friendly description. Avoid entering confidential information.
- map[string]string
- (Updatable) 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"}
- IdleTimeout intIn Minutes 
- (Updatable) 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.
- Schedules
[]PoolSchedule Args 
- (Updatable) A list of schedules for pool to auto start and stop.
- State string
- (Updatable) The target state for the Pool. Could be set to - ACTIVEor- DELETED.- ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- compartmentId String
- (Updatable) The OCID of a compartment.
- configurations
List<PoolConfiguration> 
- (Updatable) List of PoolConfig items.
- displayName String
- (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- Map<String,String>
- (Updatable) 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
- (Updatable) A user-friendly description. Avoid entering confidential information.
- Map<String,String>
- (Updatable) 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"}
- idleTimeout IntegerIn Minutes 
- (Updatable) 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.
- schedules
List<PoolSchedule> 
- (Updatable) A list of schedules for pool to auto start and stop.
- state String
- (Updatable) The target state for the Pool. Could be set to - ACTIVEor- DELETED.- ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- compartmentId string
- (Updatable) The OCID of a compartment.
- configurations
PoolConfiguration[] 
- (Updatable) List of PoolConfig items.
- displayName string
- (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) 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
- (Updatable) A user-friendly description. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) 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"}
- idleTimeout numberIn Minutes 
- (Updatable) 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.
- schedules
PoolSchedule[] 
- (Updatable) A list of schedules for pool to auto start and stop.
- state string
- (Updatable) The target state for the Pool. Could be set to - ACTIVEor- DELETED.- ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- compartment_id str
- (Updatable) The OCID of a compartment.
- configurations
Sequence[dataflow.Pool Configuration Args] 
- (Updatable) List of PoolConfig items.
- display_name str
- (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) 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
- (Updatable) A user-friendly description. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) 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"}
- idle_timeout_ intin_ minutes 
- (Updatable) 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.
- schedules
Sequence[dataflow.Pool Schedule Args] 
- (Updatable) A list of schedules for pool to auto start and stop.
- state str
- (Updatable) The target state for the Pool. Could be set to - ACTIVEor- DELETED.- ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- compartmentId String
- (Updatable) The OCID of a compartment.
- configurations List<Property Map>
- (Updatable) List of PoolConfig items.
- displayName String
- (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- Map<String>
- (Updatable) 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
- (Updatable) A user-friendly description. Avoid entering confidential information.
- Map<String>
- (Updatable) 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"}
- idleTimeout NumberIn Minutes 
- (Updatable) 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.
- schedules List<Property Map>
- (Updatable) A list of schedules for pool to auto start and stop.
- state String
- (Updatable) The target state for the Pool. Could be set to - ACTIVEor- DELETED.- ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
Outputs
All input properties are implicitly available as output properties. Additionally, the Pool resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- LifecycleDetails string
- The detailed messages about the lifecycle state.
- OwnerPrincipal stringId 
- The OCID of the user who created the resource.
- OwnerUser stringName 
- The username of the user who created the resource. If the username of the owner does not exist, nullwill be returned and the caller should refer to the ownerPrincipalId value instead.
- PoolMetrics List<PoolPool Metric> 
- A collection of metrics related to a particular 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
- Id string
- The provider-assigned unique ID for this managed resource.
- LifecycleDetails string
- The detailed messages about the lifecycle state.
- OwnerPrincipal stringId 
- The OCID of the user who created the resource.
- OwnerUser stringName 
- The username of the user who created the resource. If the username of the owner does not exist, nullwill be returned and the caller should refer to the ownerPrincipalId value instead.
- PoolMetrics []PoolPool Metric 
- A collection of metrics related to a particular 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
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails String
- The detailed messages about the lifecycle state.
- ownerPrincipal StringId 
- The OCID of the user who created the resource.
- ownerUser StringName 
- The username of the user who created the resource. If the username of the owner does not exist, nullwill be returned and the caller should refer to the ownerPrincipalId value instead.
- poolMetrics List<PoolPool Metric> 
- A collection of metrics related to a particular 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
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails string
- The detailed messages about the lifecycle state.
- ownerPrincipal stringId 
- The OCID of the user who created the resource.
- ownerUser stringName 
- The username of the user who created the resource. If the username of the owner does not exist, nullwill be returned and the caller should refer to the ownerPrincipalId value instead.
- poolMetrics PoolPool Metric[] 
- A collection of metrics related to a particular 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
- id str
- The provider-assigned unique ID for this managed resource.
- lifecycle_details str
- The detailed messages about the lifecycle state.
- owner_principal_ strid 
- The OCID of the user who created the resource.
- owner_user_ strname 
- The username of the user who created the resource. If the username of the owner does not exist, nullwill be returned and the caller should refer to the ownerPrincipalId value instead.
- pool_metrics Sequence[dataflow.Pool Pool Metric] 
- A collection of metrics related to a particular 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
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycleDetails String
- The detailed messages about the lifecycle state.
- ownerPrincipal StringId 
- The OCID of the user who created the resource.
- ownerUser StringName 
- The username of the user who created the resource. If the username of the owner does not exist, nullwill be returned and the caller should refer to the ownerPrincipalId value instead.
- poolMetrics List<Property Map>
- A collection of metrics related to a particular 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
Look up Existing Pool Resource
Get an existing Pool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PoolState, opts?: CustomResourceOptions): Pool@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        configurations: Optional[Sequence[_dataflow.PoolConfigurationArgs]] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        idle_timeout_in_minutes: Optional[int] = None,
        lifecycle_details: Optional[str] = None,
        owner_principal_id: Optional[str] = None,
        owner_user_name: Optional[str] = None,
        pool_metrics: Optional[Sequence[_dataflow.PoolPoolMetricArgs]] = None,
        schedules: Optional[Sequence[_dataflow.PoolScheduleArgs]] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> Poolfunc GetPool(ctx *Context, name string, id IDInput, state *PoolState, opts ...ResourceOption) (*Pool, error)public static Pool Get(string name, Input<string> id, PoolState? state, CustomResourceOptions? opts = null)public static Pool get(String name, Output<String> id, PoolState state, CustomResourceOptions options)resources:  _:    type: oci:DataFlow:Pool    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- CompartmentId string
- (Updatable) The OCID of a compartment.
- Configurations
List<PoolConfiguration> 
- (Updatable) List of PoolConfig items.
- Dictionary<string, string>
- (Updatable) 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
- (Updatable) A user-friendly description. Avoid entering confidential information.
- DisplayName string
- (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- Dictionary<string, string>
- (Updatable) 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"}
- IdleTimeout intIn Minutes 
- (Updatable) 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.
- OwnerPrincipal stringId 
- The OCID of the user who created the resource.
- OwnerUser stringName 
- The username of the user who created the resource. If the username of the owner does not exist, nullwill be returned and the caller should refer to the ownerPrincipalId value instead.
- PoolMetrics List<PoolPool Metric> 
- A collection of metrics related to a particular pool.
- Schedules
List<PoolSchedule> 
- (Updatable) A list of schedules for pool to auto start and stop.
- State string
- (Updatable) The target state for the Pool. Could be set to - ACTIVEor- DELETED.- ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- 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
- (Updatable) The OCID of a compartment.
- Configurations
[]PoolConfiguration Args 
- (Updatable) List of PoolConfig items.
- map[string]string
- (Updatable) 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
- (Updatable) A user-friendly description. Avoid entering confidential information.
- DisplayName string
- (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- map[string]string
- (Updatable) 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"}
- IdleTimeout intIn Minutes 
- (Updatable) 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.
- OwnerPrincipal stringId 
- The OCID of the user who created the resource.
- OwnerUser stringName 
- The username of the user who created the resource. If the username of the owner does not exist, nullwill be returned and the caller should refer to the ownerPrincipalId value instead.
- PoolMetrics []PoolPool Metric Args 
- A collection of metrics related to a particular pool.
- Schedules
[]PoolSchedule Args 
- (Updatable) A list of schedules for pool to auto start and stop.
- State string
- (Updatable) The target state for the Pool. Could be set to - ACTIVEor- DELETED.- ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- 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
- (Updatable) The OCID of a compartment.
- configurations
List<PoolConfiguration> 
- (Updatable) List of PoolConfig items.
- Map<String,String>
- (Updatable) 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
- (Updatable) A user-friendly description. Avoid entering confidential information.
- displayName String
- (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- Map<String,String>
- (Updatable) 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"}
- idleTimeout IntegerIn Minutes 
- (Updatable) 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.
- ownerPrincipal StringId 
- The OCID of the user who created the resource.
- ownerUser StringName 
- The username of the user who created the resource. If the username of the owner does not exist, nullwill be returned and the caller should refer to the ownerPrincipalId value instead.
- poolMetrics List<PoolPool Metric> 
- A collection of metrics related to a particular pool.
- schedules
List<PoolSchedule> 
- (Updatable) A list of schedules for pool to auto start and stop.
- state String
- (Updatable) The target state for the Pool. Could be set to - ACTIVEor- DELETED.- ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- 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
- (Updatable) The OCID of a compartment.
- configurations
PoolConfiguration[] 
- (Updatable) List of PoolConfig items.
- {[key: string]: string}
- (Updatable) 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
- (Updatable) A user-friendly description. Avoid entering confidential information.
- displayName string
- (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- {[key: string]: string}
- (Updatable) 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"}
- idleTimeout numberIn Minutes 
- (Updatable) 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.
- ownerPrincipal stringId 
- The OCID of the user who created the resource.
- ownerUser stringName 
- The username of the user who created the resource. If the username of the owner does not exist, nullwill be returned and the caller should refer to the ownerPrincipalId value instead.
- poolMetrics PoolPool Metric[] 
- A collection of metrics related to a particular pool.
- schedules
PoolSchedule[] 
- (Updatable) A list of schedules for pool to auto start and stop.
- state string
- (Updatable) The target state for the Pool. Could be set to - ACTIVEor- DELETED.- ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- 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
- (Updatable) The OCID of a compartment.
- configurations
Sequence[dataflow.Pool Configuration Args] 
- (Updatable) List of PoolConfig items.
- Mapping[str, str]
- (Updatable) 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
- (Updatable) A user-friendly description. Avoid entering confidential information.
- display_name str
- (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- Mapping[str, str]
- (Updatable) 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"}
- idle_timeout_ intin_ minutes 
- (Updatable) 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_ strid 
- The OCID of the user who created the resource.
- owner_user_ strname 
- The username of the user who created the resource. If the username of the owner does not exist, nullwill be returned and the caller should refer to the ownerPrincipalId value instead.
- pool_metrics Sequence[dataflow.Pool Pool Metric Args] 
- A collection of metrics related to a particular pool.
- schedules
Sequence[dataflow.Pool Schedule Args] 
- (Updatable) A list of schedules for pool to auto start and stop.
- state str
- (Updatable) The target state for the Pool. Could be set to - ACTIVEor- DELETED.- ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- 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
- (Updatable) The OCID of a compartment.
- configurations List<Property Map>
- (Updatable) List of PoolConfig items.
- Map<String>
- (Updatable) 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
- (Updatable) A user-friendly description. Avoid entering confidential information.
- displayName String
- (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.
- Map<String>
- (Updatable) 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"}
- idleTimeout NumberIn Minutes 
- (Updatable) 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.
- ownerPrincipal StringId 
- The OCID of the user who created the resource.
- ownerUser StringName 
- The username of the user who created the resource. If the username of the owner does not exist, nullwill be returned and the caller should refer to the ownerPrincipalId value instead.
- poolMetrics List<Property Map>
- A collection of metrics related to a particular pool.
- schedules List<Property Map>
- (Updatable) A list of schedules for pool to auto start and stop.
- state String
- (Updatable) The target state for the Pool. Could be set to - ACTIVEor- DELETED.- ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- 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
PoolConfiguration, PoolConfigurationArgs    
- Max int
- (Updatable) Maximum number of compute instances in the pool for a given compute shape.
- Min int
- (Updatable) Minimum number of compute instances in the pool for a given compute shape.
- Shape string
- (Updatable) The compute shape of the resources you would like to provision.
- ShapeConfig PoolConfiguration Shape Config 
- (Updatable) This is used to configure the shape of the driver or executor if a flexible shape is used.
- Max int
- (Updatable) Maximum number of compute instances in the pool for a given compute shape.
- Min int
- (Updatable) Minimum number of compute instances in the pool for a given compute shape.
- Shape string
- (Updatable) The compute shape of the resources you would like to provision.
- ShapeConfig PoolConfiguration Shape Config 
- (Updatable) This is used to configure the shape of the driver or executor if a flexible shape is used.
- max Integer
- (Updatable) Maximum number of compute instances in the pool for a given compute shape.
- min Integer
- (Updatable) Minimum number of compute instances in the pool for a given compute shape.
- shape String
- (Updatable) The compute shape of the resources you would like to provision.
- shapeConfig PoolConfiguration Shape Config 
- (Updatable) This is used to configure the shape of the driver or executor if a flexible shape is used.
- max number
- (Updatable) Maximum number of compute instances in the pool for a given compute shape.
- min number
- (Updatable) Minimum number of compute instances in the pool for a given compute shape.
- shape string
- (Updatable) The compute shape of the resources you would like to provision.
- shapeConfig PoolConfiguration Shape Config 
- (Updatable) This is used to configure the shape of the driver or executor if a flexible shape is used.
- max int
- (Updatable) Maximum number of compute instances in the pool for a given compute shape.
- min int
- (Updatable) Minimum number of compute instances in the pool for a given compute shape.
- shape str
- (Updatable) The compute shape of the resources you would like to provision.
- shape_config dataflow.Pool Configuration Shape Config 
- (Updatable) This is used to configure the shape of the driver or executor if a flexible shape is used.
- max Number
- (Updatable) Maximum number of compute instances in the pool for a given compute shape.
- min Number
- (Updatable) Minimum number of compute instances in the pool for a given compute shape.
- shape String
- (Updatable) The compute shape of the resources you would like to provision.
- shapeConfig Property Map
- (Updatable) This is used to configure the shape of the driver or executor if a flexible shape is used.
PoolConfigurationShapeConfig, PoolConfigurationShapeConfigArgs        
- MemoryIn doubleGbs 
- (Updatable) The amount of memory used for the driver or executors.
- Ocpus double
- (Updatable) The total number of OCPUs used for the driver or executors. See here for details.
- MemoryIn float64Gbs 
- (Updatable) The amount of memory used for the driver or executors.
- Ocpus float64
- (Updatable) The total number of OCPUs used for the driver or executors. See here for details.
- memoryIn DoubleGbs 
- (Updatable) The amount of memory used for the driver or executors.
- ocpus Double
- (Updatable) The total number of OCPUs used for the driver or executors. See here for details.
- memoryIn numberGbs 
- (Updatable) The amount of memory used for the driver or executors.
- ocpus number
- (Updatable) The total number of OCPUs used for the driver or executors. See here for details.
- memory_in_ floatgbs 
- (Updatable) The amount of memory used for the driver or executors.
- ocpus float
- (Updatable) The total number of OCPUs used for the driver or executors. See here for details.
- memoryIn NumberGbs 
- (Updatable) The amount of memory used for the driver or executors.
- ocpus Number
- (Updatable) The total number of OCPUs used for the driver or executors. See here for details.
PoolPoolMetric, PoolPoolMetricArgs      
- ActiveRuns stringCount 
- The number of runs that are currently running that are using this pool.
- ActivelyUsed List<PoolNode Counts Pool Metric Actively Used Node Count> 
- A count of the nodes that are currently being used for each shape in this pool.
- TimeLast stringMetrics Updated 
- The last time the mertics were updated for this.
- TimeLast stringStarted 
- The last time this pool was started.
- TimeLast stringStopped 
- The last time this pool was stopped.
- TimeLast stringUsed 
- The last time a run used this pool.
- ActiveRuns stringCount 
- The number of runs that are currently running that are using this pool.
- ActivelyUsed []PoolNode Counts Pool Metric Actively Used Node Count 
- A count of the nodes that are currently being used for each shape in this pool.
- TimeLast stringMetrics Updated 
- The last time the mertics were updated for this.
- TimeLast stringStarted 
- The last time this pool was started.
- TimeLast stringStopped 
- The last time this pool was stopped.
- TimeLast stringUsed 
- The last time a run used this pool.
- activeRuns StringCount 
- The number of runs that are currently running that are using this pool.
- activelyUsed List<PoolNode Counts Pool Metric Actively Used Node Count> 
- A count of the nodes that are currently being used for each shape in this pool.
- timeLast StringMetrics Updated 
- The last time the mertics were updated for this.
- timeLast StringStarted 
- The last time this pool was started.
- timeLast StringStopped 
- The last time this pool was stopped.
- timeLast StringUsed 
- The last time a run used this pool.
- activeRuns stringCount 
- The number of runs that are currently running that are using this pool.
- activelyUsed PoolNode Counts Pool Metric Actively Used Node Count[] 
- A count of the nodes that are currently being used for each shape in this pool.
- timeLast stringMetrics Updated 
- The last time the mertics were updated for this.
- timeLast stringStarted 
- The last time this pool was started.
- timeLast stringStopped 
- The last time this pool was stopped.
- timeLast stringUsed 
- The last time a run used this pool.
- active_runs_ strcount 
- The number of runs that are currently running that are using this pool.
- actively_used_ Sequence[dataflow.node_ counts Pool Pool Metric Actively Used Node Count] 
- A count of the nodes that are currently being used for each shape in this pool.
- time_last_ strmetrics_ updated 
- The last time the mertics were updated for this.
- time_last_ strstarted 
- The last time this pool was started.
- time_last_ strstopped 
- The last time this pool was stopped.
- time_last_ strused 
- The last time a run used this pool.
- activeRuns StringCount 
- The number of runs that are currently running that are using this pool.
- activelyUsed List<Property Map>Node Counts 
- A count of the nodes that are currently being used for each shape in this pool.
- timeLast StringMetrics Updated 
- The last time the mertics were updated for this.
- timeLast StringStarted 
- The last time this pool was started.
- timeLast StringStopped 
- The last time this pool was stopped.
- timeLast StringUsed 
- The last time a run used this pool.
PoolPoolMetricActivelyUsedNodeCount, PoolPoolMetricActivelyUsedNodeCountArgs              
- 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.
PoolSchedule, PoolScheduleArgs    
- day_of_ strweek 
- (Updatable) Day of the week SUN-SAT
- start_time int
- (Updatable) Hour of the day to start or stop pool.
- stop_time int
- (Updatable) Hour of the day to stop the pool.
Import
Pools can be imported using the id, e.g.
$ pulumi import oci:DataFlow/pool:Pool test_pool "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.