Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake Provider
  3. API Docs
  4. StreamOnView
Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake

snowflake.StreamOnView

Explore with Pulumi AI

Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake

Import

$ pulumi import snowflake:index/streamOnView:StreamOnView example '"<database_name>"."<schema_name>"."<stream_name>"'
Copy

Create StreamOnView Resource

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

Constructor syntax

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

@overload
def StreamOnView(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 database: Optional[str] = None,
                 schema: Optional[str] = None,
                 view: Optional[str] = None,
                 append_only: Optional[str] = None,
                 at: Optional[StreamOnViewAtArgs] = None,
                 before: Optional[StreamOnViewBeforeArgs] = None,
                 comment: Optional[str] = None,
                 copy_grants: Optional[bool] = None,
                 name: Optional[str] = None,
                 show_initial_rows: Optional[str] = None)
func NewStreamOnView(ctx *Context, name string, args StreamOnViewArgs, opts ...ResourceOption) (*StreamOnView, error)
public StreamOnView(string name, StreamOnViewArgs args, CustomResourceOptions? opts = null)
public StreamOnView(String name, StreamOnViewArgs args)
public StreamOnView(String name, StreamOnViewArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. StreamOnViewArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. StreamOnViewArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. StreamOnViewArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. StreamOnViewArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. StreamOnViewArgs
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 streamOnViewResource = new Snowflake.StreamOnView("streamOnViewResource", new()
{
    Database = "string",
    Schema = "string",
    View = "string",
    AppendOnly = "string",
    At = new Snowflake.Inputs.StreamOnViewAtArgs
    {
        Offset = "string",
        Statement = "string",
        Stream = "string",
        Timestamp = "string",
    },
    Before = new Snowflake.Inputs.StreamOnViewBeforeArgs
    {
        Offset = "string",
        Statement = "string",
        Stream = "string",
        Timestamp = "string",
    },
    Comment = "string",
    CopyGrants = false,
    Name = "string",
    ShowInitialRows = "string",
});
Copy
example, err := snowflake.NewStreamOnView(ctx, "streamOnViewResource", &snowflake.StreamOnViewArgs{
	Database:   pulumi.String("string"),
	Schema:     pulumi.String("string"),
	View:       pulumi.String("string"),
	AppendOnly: pulumi.String("string"),
	At: &snowflake.StreamOnViewAtArgs{
		Offset:    pulumi.String("string"),
		Statement: pulumi.String("string"),
		Stream:    pulumi.String("string"),
		Timestamp: pulumi.String("string"),
	},
	Before: &snowflake.StreamOnViewBeforeArgs{
		Offset:    pulumi.String("string"),
		Statement: pulumi.String("string"),
		Stream:    pulumi.String("string"),
		Timestamp: pulumi.String("string"),
	},
	Comment:         pulumi.String("string"),
	CopyGrants:      pulumi.Bool(false),
	Name:            pulumi.String("string"),
	ShowInitialRows: pulumi.String("string"),
})
Copy
var streamOnViewResource = new StreamOnView("streamOnViewResource", StreamOnViewArgs.builder()
    .database("string")
    .schema("string")
    .view("string")
    .appendOnly("string")
    .at(StreamOnViewAtArgs.builder()
        .offset("string")
        .statement("string")
        .stream("string")
        .timestamp("string")
        .build())
    .before(StreamOnViewBeforeArgs.builder()
        .offset("string")
        .statement("string")
        .stream("string")
        .timestamp("string")
        .build())
    .comment("string")
    .copyGrants(false)
    .name("string")
    .showInitialRows("string")
    .build());
Copy
stream_on_view_resource = snowflake.StreamOnView("streamOnViewResource",
    database="string",
    schema="string",
    view="string",
    append_only="string",
    at={
        "offset": "string",
        "statement": "string",
        "stream": "string",
        "timestamp": "string",
    },
    before={
        "offset": "string",
        "statement": "string",
        "stream": "string",
        "timestamp": "string",
    },
    comment="string",
    copy_grants=False,
    name="string",
    show_initial_rows="string")
Copy
const streamOnViewResource = new snowflake.StreamOnView("streamOnViewResource", {
    database: "string",
    schema: "string",
    view: "string",
    appendOnly: "string",
    at: {
        offset: "string",
        statement: "string",
        stream: "string",
        timestamp: "string",
    },
    before: {
        offset: "string",
        statement: "string",
        stream: "string",
        timestamp: "string",
    },
    comment: "string",
    copyGrants: false,
    name: "string",
    showInitialRows: "string",
});
Copy
type: snowflake:StreamOnView
properties:
    appendOnly: string
    at:
        offset: string
        statement: string
        stream: string
        timestamp: string
    before:
        offset: string
        statement: string
        stream: string
        timestamp: string
    comment: string
    copyGrants: false
    database: string
    name: string
    schema: string
    showInitialRows: string
    view: string
Copy

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

Database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
View This property is required. string
Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
AppendOnly string
Specifies whether this is an append-only stream. 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.
At StreamOnViewAt
Before StreamOnViewBefore
Comment string
Specifies a comment for the stream.
CopyGrants bool
Name Changes to this property will trigger replacement. string
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ShowInitialRows string
Database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
View This property is required. string
Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
AppendOnly string
Specifies whether this is an append-only stream. 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.
At StreamOnViewAtArgs
Before StreamOnViewBeforeArgs
Comment string
Specifies a comment for the stream.
CopyGrants bool
Name Changes to this property will trigger replacement. string
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ShowInitialRows string
database
This property is required.
Changes to this property will trigger replacement.
String
The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema
This property is required.
Changes to this property will trigger replacement.
String
The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
view This property is required. String
Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
appendOnly String
Specifies whether this is an append-only stream. 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.
at StreamOnViewAt
before StreamOnViewBefore
comment String
Specifies a comment for the stream.
copyGrants Boolean
name Changes to this property will trigger replacement. String
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showInitialRows String
database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
view This property is required. string
Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
appendOnly string
Specifies whether this is an append-only stream. 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.
at StreamOnViewAt
before StreamOnViewBefore
comment string
Specifies a comment for the stream.
copyGrants boolean
name Changes to this property will trigger replacement. string
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showInitialRows string
database
This property is required.
Changes to this property will trigger replacement.
str
The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema
This property is required.
Changes to this property will trigger replacement.
str
The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
view This property is required. str
Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
append_only str
Specifies whether this is an append-only stream. 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.
at StreamOnViewAtArgs
before StreamOnViewBeforeArgs
comment str
Specifies a comment for the stream.
copy_grants bool
name Changes to this property will trigger replacement. str
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
show_initial_rows str
database
This property is required.
Changes to this property will trigger replacement.
String
The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema
This property is required.
Changes to this property will trigger replacement.
String
The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
view This property is required. String
Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
appendOnly String
Specifies whether this is an append-only stream. 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.
at Property Map
before Property Map
comment String
Specifies a comment for the stream.
copyGrants Boolean
name Changes to this property will trigger replacement. String
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showInitialRows String

Outputs

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

DescribeOutputs List<StreamOnViewDescribeOutput>
Outputs the result of DESCRIBE STREAM for the given stream.
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.
ShowOutputs List<StreamOnViewShowOutput>
Outputs the result of SHOW STREAMS for the given stream.
Stale bool
StreamType string
Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
DescribeOutputs []StreamOnViewDescribeOutput
Outputs the result of DESCRIBE STREAM for the given stream.
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.
ShowOutputs []StreamOnViewShowOutput
Outputs the result of SHOW STREAMS for the given stream.
Stale bool
StreamType string
Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
describeOutputs List<StreamOnViewDescribeOutput>
Outputs the result of DESCRIBE STREAM for the given stream.
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.
showOutputs List<StreamOnViewShowOutput>
Outputs the result of SHOW STREAMS for the given stream.
stale Boolean
streamType String
Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
describeOutputs StreamOnViewDescribeOutput[]
Outputs the result of DESCRIBE STREAM for the given stream.
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.
showOutputs StreamOnViewShowOutput[]
Outputs the result of SHOW STREAMS for the given stream.
stale boolean
streamType string
Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
describe_outputs Sequence[StreamOnViewDescribeOutput]
Outputs the result of DESCRIBE STREAM for the given stream.
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.
show_outputs Sequence[StreamOnViewShowOutput]
Outputs the result of SHOW STREAMS for the given stream.
stale bool
stream_type str
Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
describeOutputs List<Property Map>
Outputs the result of DESCRIBE STREAM for the given stream.
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.
showOutputs List<Property Map>
Outputs the result of SHOW STREAMS for the given stream.
stale Boolean
streamType String
Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

Look up Existing StreamOnView Resource

Get an existing StreamOnView 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?: StreamOnViewState, opts?: CustomResourceOptions): StreamOnView
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        append_only: Optional[str] = None,
        at: Optional[StreamOnViewAtArgs] = None,
        before: Optional[StreamOnViewBeforeArgs] = None,
        comment: Optional[str] = None,
        copy_grants: Optional[bool] = None,
        database: Optional[str] = None,
        describe_outputs: Optional[Sequence[StreamOnViewDescribeOutputArgs]] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        schema: Optional[str] = None,
        show_initial_rows: Optional[str] = None,
        show_outputs: Optional[Sequence[StreamOnViewShowOutputArgs]] = None,
        stale: Optional[bool] = None,
        stream_type: Optional[str] = None,
        view: Optional[str] = None) -> StreamOnView
func GetStreamOnView(ctx *Context, name string, id IDInput, state *StreamOnViewState, opts ...ResourceOption) (*StreamOnView, error)
public static StreamOnView Get(string name, Input<string> id, StreamOnViewState? state, CustomResourceOptions? opts = null)
public static StreamOnView get(String name, Output<String> id, StreamOnViewState state, CustomResourceOptions options)
resources:  _:    type: snowflake:StreamOnView    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AppendOnly string
Specifies whether this is an append-only stream. 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.
At StreamOnViewAt
Before StreamOnViewBefore
Comment string
Specifies a comment for the stream.
CopyGrants bool
Database Changes to this property will trigger replacement. string
The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
DescribeOutputs List<StreamOnViewDescribeOutput>
Outputs the result of DESCRIBE STREAM for the given stream.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Name Changes to this property will trigger replacement. string
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Schema Changes to this property will trigger replacement. string
The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ShowInitialRows string
ShowOutputs List<StreamOnViewShowOutput>
Outputs the result of SHOW STREAMS for the given stream.
Stale bool
StreamType string
Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
View string
Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
AppendOnly string
Specifies whether this is an append-only stream. 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.
At StreamOnViewAtArgs
Before StreamOnViewBeforeArgs
Comment string
Specifies a comment for the stream.
CopyGrants bool
Database Changes to this property will trigger replacement. string
The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
DescribeOutputs []StreamOnViewDescribeOutputArgs
Outputs the result of DESCRIBE STREAM for the given stream.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Name Changes to this property will trigger replacement. string
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Schema Changes to this property will trigger replacement. string
The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ShowInitialRows string
ShowOutputs []StreamOnViewShowOutputArgs
Outputs the result of SHOW STREAMS for the given stream.
Stale bool
StreamType string
Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
View string
Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
appendOnly String
Specifies whether this is an append-only stream. 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.
at StreamOnViewAt
before StreamOnViewBefore
comment String
Specifies a comment for the stream.
copyGrants Boolean
database Changes to this property will trigger replacement. String
The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
describeOutputs List<StreamOnViewDescribeOutput>
Outputs the result of DESCRIBE STREAM for the given stream.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
name Changes to this property will trigger replacement. String
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema Changes to this property will trigger replacement. String
The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showInitialRows String
showOutputs List<StreamOnViewShowOutput>
Outputs the result of SHOW STREAMS for the given stream.
stale Boolean
streamType String
Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
view String
Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
appendOnly string
Specifies whether this is an append-only stream. 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.
at StreamOnViewAt
before StreamOnViewBefore
comment string
Specifies a comment for the stream.
copyGrants boolean
database Changes to this property will trigger replacement. string
The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
describeOutputs StreamOnViewDescribeOutput[]
Outputs the result of DESCRIBE STREAM for the given stream.
fullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
name Changes to this property will trigger replacement. string
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema Changes to this property will trigger replacement. string
The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showInitialRows string
showOutputs StreamOnViewShowOutput[]
Outputs the result of SHOW STREAMS for the given stream.
stale boolean
streamType string
Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
view string
Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
append_only str
Specifies whether this is an append-only stream. 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.
at StreamOnViewAtArgs
before StreamOnViewBeforeArgs
comment str
Specifies a comment for the stream.
copy_grants bool
database Changes to this property will trigger replacement. str
The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
describe_outputs Sequence[StreamOnViewDescribeOutputArgs]
Outputs the result of DESCRIBE STREAM for the given stream.
fully_qualified_name str
Fully qualified name of the resource. For more information, see object name resolution.
name Changes to this property will trigger replacement. str
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema Changes to this property will trigger replacement. str
The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
show_initial_rows str
show_outputs Sequence[StreamOnViewShowOutputArgs]
Outputs the result of SHOW STREAMS for the given stream.
stale bool
stream_type str
Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
view str
Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
appendOnly String
Specifies whether this is an append-only stream. 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.
at Property Map
before Property Map
comment String
Specifies a comment for the stream.
copyGrants Boolean
database Changes to this property will trigger replacement. String
The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
describeOutputs List<Property Map>
Outputs the result of DESCRIBE STREAM for the given stream.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
name Changes to this property will trigger replacement. String
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
schema Changes to this property will trigger replacement. String
The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showInitialRows String
showOutputs List<Property Map>
Outputs the result of SHOW STREAMS for the given stream.
stale Boolean
streamType String
Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
view String
Specifies an identifier for the view the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.

Supporting Types

StreamOnViewAt
, StreamOnViewAtArgs

Offset string
Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
Statement string
Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
Stream string
Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
Timestamp string
Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.
Offset string
Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
Statement string
Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
Stream string
Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
Timestamp string
Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.
offset String
Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
statement String
Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
stream String
Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
timestamp String
Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.
offset string
Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
statement string
Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
stream string
Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
timestamp string
Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.
offset str
Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
statement str
Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
stream str
Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
timestamp str
Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.
offset String
Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
statement String
Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
stream String
Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
timestamp String
Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.

StreamOnViewBefore
, StreamOnViewBeforeArgs

Offset string
Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
Statement string
Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
Stream string
Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
Timestamp string
Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.
Offset string
Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
Statement string
Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
Stream string
Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
Timestamp string
Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.
offset String
Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
statement String
Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
stream String
Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
timestamp String
Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.
offset string
Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
statement string
Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
stream string
Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
timestamp string
Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.
offset str
Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
statement str
Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
stream str
Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
timestamp str
Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.
offset String
Specifies the difference in seconds from the current time to use for Time Travel, in the form -N where N can be an integer or arithmetic expression (e.g. -120 is 120 seconds, -30*60 is 1800 seconds or 30 minutes).
statement String
Specifies the query ID of a statement to use as the reference point for Time Travel. This parameter supports any statement of one of the following types: DML (e.g. INSERT, UPDATE, DELETE), TCL (BEGIN, COMMIT transaction), SELECT.
stream String
Specifies the identifier (i.e. name) for an existing stream on the queried table or view. The current offset in the stream is used as the AT point in time for returning change data for the source object.
timestamp String
Specifies an exact date and time to use for Time Travel. The value must be explicitly cast to a TIMESTAMP, TIMESTAMPLTZ, TIMESTAMPNTZ, or TIMESTAMP_TZ data type.

StreamOnViewDescribeOutput
, StreamOnViewDescribeOutputArgs

BaseTables List<string>
Comment string
CreatedOn string
DatabaseName string
InvalidReason string
Mode string
Name string
Owner string
OwnerRoleType string
SchemaName string
SourceType string
Stale bool
StaleAfter string
TableName string
Type string
BaseTables []string
Comment string
CreatedOn string
DatabaseName string
InvalidReason string
Mode string
Name string
Owner string
OwnerRoleType string
SchemaName string
SourceType string
Stale bool
StaleAfter string
TableName string
Type string
baseTables List<String>
comment String
createdOn String
databaseName String
invalidReason String
mode String
name String
owner String
ownerRoleType String
schemaName String
sourceType String
stale Boolean
staleAfter String
tableName String
type String
baseTables string[]
comment string
createdOn string
databaseName string
invalidReason string
mode string
name string
owner string
ownerRoleType string
schemaName string
sourceType string
stale boolean
staleAfter string
tableName string
type string
baseTables List<String>
comment String
createdOn String
databaseName String
invalidReason String
mode String
name String
owner String
ownerRoleType String
schemaName String
sourceType String
stale Boolean
staleAfter String
tableName String
type String

StreamOnViewShowOutput
, StreamOnViewShowOutputArgs

BaseTables List<string>
Comment string
CreatedOn string
DatabaseName string
InvalidReason string
Mode string
Name string
Owner string
OwnerRoleType string
SchemaName string
SourceType string
Stale bool
StaleAfter string
TableName string
Type string
BaseTables []string
Comment string
CreatedOn string
DatabaseName string
InvalidReason string
Mode string
Name string
Owner string
OwnerRoleType string
SchemaName string
SourceType string
Stale bool
StaleAfter string
TableName string
Type string
baseTables List<String>
comment String
createdOn String
databaseName String
invalidReason String
mode String
name String
owner String
ownerRoleType String
schemaName String
sourceType String
stale Boolean
staleAfter String
tableName String
type String
baseTables string[]
comment string
createdOn string
databaseName string
invalidReason string
mode string
name string
owner string
ownerRoleType string
schemaName string
sourceType string
stale boolean
staleAfter string
tableName string
type string
baseTables List<String>
comment String
createdOn String
databaseName String
invalidReason String
mode String
name String
owner String
ownerRoleType String
schemaName String
sourceType String
stale Boolean
staleAfter String
tableName String
type String

Package Details

Repository
Snowflake pulumi/pulumi-snowflake
License
Apache-2.0
Notes
This Pulumi package is based on the snowflake Terraform Provider.
Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake