Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Snowflake Provider
  4. API Docs
  5. OpenflowDeploymentByoc
Viewing docs for Snowflake v2.21.0
published on Friday, Sep 11, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-snowflake

snowflake.OpenflowDeploymentByoc

snowflake logo
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 deployment 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 vpcType is create-only. Changing it recreates the deployment, which destroys every runtime and connector inside it.

    Resource used to manage BYOC (bring your own cloud) Openflow deployments, which run in your own cloud account. Creation finishes when the deployment reaches the INACTIVE state, which is as far as Terraform can take it: the deployment only becomes ACTIVE after you apply the deployment’s CloudFormation template in your cloud account, at which point it registers itself with Snowflake. That template can only be downloaded from the Snowflake UI - it is not retrievable over SQL - so provisioning that infrastructure is a separate step outside this resource. For more information, check Openflow deployment 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.OpenflowDeploymentByoc("basic", {
    name: "my_byoc_deployment",
    vpcType: "MANAGED",
});
// in a VPC you provide yourself
const providedVpc = new snowflake.OpenflowDeploymentByoc("provided_vpc", {
    name: "my_byoc_deployment",
    vpcType: "PROVIDED",
});
// complete resource
const complete = new snowflake.OpenflowDeploymentByoc("complete", {
    name: "my_byoc_deployment_complete",
    vpcType: "MANAGED",
    displayName: "My BYOC deployment",
    eventTable: "\"<database_name>\".\"<schema_name>\".\"<event_table_name>\"",
    customIngressHostname: "openflow.example.com",
    usePrivateLink: "true",
    useUserAuthOverPrivatelink: "true",
    comment: "Managed by Terraform.",
});

    import pulumi
import pulumi_snowflake as snowflake

# basic resource
basic = snowflake.OpenflowDeploymentByoc("basic",
    name="my_byoc_deployment",
    vpc_type="MANAGED")
# in a VPC you provide yourself
provided_vpc = snowflake.OpenflowDeploymentByoc("provided_vpc",
    name="my_byoc_deployment",
    vpc_type="PROVIDED")
# complete resource
complete = snowflake.OpenflowDeploymentByoc("complete",
    name="my_byoc_deployment_complete",
    vpc_type="MANAGED",
    display_name="My BYOC deployment",
    event_table="\"<database_name>\".\"<schema_name>\".\"<event_table_name>\"",
    custom_ingress_hostname="openflow.example.com",
    use_private_link="true",
    use_user_auth_over_privatelink="true",
    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.NewOpenflowDeploymentByoc(ctx, "basic", &snowflake.OpenflowDeploymentByocArgs{
			Name:    pulumi.String("my_byoc_deployment"),
			VpcType: pulumi.String("MANAGED"),
		})
		if err != nil {
			return err
		}
		// in a VPC you provide yourself
		_, err = snowflake.NewOpenflowDeploymentByoc(ctx, "provided_vpc", &snowflake.OpenflowDeploymentByocArgs{
			Name:    pulumi.String("my_byoc_deployment"),
			VpcType: pulumi.String("PROVIDED"),
		})
		if err != nil {
			return err
		}
		// complete resource
		_, err = snowflake.NewOpenflowDeploymentByoc(ctx, "complete", &snowflake.OpenflowDeploymentByocArgs{
			Name:                       pulumi.String("my_byoc_deployment_complete"),
			VpcType:                    pulumi.String("MANAGED"),
			DisplayName:                pulumi.String("My BYOC deployment"),
			EventTable:                 pulumi.String("\"<database_name>\".\"<schema_name>\".\"<event_table_name>\""),
			CustomIngressHostname:      pulumi.String("openflow.example.com"),
			UsePrivateLink:             pulumi.String("true"),
			UseUserAuthOverPrivatelink: pulumi.String("true"),
			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.OpenflowDeploymentByoc("basic", new()
    {
        Name = "my_byoc_deployment",
        VpcType = "MANAGED",
    });

    // in a VPC you provide yourself
    var providedVpc = new Snowflake.OpenflowDeploymentByoc("provided_vpc", new()
    {
        Name = "my_byoc_deployment",
        VpcType = "PROVIDED",
    });

    // complete resource
    var complete = new Snowflake.OpenflowDeploymentByoc("complete", new()
    {
        Name = "my_byoc_deployment_complete",
        VpcType = "MANAGED",
        DisplayName = "My BYOC deployment",
        EventTable = "\"<database_name>\".\"<schema_name>\".\"<event_table_name>\"",
        CustomIngressHostname = "openflow.example.com",
        UsePrivateLink = "true",
        UseUserAuthOverPrivatelink = "true",
        Comment = "Managed by Terraform.",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.OpenflowDeploymentByoc;
import com.pulumi.snowflake.OpenflowDeploymentByocArgs;
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 OpenflowDeploymentByoc("basic", OpenflowDeploymentByocArgs.builder()
            .name("my_byoc_deployment")
            .vpcType("MANAGED")
            .build());

        // in a VPC you provide yourself
        var providedVpc = new OpenflowDeploymentByoc("providedVpc", OpenflowDeploymentByocArgs.builder()
            .name("my_byoc_deployment")
            .vpcType("PROVIDED")
            .build());

        // complete resource
        var complete = new OpenflowDeploymentByoc("complete", OpenflowDeploymentByocArgs.builder()
            .name("my_byoc_deployment_complete")
            .vpcType("MANAGED")
            .displayName("My BYOC deployment")
            .eventTable("\"<database_name>\".\"<schema_name>\".\"<event_table_name>\"")
            .customIngressHostname("openflow.example.com")
            .usePrivateLink("true")
            .useUserAuthOverPrivatelink("true")
            .comment("Managed by Terraform.")
            .build());

    }
}

    resources:
  # basic resource
  basic:
    type: snowflake:OpenflowDeploymentByoc
    properties:
      name: my_byoc_deployment
      vpcType: MANAGED
  # in a VPC you provide yourself
  providedVpc:
    type: snowflake:OpenflowDeploymentByoc
    name: provided_vpc
    properties:
      name: my_byoc_deployment
      vpcType: PROVIDED
  # complete resource
  complete:
    type: snowflake:OpenflowDeploymentByoc
    properties:
      name: my_byoc_deployment_complete
      vpcType: MANAGED
      displayName: My BYOC deployment
      eventTable: '"<database_name>"."<schema_name>"."<event_table_name>"'
      customIngressHostname: openflow.example.com
      usePrivateLink: 'true'
      useUserAuthOverPrivatelink: 'true'
      comment: Managed by Terraform.

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

# basic resource
resource "snowflake_openflowdeploymentbyoc" "basic" {
  name     = "my_byoc_deployment"
  vpc_type = "MANAGED"
}
# in a VPC you provide yourself
resource "snowflake_openflowdeploymentbyoc" "provided_vpc" {
  name     = "my_byoc_deployment"
  vpc_type = "PROVIDED"
}
# complete resource
resource "snowflake_openflowdeploymentbyoc" "complete" {
  name                           = "my_byoc_deployment_complete"
  vpc_type                       = "MANAGED"
  display_name                   = "My BYOC deployment"
  event_table                    = "\"<database_name>\".\"<schema_name>\".\"<event_table_name>\""
  custom_ingress_hostname        = "openflow.example.com"
  use_private_link               = "true"
  use_user_auth_over_privatelink = "true"
  comment                        = "Managed by Terraform."
}

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

    Create OpenflowDeploymentByoc Resource

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

    Constructor syntax

    new OpenflowDeploymentByoc(name: string, args: OpenflowDeploymentByocArgs, opts?: CustomResourceOptions);
    @overload
def OpenflowDeploymentByoc(resource_name: str,
                           args: OpenflowDeploymentByocArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def OpenflowDeploymentByoc(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           vpc_type: Optional[str] = None,
                           comment: Optional[str] = None,
                           custom_ingress_hostname: Optional[str] = None,
                           display_name: Optional[str] = None,
                           event_table: Optional[str] = None,
                           name: Optional[str] = None,
                           use_private_link: Optional[str] = None,
                           use_user_auth_over_privatelink: Optional[str] = None)
    func NewOpenflowDeploymentByoc(ctx *Context, name string, args OpenflowDeploymentByocArgs, opts ...ResourceOption) (*OpenflowDeploymentByoc, error)
    public OpenflowDeploymentByoc(string name, OpenflowDeploymentByocArgs args, CustomResourceOptions? opts = null)
    public OpenflowDeploymentByoc(String name, OpenflowDeploymentByocArgs args)
public OpenflowDeploymentByoc(String name, OpenflowDeploymentByocArgs args, CustomResourceOptions options)

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


    resource "snowflake_openflow_deployment_byoc" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args OpenflowDeploymentByocArgs
    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 OpenflowDeploymentByocArgs
    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 OpenflowDeploymentByocArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OpenflowDeploymentByocArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OpenflowDeploymentByocArgs
    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 openflowDeploymentByocResource = new Snowflake.OpenflowDeploymentByoc("openflowDeploymentByocResource", new()
{
    VpcType = "string",
    Comment = "string",
    CustomIngressHostname = "string",
    DisplayName = "string",
    EventTable = "string",
    Name = "string",
    UsePrivateLink = "string",
    UseUserAuthOverPrivatelink = "string",
});

    example, err := snowflake.NewOpenflowDeploymentByoc(ctx, "openflowDeploymentByocResource", &snowflake.OpenflowDeploymentByocArgs{
	VpcType:                    pulumi.String("string"),
	Comment:                    pulumi.String("string"),
	CustomIngressHostname:      pulumi.String("string"),
	DisplayName:                pulumi.String("string"),
	EventTable:                 pulumi.String("string"),
	Name:                       pulumi.String("string"),
	UsePrivateLink:             pulumi.String("string"),
	UseUserAuthOverPrivatelink: pulumi.String("string"),
})

    resource "snowflake_openflow_deployment_byoc" "openflowDeploymentByocResource" {
  lifecycle {
    create_before_destroy = true
  }
  vpc_type                       = "string"
  comment                        = "string"
  custom_ingress_hostname        = "string"
  display_name                   = "string"
  event_table                    = "string"
  name                           = "string"
  use_private_link               = "string"
  use_user_auth_over_privatelink = "string"
}

    var openflowDeploymentByocResource = new OpenflowDeploymentByoc("openflowDeploymentByocResource", OpenflowDeploymentByocArgs.builder()
    .vpcType("string")
    .comment("string")
    .customIngressHostname("string")
    .displayName("string")
    .eventTable("string")
    .name("string")
    .usePrivateLink("string")
    .useUserAuthOverPrivatelink("string")
    .build());

    openflow_deployment_byoc_resource = snowflake.OpenflowDeploymentByoc("openflowDeploymentByocResource",
    vpc_type="string",
    comment="string",
    custom_ingress_hostname="string",
    display_name="string",
    event_table="string",
    name="string",
    use_private_link="string",
    use_user_auth_over_privatelink="string")

    const openflowDeploymentByocResource = new snowflake.OpenflowDeploymentByoc("openflowDeploymentByocResource", {
    vpcType: "string",
    comment: "string",
    customIngressHostname: "string",
    displayName: "string",
    eventTable: "string",
    name: "string",
    usePrivateLink: "string",
    useUserAuthOverPrivatelink: "string",
});

    type: snowflake:OpenflowDeploymentByoc
properties:
    comment: string
    customIngressHostname: string
    displayName: string
    eventTable: string
    name: string
    usePrivateLink: string
    useUserAuthOverPrivatelink: string
    vpcType: string

    OpenflowDeploymentByoc 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 OpenflowDeploymentByoc resource accepts the following input properties:

    VpcType string
    Specifies whether the deployment's VPC is created by Snowflake or supplied by you. Valid values are (case-insensitive): MANAGED | PROVIDED.
    Comment string
    Specifies a comment for the Openflow deployment.
    CustomIngressHostname string
    Specifies a custom hostname for ingress into the deployment.
    DisplayName string
    A free-text alias for the deployment. Shown in the Openflow UI in place of the deployment's identifier when set.
    EventTable string
    Fully qualified name of an event table the deployment logs to. For more information, check EVENT_TABLE documentation.
    Name string
    Specifies the identifier for the Openflow deployment; must be unique for the account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    UsePrivateLink string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the deployment is reached over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    UseUserAuthOverPrivatelink string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether user authentication is performed over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    VpcType string
    Specifies whether the deployment's VPC is created by Snowflake or supplied by you. Valid values are (case-insensitive): MANAGED | PROVIDED.
    Comment string
    Specifies a comment for the Openflow deployment.
    CustomIngressHostname string
    Specifies a custom hostname for ingress into the deployment.
    DisplayName string
    A free-text alias for the deployment. Shown in the Openflow UI in place of the deployment's identifier when set.
    EventTable string
    Fully qualified name of an event table the deployment logs to. For more information, check EVENT_TABLE documentation.
    Name string
    Specifies the identifier for the Openflow deployment; must be unique for the account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    UsePrivateLink string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the deployment is reached over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    UseUserAuthOverPrivatelink string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether user authentication is performed over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    vpc_type string
    Specifies whether the deployment's VPC is created by Snowflake or supplied by you. Valid values are (case-insensitive): MANAGED | PROVIDED.
    comment string
    Specifies a comment for the Openflow deployment.
    custom_ingress_hostname string
    Specifies a custom hostname for ingress into the deployment.
    display_name string
    A free-text alias for the deployment. Shown in the Openflow UI in place of the deployment's identifier when set.
    event_table string
    Fully qualified name of an event table the deployment logs to. For more information, check EVENT_TABLE documentation.
    name string
    Specifies the identifier for the Openflow deployment; must be unique for the account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    use_private_link string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the deployment is reached over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    use_user_auth_over_privatelink string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether user authentication is performed over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    vpcType String
    Specifies whether the deployment's VPC is created by Snowflake or supplied by you. Valid values are (case-insensitive): MANAGED | PROVIDED.
    comment String
    Specifies a comment for the Openflow deployment.
    customIngressHostname String
    Specifies a custom hostname for ingress into the deployment.
    displayName String
    A free-text alias for the deployment. Shown in the Openflow UI in place of the deployment's identifier when set.
    eventTable String
    Fully qualified name of an event table the deployment logs to. For more information, check EVENT_TABLE documentation.
    name String
    Specifies the identifier for the Openflow deployment; must be unique for the account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    usePrivateLink String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the deployment is reached over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    useUserAuthOverPrivatelink String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether user authentication is performed over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    vpcType string
    Specifies whether the deployment's VPC is created by Snowflake or supplied by you. Valid values are (case-insensitive): MANAGED | PROVIDED.
    comment string
    Specifies a comment for the Openflow deployment.
    customIngressHostname string
    Specifies a custom hostname for ingress into the deployment.
    displayName string
    A free-text alias for the deployment. Shown in the Openflow UI in place of the deployment's identifier when set.
    eventTable string
    Fully qualified name of an event table the deployment logs to. For more information, check EVENT_TABLE documentation.
    name string
    Specifies the identifier for the Openflow deployment; must be unique for the account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    usePrivateLink string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the deployment is reached over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    useUserAuthOverPrivatelink string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether user authentication is performed over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    vpc_type str
    Specifies whether the deployment's VPC is created by Snowflake or supplied by you. Valid values are (case-insensitive): MANAGED | PROVIDED.
    comment str
    Specifies a comment for the Openflow deployment.
    custom_ingress_hostname str
    Specifies a custom hostname for ingress into the deployment.
    display_name str
    A free-text alias for the deployment. Shown in the Openflow UI in place of the deployment's identifier when set.
    event_table str
    Fully qualified name of an event table the deployment logs to. For more information, check EVENT_TABLE documentation.
    name str
    Specifies the identifier for the Openflow deployment; must be unique for the account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    use_private_link str
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the deployment is reached over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    use_user_auth_over_privatelink str
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether user authentication is performed over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    vpcType String
    Specifies whether the deployment's VPC is created by Snowflake or supplied by you. Valid values are (case-insensitive): MANAGED | PROVIDED.
    comment String
    Specifies a comment for the Openflow deployment.
    customIngressHostname String
    Specifies a custom hostname for ingress into the deployment.
    displayName String
    A free-text alias for the deployment. Shown in the Openflow UI in place of the deployment's identifier when set.
    eventTable String
    Fully qualified name of an event table the deployment logs to. For more information, check EVENT_TABLE documentation.
    name String
    Specifies the identifier for the Openflow deployment; must be unique for the account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    usePrivateLink String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the deployment is reached over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    useUserAuthOverPrivatelink String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether user authentication is performed over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OpenflowDeploymentByoc resource produces the following output properties:

    DescribeOutputs List<OpenflowDeploymentByocDescribeOutput>
    Outputs the result of DESCRIBE OPENFLOW DEPLOYMENT for the given deployment.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    Parameters List<OpenflowDeploymentByocParameter>
    Outputs the result of SHOW PARAMETERS IN OPENFLOW DEPLOYMENT for the given deployment.
    ShowOutputs List<OpenflowDeploymentByocShowOutput>
    Outputs the result of SHOW OPENFLOW DEPLOYMENTS for the given deployment.
    Type string
    Specifies the type of the Openflow deployment. This field is used to detect when the deployment type was changed outside of Terraform and to recreate the resource when that happens.
    DescribeOutputs []OpenflowDeploymentByocDescribeOutput
    Outputs the result of DESCRIBE OPENFLOW DEPLOYMENT for the given deployment.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    Parameters []OpenflowDeploymentByocParameter
    Outputs the result of SHOW PARAMETERS IN OPENFLOW DEPLOYMENT for the given deployment.
    ShowOutputs []OpenflowDeploymentByocShowOutput
    Outputs the result of SHOW OPENFLOW DEPLOYMENTS for the given deployment.
    Type string
    Specifies the type of the Openflow deployment. This field is used to detect when the deployment type was changed outside of Terraform and to recreate the resource when that happens.
    describe_outputs list(object)
    Outputs the result of DESCRIBE OPENFLOW DEPLOYMENT for the given deployment.
    fully_qualified_name string
    Fully qualified name of the resource. For more information, see object name resolution.
    id string
    The provider-assigned unique ID for this managed resource.
    parameters list(object)
    Outputs the result of SHOW PARAMETERS IN OPENFLOW DEPLOYMENT for the given deployment.
    show_outputs list(object)
    Outputs the result of SHOW OPENFLOW DEPLOYMENTS for the given deployment.
    type string
    Specifies the type of the Openflow deployment. This field is used to detect when the deployment type was changed outside of Terraform and to recreate the resource when that happens.
    describeOutputs List<OpenflowDeploymentByocDescribeOutput>
    Outputs the result of DESCRIBE OPENFLOW DEPLOYMENT for the given deployment.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.
    parameters List<OpenflowDeploymentByocParameter>
    Outputs the result of SHOW PARAMETERS IN OPENFLOW DEPLOYMENT for the given deployment.
    showOutputs List<OpenflowDeploymentByocShowOutput>
    Outputs the result of SHOW OPENFLOW DEPLOYMENTS for the given deployment.
    type String
    Specifies the type of the Openflow deployment. This field is used to detect when the deployment type was changed outside of Terraform and to recreate the resource when that happens.
    describeOutputs OpenflowDeploymentByocDescribeOutput[]
    Outputs the result of DESCRIBE OPENFLOW DEPLOYMENT for the given deployment.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    id string
    The provider-assigned unique ID for this managed resource.
    parameters OpenflowDeploymentByocParameter[]
    Outputs the result of SHOW PARAMETERS IN OPENFLOW DEPLOYMENT for the given deployment.
    showOutputs OpenflowDeploymentByocShowOutput[]
    Outputs the result of SHOW OPENFLOW DEPLOYMENTS for the given deployment.
    type string
    Specifies the type of the Openflow deployment. This field is used to detect when the deployment type was changed outside of Terraform and to recreate the resource when that happens.
    describe_outputs Sequence[OpenflowDeploymentByocDescribeOutput]
    Outputs the result of DESCRIBE OPENFLOW DEPLOYMENT for the given deployment.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    id str
    The provider-assigned unique ID for this managed resource.
    parameters Sequence[OpenflowDeploymentByocParameter]
    Outputs the result of SHOW PARAMETERS IN OPENFLOW DEPLOYMENT for the given deployment.
    show_outputs Sequence[OpenflowDeploymentByocShowOutput]
    Outputs the result of SHOW OPENFLOW DEPLOYMENTS for the given deployment.
    type str
    Specifies the type of the Openflow deployment. This field is used to detect when the deployment type was changed outside of Terraform and to recreate the resource when that happens.
    describeOutputs List<Property Map>
    Outputs the result of DESCRIBE OPENFLOW DEPLOYMENT for the given deployment.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.
    parameters List<Property Map>
    Outputs the result of SHOW PARAMETERS IN OPENFLOW DEPLOYMENT for the given deployment.
    showOutputs List<Property Map>
    Outputs the result of SHOW OPENFLOW DEPLOYMENTS for the given deployment.
    type String
    Specifies the type of the Openflow deployment. This field is used to detect when the deployment type was changed outside of Terraform and to recreate the resource when that happens.

    Look up Existing OpenflowDeploymentByoc Resource

    Get an existing OpenflowDeploymentByoc 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?: OpenflowDeploymentByocState, opts?: CustomResourceOptions): OpenflowDeploymentByoc
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        custom_ingress_hostname: Optional[str] = None,
        describe_outputs: Optional[Sequence[OpenflowDeploymentByocDescribeOutputArgs]] = None,
        display_name: Optional[str] = None,
        event_table: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[Sequence[OpenflowDeploymentByocParameterArgs]] = None,
        show_outputs: Optional[Sequence[OpenflowDeploymentByocShowOutputArgs]] = None,
        type: Optional[str] = None,
        use_private_link: Optional[str] = None,
        use_user_auth_over_privatelink: Optional[str] = None,
        vpc_type: Optional[str] = None) -> OpenflowDeploymentByoc
    func GetOpenflowDeploymentByoc(ctx *Context, name string, id IDInput, state *OpenflowDeploymentByocState, opts ...ResourceOption) (*OpenflowDeploymentByoc, error)
    public static OpenflowDeploymentByoc Get(string name, Input<string> id, OpenflowDeploymentByocState? state, CustomResourceOptions? opts = null)
    public static OpenflowDeploymentByoc get(String name, Output<String> id, OpenflowDeploymentByocState state, CustomResourceOptions options)
    resources:  _:    type: snowflake:OpenflowDeploymentByoc    get:      id: ${id}
    import {
  to = snowflake_openflow_deployment_byoc.example
  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.
    The following state arguments are supported:
    Comment string
    Specifies a comment for the Openflow deployment.
    CustomIngressHostname string
    Specifies a custom hostname for ingress into the deployment.
    DescribeOutputs List<OpenflowDeploymentByocDescribeOutput>
    Outputs the result of DESCRIBE OPENFLOW DEPLOYMENT for the given deployment.
    DisplayName string
    A free-text alias for the deployment. Shown in the Openflow UI in place of the deployment's identifier when set.
    EventTable string
    Fully qualified name of an event table the deployment logs to. For more information, check EVENT_TABLE documentation.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Name string
    Specifies the identifier for the Openflow deployment; must be unique for the account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Parameters List<OpenflowDeploymentByocParameter>
    Outputs the result of SHOW PARAMETERS IN OPENFLOW DEPLOYMENT for the given deployment.
    ShowOutputs List<OpenflowDeploymentByocShowOutput>
    Outputs the result of SHOW OPENFLOW DEPLOYMENTS for the given deployment.
    Type string
    Specifies the type of the Openflow deployment. This field is used to detect when the deployment type was changed outside of Terraform and to recreate the resource when that happens.
    UsePrivateLink string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the deployment is reached over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    UseUserAuthOverPrivatelink string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether user authentication is performed over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    VpcType string
    Specifies whether the deployment's VPC is created by Snowflake or supplied by you. Valid values are (case-insensitive): MANAGED | PROVIDED.
    Comment string
    Specifies a comment for the Openflow deployment.
    CustomIngressHostname string
    Specifies a custom hostname for ingress into the deployment.
    DescribeOutputs []OpenflowDeploymentByocDescribeOutputArgs
    Outputs the result of DESCRIBE OPENFLOW DEPLOYMENT for the given deployment.
    DisplayName string
    A free-text alias for the deployment. Shown in the Openflow UI in place of the deployment's identifier when set.
    EventTable string
    Fully qualified name of an event table the deployment logs to. For more information, check EVENT_TABLE documentation.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Name string
    Specifies the identifier for the Openflow deployment; must be unique for the account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Parameters []OpenflowDeploymentByocParameterArgs
    Outputs the result of SHOW PARAMETERS IN OPENFLOW DEPLOYMENT for the given deployment.
    ShowOutputs []OpenflowDeploymentByocShowOutputArgs
    Outputs the result of SHOW OPENFLOW DEPLOYMENTS for the given deployment.
    Type string
    Specifies the type of the Openflow deployment. This field is used to detect when the deployment type was changed outside of Terraform and to recreate the resource when that happens.
    UsePrivateLink string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the deployment is reached over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    UseUserAuthOverPrivatelink string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether user authentication is performed over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    VpcType string
    Specifies whether the deployment's VPC is created by Snowflake or supplied by you. Valid values are (case-insensitive): MANAGED | PROVIDED.
    comment string
    Specifies a comment for the Openflow deployment.
    custom_ingress_hostname string
    Specifies a custom hostname for ingress into the deployment.
    describe_outputs list(object)
    Outputs the result of DESCRIBE OPENFLOW DEPLOYMENT for the given deployment.
    display_name string
    A free-text alias for the deployment. Shown in the Openflow UI in place of the deployment's identifier when set.
    event_table string
    Fully qualified name of an event table the deployment logs to. For more information, check EVENT_TABLE documentation.
    fully_qualified_name string
    Fully qualified name of the resource. For more information, see object name resolution.
    name string
    Specifies the identifier for the Openflow deployment; must be unique for the account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    parameters list(object)
    Outputs the result of SHOW PARAMETERS IN OPENFLOW DEPLOYMENT for the given deployment.
    show_outputs list(object)
    Outputs the result of SHOW OPENFLOW DEPLOYMENTS for the given deployment.
    type string
    Specifies the type of the Openflow deployment. This field is used to detect when the deployment type was changed outside of Terraform and to recreate the resource when that happens.
    use_private_link string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the deployment is reached over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    use_user_auth_over_privatelink string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether user authentication is performed over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    vpc_type string
    Specifies whether the deployment's VPC is created by Snowflake or supplied by you. Valid values are (case-insensitive): MANAGED | PROVIDED.
    comment String
    Specifies a comment for the Openflow deployment.
    customIngressHostname String
    Specifies a custom hostname for ingress into the deployment.
    describeOutputs List<OpenflowDeploymentByocDescribeOutput>
    Outputs the result of DESCRIBE OPENFLOW DEPLOYMENT for the given deployment.
    displayName String
    A free-text alias for the deployment. Shown in the Openflow UI in place of the deployment's identifier when set.
    eventTable String
    Fully qualified name of an event table the deployment logs to. For more information, check EVENT_TABLE documentation.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    name String
    Specifies the identifier for the Openflow deployment; must be unique for the account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    parameters List<OpenflowDeploymentByocParameter>
    Outputs the result of SHOW PARAMETERS IN OPENFLOW DEPLOYMENT for the given deployment.
    showOutputs List<OpenflowDeploymentByocShowOutput>
    Outputs the result of SHOW OPENFLOW DEPLOYMENTS for the given deployment.
    type String
    Specifies the type of the Openflow deployment. This field is used to detect when the deployment type was changed outside of Terraform and to recreate the resource when that happens.
    usePrivateLink String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the deployment is reached over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    useUserAuthOverPrivatelink String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether user authentication is performed over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    vpcType String
    Specifies whether the deployment's VPC is created by Snowflake or supplied by you. Valid values are (case-insensitive): MANAGED | PROVIDED.
    comment string
    Specifies a comment for the Openflow deployment.
    customIngressHostname string
    Specifies a custom hostname for ingress into the deployment.
    describeOutputs OpenflowDeploymentByocDescribeOutput[]
    Outputs the result of DESCRIBE OPENFLOW DEPLOYMENT for the given deployment.
    displayName string
    A free-text alias for the deployment. Shown in the Openflow UI in place of the deployment's identifier when set.
    eventTable string
    Fully qualified name of an event table the deployment logs to. For more information, check EVENT_TABLE documentation.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    name string
    Specifies the identifier for the Openflow deployment; must be unique for the account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    parameters OpenflowDeploymentByocParameter[]
    Outputs the result of SHOW PARAMETERS IN OPENFLOW DEPLOYMENT for the given deployment.
    showOutputs OpenflowDeploymentByocShowOutput[]
    Outputs the result of SHOW OPENFLOW DEPLOYMENTS for the given deployment.
    type string
    Specifies the type of the Openflow deployment. This field is used to detect when the deployment type was changed outside of Terraform and to recreate the resource when that happens.
    usePrivateLink string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the deployment is reached over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    useUserAuthOverPrivatelink string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether user authentication is performed over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    vpcType string
    Specifies whether the deployment's VPC is created by Snowflake or supplied by you. Valid values are (case-insensitive): MANAGED | PROVIDED.
    comment str
    Specifies a comment for the Openflow deployment.
    custom_ingress_hostname str
    Specifies a custom hostname for ingress into the deployment.
    describe_outputs Sequence[OpenflowDeploymentByocDescribeOutputArgs]
    Outputs the result of DESCRIBE OPENFLOW DEPLOYMENT for the given deployment.
    display_name str
    A free-text alias for the deployment. Shown in the Openflow UI in place of the deployment's identifier when set.
    event_table str
    Fully qualified name of an event table the deployment logs to. For more information, check EVENT_TABLE documentation.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    name str
    Specifies the identifier for the Openflow deployment; must be unique for the account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    parameters Sequence[OpenflowDeploymentByocParameterArgs]
    Outputs the result of SHOW PARAMETERS IN OPENFLOW DEPLOYMENT for the given deployment.
    show_outputs Sequence[OpenflowDeploymentByocShowOutputArgs]
    Outputs the result of SHOW OPENFLOW DEPLOYMENTS for the given deployment.
    type str
    Specifies the type of the Openflow deployment. This field is used to detect when the deployment type was changed outside of Terraform and to recreate the resource when that happens.
    use_private_link str
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the deployment is reached over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    use_user_auth_over_privatelink str
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether user authentication is performed over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    vpc_type str
    Specifies whether the deployment's VPC is created by Snowflake or supplied by you. Valid values are (case-insensitive): MANAGED | PROVIDED.
    comment String
    Specifies a comment for the Openflow deployment.
    customIngressHostname String
    Specifies a custom hostname for ingress into the deployment.
    describeOutputs List<Property Map>
    Outputs the result of DESCRIBE OPENFLOW DEPLOYMENT for the given deployment.
    displayName String
    A free-text alias for the deployment. Shown in the Openflow UI in place of the deployment's identifier when set.
    eventTable String
    Fully qualified name of an event table the deployment logs to. For more information, check EVENT_TABLE documentation.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    name String
    Specifies the identifier for the Openflow deployment; must be unique for the account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    parameters List<Property Map>
    Outputs the result of SHOW PARAMETERS IN OPENFLOW DEPLOYMENT for the given deployment.
    showOutputs List<Property Map>
    Outputs the result of SHOW OPENFLOW DEPLOYMENTS for the given deployment.
    type String
    Specifies the type of the Openflow deployment. This field is used to detect when the deployment type was changed outside of Terraform and to recreate the resource when that happens.
    usePrivateLink String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether the deployment is reached over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    useUserAuthOverPrivatelink String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether user authentication is performed over private link. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    vpcType String
    Specifies whether the deployment's VPC is created by Snowflake or supplied by you. Valid values are (case-insensitive): MANAGED | PROVIDED.

    Supporting Types

    OpenflowDeploymentByocDescribeOutput, OpenflowDeploymentByocDescribeOutputArgs

    Comment string
    CustomIngressHostname string
    DisplayName string
    Key string
    Name string
    Owner string
    Status string
    Type string
    UsePrivateLink bool
    UseUserAuthOverPrivateLink bool
    VpcType string
    Comment string
    CustomIngressHostname string
    DisplayName string
    Key string
    Name string
    Owner string
    Status string
    Type string
    UsePrivateLink bool
    UseUserAuthOverPrivateLink bool
    VpcType string
    comment String
    customIngressHostname String
    displayName String
    key String
    name String
    owner String
    status String
    type String
    usePrivateLink Boolean
    useUserAuthOverPrivateLink Boolean
    vpcType String
    comment string
    customIngressHostname string
    displayName string
    key string
    name string
    owner string
    status string
    type string
    usePrivateLink boolean
    useUserAuthOverPrivateLink boolean
    vpcType string
    comment String
    customIngressHostname String
    displayName String
    key String
    name String
    owner String
    status String
    type String
    usePrivateLink Boolean
    useUserAuthOverPrivateLink Boolean
    vpcType String

    OpenflowDeploymentByocParameter, OpenflowDeploymentByocParameterArgs

    OpenflowDeploymentByocParameterEventTable, OpenflowDeploymentByocParameterEventTableArgs

    Default string
    Description string
    Key string
    Level string
    Value string
    Default string
    Description string
    Key string
    Level string
    Value string
    default string
    description string
    key string
    level string
    value string
    default_ String
    description String
    key String
    level String
    value String
    default string
    description string
    key string
    level string
    value string
    default String
    description String
    key String
    level String
    value String

    OpenflowDeploymentByocShowOutput, OpenflowDeploymentByocShowOutputArgs

    Comment string
    CreatedOn string
    CustomIngressHostname string
    DisplayName string
    Key string
    Name string
    Owner string
    Status string
    Type string
    UpdatedOn string
    UsePrivateLink bool
    UseUserAuthOverPrivateLink bool
    VpcType string
    Comment string
    CreatedOn string
    CustomIngressHostname string
    DisplayName string
    Key string
    Name string
    Owner string
    Status string
    Type string
    UpdatedOn string
    UsePrivateLink bool
    UseUserAuthOverPrivateLink bool
    VpcType string
    comment String
    createdOn String
    customIngressHostname String
    displayName String
    key String
    name String
    owner String
    status String
    type String
    updatedOn String
    usePrivateLink Boolean
    useUserAuthOverPrivateLink Boolean
    vpcType String
    comment string
    createdOn string
    customIngressHostname string
    displayName string
    key string
    name string
    owner string
    status string
    type string
    updatedOn string
    usePrivateLink boolean
    useUserAuthOverPrivateLink boolean
    vpcType string
    comment String
    createdOn String
    customIngressHostname String
    displayName String
    key String
    name String
    owner String
    status String
    type String
    updatedOn String
    usePrivateLink Boolean
    useUserAuthOverPrivateLink Boolean
    vpcType String

    Import

    $ pulumi import snowflake:index/openflowDeploymentByoc:OpenflowDeploymentByoc example '"<deployment_name>"'

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Viewing docs for Snowflake v2.21.0
    published on Friday, Sep 11, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-snowflake

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial