oci_dataflow_pool
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
resource "oci_dataflow_pool" "test_pool" {
#Required
compartment_id = var.compartment_id
configurations {
#Optional
max = var.pool_configurations_max
min = var.pool_configurations_min
shape = var.pool_configurations_shape
shape_config {
#Optional
memory_in_gbs = var.pool_configurations_shape_config_memory_in_gbs
ocpus = var.pool_configurations_shape_config_ocpus
}
}
display_name = var.pool_display_name
#Optional
defined_tags = {"Operations.CostCenter"= "42"}
description = var.pool_description
freeform_tags = {"Department"= "Finance"}
idle_timeout_in_minutes = var.pool_idle_timeout_in_minutes
schedules {
#Optional
day_of_week = var.pool_schedules_day_of_week
start_time = var.pool_schedules_start_time
stop_time = var.pool_schedules_stop_time
}
}
Argument Reference
The following arguments are supported:
compartment_id
- (Required) (Updatable) The OCID of a compartment.configurations
- (Required) (Updatable) List of PoolConfig items.max
- (Optional) (Updatable) Maximum number of compute instances in the pool for a given compute shape.min
- (Optional) (Updatable) Minimum number of compute instances in the pool for a given compute shape.shape
- (Optional) (Updatable) The compute shape of the resources you would like to provision.shape_config
- (Optional) (Updatable) This is used to configure the shape of the driver or executor if a flexible shape is used.memory_in_gbs
- (Optional) (Updatable) The amount of memory used for the driver or executors.ocpus
- (Optional) (Updatable) The total number of OCPUs used for the driver or executors. See here for details.
defined_tags
- (Optional) (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
- (Optional) (Updatable) A user-friendly description. Avoid entering confidential information.display_name
- (Required) (Updatable) A user-friendly name. It does not have to be unique. Avoid entering confidential information.freeform_tags
- (Optional) (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_in_minutes
- (Optional) (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
- (Optional) (Updatable) A list of schedules for pool to auto start and stop.day_of_week
- (Optional) (Updatable) Day of the week SUN-SATstart_time
- (Optional) (Updatable) Hour of the day to start or stop pool.stop_time
- (Optional) (Updatable) Hour of the day to stop the pool.
state
- (Optional) (Updatable) The target state for the Pool. Could be set toACTIVE
orDELETED
.
** 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
Attributes Reference
The following attributes are exported:
compartment_id
- The OCID of a compartment.configurations
- List of PoolConfig items.max
- Maximum number of compute instances in the pool for a given compute shape.min
- Minimum number of compute instances in the pool for a given compute shape.shape
- The compute shape of the resources you would like to provision.shape_config
- This is used to configure the shape of the driver or executor if a flexible shape is used.memory_in_gbs
- The amount of memory used for the driver or executors.ocpus
- The total number of OCPUs used for the driver or executors. See here for details.
defined_tags
- 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
- A user-friendly description. Avoid entering confidential information.display_name
- A user-friendly name. It does not have to be unique. Avoid entering confidential information.freeform_tags
- 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
- The OCID of a pool. Unique Id to indentify a dataflow pool resource.idle_timeout_in_minutes
- 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
- The detailed messages about the lifecycle state.owner_principal_id
- The OCID of the user who created the resource.owner_user_name
- 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_metrics
- A collection of metrics related to a particular pool.active_runs_count
- The number of runs that are currently running that are using this pool.actively_used_node_count
- A count of the nodes that are currently being used for each shape in this pool.logical_shape
- The compute shape of the nodes that the count is for.pool_count
- The node count of this compute shape.
time_last_metrics_updated
- The last time the mertics were updated for this.time_last_started
- The last time this pool was started.time_last_stopped
- The last time this pool was stopped.time_last_used
- The last time a run used this pool.
schedules
- A list of schedules for pool to auto start and stop.day_of_week
- Day of the week SUN-SATstart_time
- Hour of the day to start or stop pool.stop_time
- Hour of the day to stop the pool.
state
- The current state of this pool.time_created
- The date and time the resource was created, expressed in RFC 3339 timestamp format. Example:2018-04-03T21:10:29.600Z
time_updated
- The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example:2018-04-03T21:10:29.600Z
Timeouts
The timeouts
block allows you to specify timeouts for certain operations:
* create
- (Defaults to 20 minutes), when creating the Pool
* update
- (Defaults to 20 minutes), when updating the Pool
* delete
- (Defaults to 20 minutes), when destroying the Pool
Import
Pools can be imported using the id
, e.g.
$ terraform import oci_dataflow_pool.test_pool "id"