ObjectParameter

Snowflake v2.13.0, Feb 26 26

Viewing docs for Snowflake v2.13.0
published on Thursday, Feb 26, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

Viewing docs for Snowflake v2.13.0
published on Thursday, Feb 26, 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 preview_features_enabled 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.

!> Warning This resource shouldn’t be used with snowflake.CurrentAccount resource in the same configuration to set parameters on the current account, as it may lead to unexpected behavior. Unless this resource is only used to manage the following parameters that are not supported by snowflake.CurrentAccount. More details in the snowflake.CurrentAccount resource documentation.

Note This resource does not support all account parameters. The supported ones are listed below. This feature gap will be addressed in future releases.

Example Usage

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

const d = new snowflake.Database("d", {name: "TEST_DB"});
const o = new snowflake.ObjectParameter("o", {
    key: "SUSPEND_TASK_AFTER_NUM_FAILURES",
    value: "33",
    objectType: "DATABASE",
    objectIdentifiers: [{
        name: d.name,
    }],
});
const s = new snowflake.Schema("s", {
    name: "TEST_SCHEMA",
    database: d.name,
});
const o2 = new snowflake.ObjectParameter("o2", {
    key: "USER_TASK_TIMEOUT_MS",
    value: "500",
    objectType: "SCHEMA",
    objectIdentifiers: [{
        database: d.name,
        name: s.name,
    }],
});
const t = new snowflake.Table("t", {
    name: "TEST_TABLE",
    database: d.name,
    schema: s.name,
    columns: [{
        name: "id",
        type: "NUMBER",
    }],
});
const o3 = new snowflake.ObjectParameter("o3", {
    key: "DATA_RETENTION_TIME_IN_DAYS",
    value: "89",
    objectType: "TABLE",
    objectIdentifiers: [{
        database: d.name,
        schema: s.name,
        name: t.name,
    }],
});
// Setting object parameter at account level
const o4 = new snowflake.ObjectParameter("o4", {
    key: "DATA_RETENTION_TIME_IN_DAYS",
    value: "89",
    onAccount: true,
});

import pulumi
import pulumi_snowflake as snowflake

d = snowflake.Database("d", name="TEST_DB")
o = snowflake.ObjectParameter("o",
    key="SUSPEND_TASK_AFTER_NUM_FAILURES",
    value="33",
    object_type="DATABASE",
    object_identifiers=[{
        "name": d.name,
    }])
s = snowflake.Schema("s",
    name="TEST_SCHEMA",
    database=d.name)
o2 = snowflake.ObjectParameter("o2",
    key="USER_TASK_TIMEOUT_MS",
    value="500",
    object_type="SCHEMA",
    object_identifiers=[{
        "database": d.name,
        "name": s.name,
    }])
t = snowflake.Table("t",
    name="TEST_TABLE",
    database=d.name,
    schema=s.name,
    columns=[{
        "name": "id",
        "type": "NUMBER",
    }])
o3 = snowflake.ObjectParameter("o3",
    key="DATA_RETENTION_TIME_IN_DAYS",
    value="89",
    object_type="TABLE",
    object_identifiers=[{
        "database": d.name,
        "schema": s.name,
        "name": t.name,
    }])
# Setting object parameter at account level
o4 = snowflake.ObjectParameter("o4",
    key="DATA_RETENTION_TIME_IN_DAYS",
    value="89",
    on_account=True)

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 {
		d, err := snowflake.NewDatabase(ctx, "d", &snowflake.DatabaseArgs{
			Name: pulumi.String("TEST_DB"),
		})
		if err != nil {
			return err
		}
		_, err = snowflake.NewObjectParameter(ctx, "o", &snowflake.ObjectParameterArgs{
			Key:        pulumi.String("SUSPEND_TASK_AFTER_NUM_FAILURES"),
			Value:      pulumi.String("33"),
			ObjectType: pulumi.String("DATABASE"),
			ObjectIdentifiers: snowflake.ObjectParameterObjectIdentifierArray{
				&snowflake.ObjectParameterObjectIdentifierArgs{
					Name: d.Name,
				},
			},
		})
		if err != nil {
			return err
		}
		s, err := snowflake.NewSchema(ctx, "s", &snowflake.SchemaArgs{
			Name:     pulumi.String("TEST_SCHEMA"),
			Database: d.Name,
		})
		if err != nil {
			return err
		}
		_, err = snowflake.NewObjectParameter(ctx, "o2", &snowflake.ObjectParameterArgs{
			Key:        pulumi.String("USER_TASK_TIMEOUT_MS"),
			Value:      pulumi.String("500"),
			ObjectType: pulumi.String("SCHEMA"),
			ObjectIdentifiers: snowflake.ObjectParameterObjectIdentifierArray{
				&snowflake.ObjectParameterObjectIdentifierArgs{
					Database: d.Name,
					Name:     s.Name,
				},
			},
		})
		if err != nil {
			return err
		}
		t, err := snowflake.NewTable(ctx, "t", &snowflake.TableArgs{
			Name:     pulumi.String("TEST_TABLE"),
			Database: d.Name,
			Schema:   s.Name,
			Columns: snowflake.TableColumnArray{
				&snowflake.TableColumnArgs{
					Name: pulumi.String("id"),
					Type: pulumi.String("NUMBER"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = snowflake.NewObjectParameter(ctx, "o3", &snowflake.ObjectParameterArgs{
			Key:        pulumi.String("DATA_RETENTION_TIME_IN_DAYS"),
			Value:      pulumi.String("89"),
			ObjectType: pulumi.String("TABLE"),
			ObjectIdentifiers: snowflake.ObjectParameterObjectIdentifierArray{
				&snowflake.ObjectParameterObjectIdentifierArgs{
					Database: d.Name,
					Schema:   s.Name,
					Name:     t.Name,
				},
			},
		})
		if err != nil {
			return err
		}
		// Setting object parameter at account level
		_, err = snowflake.NewObjectParameter(ctx, "o4", &snowflake.ObjectParameterArgs{
			Key:       pulumi.String("DATA_RETENTION_TIME_IN_DAYS"),
			Value:     pulumi.String("89"),
			OnAccount: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var d = new Snowflake.Database("d", new()
    {
        Name = "TEST_DB",
    });

    var o = new Snowflake.ObjectParameter("o", new()
    {
        Key = "SUSPEND_TASK_AFTER_NUM_FAILURES",
        Value = "33",
        ObjectType = "DATABASE",
        ObjectIdentifiers = new[]
        {
            new Snowflake.Inputs.ObjectParameterObjectIdentifierArgs
            {
                Name = d.Name,
            },
        },
    });

    var s = new Snowflake.Schema("s", new()
    {
        Name = "TEST_SCHEMA",
        Database = d.Name,
    });

    var o2 = new Snowflake.ObjectParameter("o2", new()
    {
        Key = "USER_TASK_TIMEOUT_MS",
        Value = "500",
        ObjectType = "SCHEMA",
        ObjectIdentifiers = new[]
        {
            new Snowflake.Inputs.ObjectParameterObjectIdentifierArgs
            {
                Database = d.Name,
                Name = s.Name,
            },
        },
    });

    var t = new Snowflake.Table("t", new()
    {
        Name = "TEST_TABLE",
        Database = d.Name,
        Schema = s.Name,
        Columns = new[]
        {
            new Snowflake.Inputs.TableColumnArgs
            {
                Name = "id",
                Type = "NUMBER",
            },
        },
    });

    var o3 = new Snowflake.ObjectParameter("o3", new()
    {
        Key = "DATA_RETENTION_TIME_IN_DAYS",
        Value = "89",
        ObjectType = "TABLE",
        ObjectIdentifiers = new[]
        {
            new Snowflake.Inputs.ObjectParameterObjectIdentifierArgs
            {
                Database = d.Name,
                Schema = s.Name,
                Name = t.Name,
            },
        },
    });

    // Setting object parameter at account level
    var o4 = new Snowflake.ObjectParameter("o4", new()
    {
        Key = "DATA_RETENTION_TIME_IN_DAYS",
        Value = "89",
        OnAccount = true,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.Database;
import com.pulumi.snowflake.DatabaseArgs;
import com.pulumi.snowflake.ObjectParameter;
import com.pulumi.snowflake.ObjectParameterArgs;
import com.pulumi.snowflake.inputs.ObjectParameterObjectIdentifierArgs;
import com.pulumi.snowflake.Schema;
import com.pulumi.snowflake.SchemaArgs;
import com.pulumi.snowflake.Table;
import com.pulumi.snowflake.TableArgs;
import com.pulumi.snowflake.inputs.TableColumnArgs;
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 d = new Database("d", DatabaseArgs.builder()
            .name("TEST_DB")
            .build());

        var o = new ObjectParameter("o", ObjectParameterArgs.builder()
            .key("SUSPEND_TASK_AFTER_NUM_FAILURES")
            .value("33")
            .objectType("DATABASE")
            .objectIdentifiers(ObjectParameterObjectIdentifierArgs.builder()
                .name(d.name())
                .build())
            .build());

        var s = new Schema("s", SchemaArgs.builder()
            .name("TEST_SCHEMA")
            .database(d.name())
            .build());

        var o2 = new ObjectParameter("o2", ObjectParameterArgs.builder()
            .key("USER_TASK_TIMEOUT_MS")
            .value("500")
            .objectType("SCHEMA")
            .objectIdentifiers(ObjectParameterObjectIdentifierArgs.builder()
                .database(d.name())
                .name(s.name())
                .build())
            .build());

        var t = new Table("t", TableArgs.builder()
            .name("TEST_TABLE")
            .database(d.name())
            .schema(s.name())
            .columns(TableColumnArgs.builder()
                .name("id")
                .type("NUMBER")
                .build())
            .build());

        var o3 = new ObjectParameter("o3", ObjectParameterArgs.builder()
            .key("DATA_RETENTION_TIME_IN_DAYS")
            .value("89")
            .objectType("TABLE")
            .objectIdentifiers(ObjectParameterObjectIdentifierArgs.builder()
                .database(d.name())
                .schema(s.name())
                .name(t.name())
                .build())
            .build());

        // Setting object parameter at account level
        var o4 = new ObjectParameter("o4", ObjectParameterArgs.builder()
            .key("DATA_RETENTION_TIME_IN_DAYS")
            .value("89")
            .onAccount(true)
            .build());

    }
}

resources:
  d:
    type: snowflake:Database
    properties:
      name: TEST_DB
  o:
    type: snowflake:ObjectParameter
    properties:
      key: SUSPEND_TASK_AFTER_NUM_FAILURES
      value: '33'
      objectType: DATABASE
      objectIdentifiers:
        - name: ${d.name}
  s:
    type: snowflake:Schema
    properties:
      name: TEST_SCHEMA
      database: ${d.name}
  o2:
    type: snowflake:ObjectParameter
    properties:
      key: USER_TASK_TIMEOUT_MS
      value: '500'
      objectType: SCHEMA
      objectIdentifiers:
        - database: ${d.name}
          name: ${s.name}
  t:
    type: snowflake:Table
    properties:
      name: TEST_TABLE
      database: ${d.name}
      schema: ${s.name}
      columns:
        - name: id
          type: NUMBER
  o3:
    type: snowflake:ObjectParameter
    properties:
      key: DATA_RETENTION_TIME_IN_DAYS
      value: '89'
      objectType: TABLE
      objectIdentifiers:
        - database: ${d.name}
          schema: ${s.name}
          name: ${t.name}
  # Setting object parameter at account level
  o4:
    type: snowflake:ObjectParameter
    properties:
      key: DATA_RETENTION_TIME_IN_DAYS
      value: '89'
      onAccount: true

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

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

Create ObjectParameter Resource

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

Constructor syntax

new ObjectParameter(name: string, args: ObjectParameterArgs, opts?: CustomResourceOptions);

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

@overload
def ObjectParameter(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    key: Optional[str] = None,
                    value: Optional[str] = None,
                    object_identifiers: Optional[Sequence[ObjectParameterObjectIdentifierArgs]] = None,
                    object_type: Optional[str] = None,
                    on_account: Optional[bool] = None)

func NewObjectParameter(ctx *Context, name string, args ObjectParameterArgs, opts ...ResourceOption) (*ObjectParameter, error)

public ObjectParameter(string name, ObjectParameterArgs args, CustomResourceOptions? opts = null)

public ObjectParameter(String name, ObjectParameterArgs args)
public ObjectParameter(String name, ObjectParameterArgs args, CustomResourceOptions options)

type: snowflake:ObjectParameter
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 ObjectParameterArgs: 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 ObjectParameterArgs: 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 ObjectParameterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args ObjectParameterArgs: 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 objectParameterResource = new Snowflake.ObjectParameter("objectParameterResource", new()
{
    Key = "string",
    Value = "string",
    ObjectIdentifiers = new[]
    {
        new Snowflake.Inputs.ObjectParameterObjectIdentifierArgs
        {
            Name = "string",
            Database = "string",
            Schema = "string",
        },
    },
    ObjectType = "string",
    OnAccount = false,
});

example, err := snowflake.NewObjectParameter(ctx, "objectParameterResource", &snowflake.ObjectParameterArgs{
	Key:   pulumi.String("string"),
	Value: pulumi.String("string"),
	ObjectIdentifiers: snowflake.ObjectParameterObjectIdentifierArray{
		&snowflake.ObjectParameterObjectIdentifierArgs{
			Name:     pulumi.String("string"),
			Database: pulumi.String("string"),
			Schema:   pulumi.String("string"),
		},
	},
	ObjectType: pulumi.String("string"),
	OnAccount:  pulumi.Bool(false),
})

var objectParameterResource = new ObjectParameter("objectParameterResource", ObjectParameterArgs.builder()
    .key("string")
    .value("string")
    .objectIdentifiers(ObjectParameterObjectIdentifierArgs.builder()
        .name("string")
        .database("string")
        .schema("string")
        .build())
    .objectType("string")
    .onAccount(false)
    .build());

object_parameter_resource = snowflake.ObjectParameter("objectParameterResource",
    key="string",
    value="string",
    object_identifiers=[{
        "name": "string",
        "database": "string",
        "schema": "string",
    }],
    object_type="string",
    on_account=False)

const objectParameterResource = new snowflake.ObjectParameter("objectParameterResource", {
    key: "string",
    value: "string",
    objectIdentifiers: [{
        name: "string",
        database: "string",
        schema: "string",
    }],
    objectType: "string",
    onAccount: false,
});

type: snowflake:ObjectParameter
properties:
    key: string
    objectIdentifiers:
        - database: string
          name: string
          schema: string
    objectType: string
    onAccount: false
    value: string