OpenflowRuntime

Snowflake v2.21.0, Sep 11 26

Viewing docs for Snowflake v2.21.0
published on Friday, Sep 11, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

Viewing docs for Snowflake v2.21.0
published on Friday, Sep 11, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

Caution: Preview Feature This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to previewFeaturesEnabled field in the provider configuration. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.

Note Every mutating statement is asynchronous and the provider waits for the runtime to settle before returning, so applies take minutes rather than seconds. If you encounter timeout errors, use a timeouts block to set higher limits for your environment.

Note A runtime is created inside an Openflow deployment, and connectors are created inside a runtime’s schema, so a connector’s database and schema must match its runtime’s.

Resource used to manage Openflow runtimes, the compute a deployment runs connectors on. Every mutating statement is asynchronous, so create and update return once the runtime reaches the ACTIVE state. For more information, check Openflow runtime documentation.

Example Usage

Note Instead of using fully_qualified_name, you can reference objects managed outside Terraform by constructing a correct ID, consult identifiers guide.

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

// basic resource
const basic = new snowflake.OpenflowRuntime("basic", {
    database: "my_database",
    schema: "my_schema",
    name: "my_runtime",
    deployment: "my_deployment",
    nodeType: "SMALL",
    minNodes: 1,
    maxNodes: 1,
    executeAsRole: "MY_OPENFLOW_ROLE",
});
// complete resource
const complete = new snowflake.OpenflowRuntime("complete", {
    database: "my_database",
    schema: "my_schema",
    name: "my_runtime_complete",
    deployment: "my_deployment",
    nodeType: "MEDIUM",
    minNodes: 1,
    maxNodes: 4,
    executeAsRole: "MY_OPENFLOW_ROLE",
    externalAccessIntegrations: ["my_external_access_integration"],
    displayName: "My runtime",
    comment: "Managed by Terraform.",
});

import pulumi
import pulumi_snowflake as snowflake

# basic resource
basic = snowflake.OpenflowRuntime("basic",
    database="my_database",
    schema="my_schema",
    name="my_runtime",
    deployment="my_deployment",
    node_type="SMALL",
    min_nodes=1,
    max_nodes=1,
    execute_as_role="MY_OPENFLOW_ROLE")
# complete resource
complete = snowflake.OpenflowRuntime("complete",
    database="my_database",
    schema="my_schema",
    name="my_runtime_complete",
    deployment="my_deployment",
    node_type="MEDIUM",
    min_nodes=1,
    max_nodes=4,
    execute_as_role="MY_OPENFLOW_ROLE",
    external_access_integrations=["my_external_access_integration"],
    display_name="My runtime",
    comment="Managed by Terraform.")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// basic resource
		_, err := snowflake.NewOpenflowRuntime(ctx, "basic", &snowflake.OpenflowRuntimeArgs{
			Database:      pulumi.String("my_database"),
			Schema:        pulumi.String("my_schema"),
			Name:          pulumi.String("my_runtime"),
			Deployment:    pulumi.String("my_deployment"),
			NodeType:      pulumi.String("SMALL"),
			MinNodes:      pulumi.Int(1),
			MaxNodes:      pulumi.Int(1),
			ExecuteAsRole: pulumi.String("MY_OPENFLOW_ROLE"),
		})
		if err != nil {
			return err
		}
		// complete resource
		_, err = snowflake.NewOpenflowRuntime(ctx, "complete", &snowflake.OpenflowRuntimeArgs{
			Database:      pulumi.String("my_database"),
			Schema:        pulumi.String("my_schema"),
			Name:          pulumi.String("my_runtime_complete"),
			Deployment:    pulumi.String("my_deployment"),
			NodeType:      pulumi.String("MEDIUM"),
			MinNodes:      pulumi.Int(1),
			MaxNodes:      pulumi.Int(4),
			ExecuteAsRole: pulumi.String("MY_OPENFLOW_ROLE"),
			ExternalAccessIntegrations: pulumi.StringArray{
				pulumi.String("my_external_access_integration"),
			},
			DisplayName: pulumi.String("My runtime"),
			Comment:     pulumi.String("Managed by Terraform."),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Snowflake = Pulumi.Snowflake;

return await Deployment.RunAsync(() => 
{
    // basic resource
    var basic = new Snowflake.OpenflowRuntime("basic", new()
    {
        Database = "my_database",
        Schema = "my_schema",
        Name = "my_runtime",
        Deployment = "my_deployment",
        NodeType = "SMALL",
        MinNodes = 1,
        MaxNodes = 1,
        ExecuteAsRole = "MY_OPENFLOW_ROLE",
    });

    // complete resource
    var complete = new Snowflake.OpenflowRuntime("complete", new()
    {
        Database = "my_database",
        Schema = "my_schema",
        Name = "my_runtime_complete",
        Deployment = "my_deployment",
        NodeType = "MEDIUM",
        MinNodes = 1,
        MaxNodes = 4,
        ExecuteAsRole = "MY_OPENFLOW_ROLE",
        ExternalAccessIntegrations = new[]
        {
            "my_external_access_integration",
        },
        DisplayName = "My runtime",
        Comment = "Managed by Terraform.",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.OpenflowRuntime;
import com.pulumi.snowflake.OpenflowRuntimeArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        // basic resource
        var basic = new OpenflowRuntime("basic", OpenflowRuntimeArgs.builder()
            .database("my_database")
            .schema("my_schema")
            .name("my_runtime")
            .deployment("my_deployment")
            .nodeType("SMALL")
            .minNodes(1)
            .maxNodes(1)
            .executeAsRole("MY_OPENFLOW_ROLE")
            .build());

        // complete resource
        var complete = new OpenflowRuntime("complete", OpenflowRuntimeArgs.builder()
            .database("my_database")
            .schema("my_schema")
            .name("my_runtime_complete")
            .deployment("my_deployment")
            .nodeType("MEDIUM")
            .minNodes(1)
            .maxNodes(4)
            .executeAsRole("MY_OPENFLOW_ROLE")
            .externalAccessIntegrations("my_external_access_integration")
            .displayName("My runtime")
            .comment("Managed by Terraform.")
            .build());

    }
}

resources:
  # basic resource
  basic:
    type: snowflake:OpenflowRuntime
    properties:
      database: my_database
      schema: my_schema
      name: my_runtime
      deployment: my_deployment
      nodeType: SMALL
      minNodes: 1
      maxNodes: 1
      executeAsRole: MY_OPENFLOW_ROLE
  # complete resource
  complete:
    type: snowflake:OpenflowRuntime
    properties:
      database: my_database
      schema: my_schema
      name: my_runtime_complete
      deployment: my_deployment
      nodeType: MEDIUM
      minNodes: 1
      maxNodes: 4
      executeAsRole: MY_OPENFLOW_ROLE
      externalAccessIntegrations:
        - my_external_access_integration
      displayName: My runtime
      comment: Managed by Terraform.

pulumi {
  required_providers {
    snowflake = {
      source = "pulumi/snowflake"
    }
  }
}

# basic resource
resource "snowflake_openflowruntime" "basic" {
  database        = "my_database"
  schema          = "my_schema"
  name            = "my_runtime"
  deployment      = "my_deployment"
  node_type       = "SMALL"
  min_nodes       = 1
  max_nodes       = 1
  execute_as_role = "MY_OPENFLOW_ROLE"
}
# complete resource
resource "snowflake_openflowruntime" "complete" {
  database                     = "my_database"
  schema                       = "my_schema"
  name                         = "my_runtime_complete"
  deployment                   = "my_deployment"
  node_type                    = "MEDIUM"
  min_nodes                    = 1
  max_nodes                    = 4
  execute_as_role              = "MY_OPENFLOW_ROLE"
  external_access_integrations = ["my_external_access_integration"]
  display_name                 = "My runtime"
  comment                      = "Managed by Terraform."
}

Note If a field has a default value, it is shown next to the type in the schema.

Create OpenflowRuntime Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new OpenflowRuntime(name: string, args: OpenflowRuntimeArgs, opts?: CustomResourceOptions);

@overload
def OpenflowRuntime(resource_name: str,
                    args: OpenflowRuntimeArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def OpenflowRuntime(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    database: Optional[str] = None,
                    deployment: Optional[str] = None,
                    execute_as_role: Optional[str] = None,
                    max_nodes: Optional[int] = None,
                    min_nodes: Optional[int] = None,
                    node_type: Optional[str] = None,
                    schema: Optional[str] = None,
                    comment: Optional[str] = None,
                    display_name: Optional[str] = None,
                    external_access_integrations: Optional[Sequence[str]] = None,
                    name: Optional[str] = None)

func NewOpenflowRuntime(ctx *Context, name string, args OpenflowRuntimeArgs, opts ...ResourceOption) (*OpenflowRuntime, error)

public OpenflowRuntime(string name, OpenflowRuntimeArgs args, CustomResourceOptions? opts = null)

public OpenflowRuntime(String name, OpenflowRuntimeArgs args)
public OpenflowRuntime(String name, OpenflowRuntimeArgs args, CustomResourceOptions options)

type: snowflake:OpenflowRuntime
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "snowflake_openflow_runtime" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args OpenflowRuntimeArgs: 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 OpenflowRuntimeArgs: 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 OpenflowRuntimeArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args OpenflowRuntimeArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args OpenflowRuntimeArgs: 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 openflowRuntimeResource = new Snowflake.OpenflowRuntime("openflowRuntimeResource", new()
{
    Database = "string",
    Deployment = "string",
    ExecuteAsRole = "string",
    MaxNodes = 0,
    MinNodes = 0,
    NodeType = "string",
    Schema = "string",
    Comment = "string",
    DisplayName = "string",
    ExternalAccessIntegrations = new[]
    {
        "string",
    },
    Name = "string",
});

example, err := snowflake.NewOpenflowRuntime(ctx, "openflowRuntimeResource", &snowflake.OpenflowRuntimeArgs{
	Database:      pulumi.String("string"),
	Deployment:    pulumi.String("string"),
	ExecuteAsRole: pulumi.String("string"),
	MaxNodes:      pulumi.Int(0),
	MinNodes:      pulumi.Int(0),
	NodeType:      pulumi.String("string"),
	Schema:        pulumi.String("string"),
	Comment:       pulumi.String("string"),
	DisplayName:   pulumi.String("string"),
	ExternalAccessIntegrations: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

resource "snowflake_openflow_runtime" "openflowRuntimeResource" {
  lifecycle {
    create_before_destroy = true
  }
  database                     = "string"
  deployment                   = "string"
  execute_as_role              = "string"
  max_nodes                    = 0
  min_nodes                    = 0
  node_type                    = "string"
  schema                       = "string"
  comment                      = "string"
  display_name                 = "string"
  external_access_integrations = ["string"]
  name                         = "string"
}

var openflowRuntimeResource = new OpenflowRuntime("openflowRuntimeResource", OpenflowRuntimeArgs.builder()
    .database("string")
    .deployment("string")
    .executeAsRole("string")
    .maxNodes(0)
    .minNodes(0)
    .nodeType("string")
    .schema("string")
    .comment("string")
    .displayName("string")
    .externalAccessIntegrations("string")
    .name("string")
    .build());

openflow_runtime_resource = snowflake.OpenflowRuntime("openflowRuntimeResource",
    database="string",
    deployment="string",
    execute_as_role="string",
    max_nodes=0,
    min_nodes=0,
    node_type="string",
    schema="string",
    comment="string",
    display_name="string",
    external_access_integrations=["string"],
    name="string")

const openflowRuntimeResource = new snowflake.OpenflowRuntime("openflowRuntimeResource", {
    database: "string",
    deployment: "string",
    executeAsRole: "string",
    maxNodes: 0,
    minNodes: 0,
    nodeType: "string",
    schema: "string",
    comment: "string",
    displayName: "string",
    externalAccessIntegrations: ["string"],
    name: "string",
});

type: snowflake:OpenflowRuntime
properties:
    comment: string
    database: string
    deployment: string
    displayName: string
    executeAsRole: string
    externalAccessIntegrations:
        - string
    maxNodes: 0
    minNodes: 0
    name: string
    nodeType: string
    schema: string