Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake Provider
  3. API Docs
  4. StreamOnExternalTable
Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-snowflake

snowflake.StreamOnExternalTable

Explore with Pulumi AI

Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-snowflake

Import

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

Create StreamOnExternalTable Resource

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

Constructor syntax

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

@overload
def StreamOnExternalTable(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          database: Optional[str] = None,
                          external_table: Optional[str] = None,
                          schema: Optional[str] = None,
                          at: Optional[StreamOnExternalTableAtArgs] = None,
                          before: Optional[StreamOnExternalTableBeforeArgs] = None,
                          comment: Optional[str] = None,
                          copy_grants: Optional[bool] = None,
                          insert_only: Optional[str] = None,
                          name: Optional[str] = None)
func NewStreamOnExternalTable(ctx *Context, name string, args StreamOnExternalTableArgs, opts ...ResourceOption) (*StreamOnExternalTable, error)
public StreamOnExternalTable(string name, StreamOnExternalTableArgs args, CustomResourceOptions? opts = null)
public StreamOnExternalTable(String name, StreamOnExternalTableArgs args)
public StreamOnExternalTable(String name, StreamOnExternalTableArgs args, CustomResourceOptions options)

type: snowflake:StreamOnExternalTable
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. StreamOnExternalTableArgs
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. StreamOnExternalTableArgs
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. StreamOnExternalTableArgs
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. StreamOnExternalTableArgs
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. StreamOnExternalTableArgs
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 streamOnExternalTableResource = new Snowflake.StreamOnExternalTable("streamOnExternalTableResource", new()
{
    Database = "string",
    ExternalTable = "string",
    Schema = "string",
    At = new Snowflake.Inputs.StreamOnExternalTableAtArgs
    {
        Offset = "string",
        Statement = "string",
        Stream = "string",
        Timestamp = "string",
    },
    Before = new Snowflake.Inputs.StreamOnExternalTableBeforeArgs
    {
        Offset = "string",
        Statement = "string",
        Stream = "string",
        Timestamp = "string",
    },
    Comment = "string",
    CopyGrants = false,
    InsertOnly = "string",
    Name = "string",
});
Copy
example, err := snowflake.NewStreamOnExternalTable(ctx, "streamOnExternalTableResource", &snowflake.StreamOnExternalTableArgs{
	Database:      pulumi.String("string"),
	ExternalTable: pulumi.String("string"),
	Schema:        pulumi.String("string"),
	At: &snowflake.StreamOnExternalTableAtArgs{
		Offset:    pulumi.String("string"),
		Statement: pulumi.String("string"),
		Stream:    pulumi.String("string"),
		Timestamp: pulumi.String("string"),
	},
	Before: &snowflake.StreamOnExternalTableBeforeArgs{
		Offset:    pulumi.String("string"),
		Statement: pulumi.String("string"),
		Stream:    pulumi.String("string"),
		Timestamp: pulumi.String("string"),
	},
	Comment:    pulumi.String("string"),
	CopyGrants: pulumi.Bool(false),
	InsertOnly: pulumi.String("string"),
	Name:       pulumi.String("string"),
})
Copy
var streamOnExternalTableResource = new StreamOnExternalTable("streamOnExternalTableResource", StreamOnExternalTableArgs.builder()
    .database("string")
    .externalTable("string")
    .schema("string")
    .at(StreamOnExternalTableAtArgs.builder()
        .offset("string")
        .statement("string")
        .stream("string")
        .timestamp("string")
        .build())
    .before(StreamOnExternalTableBeforeArgs.builder()
        .offset("string")
        .statement("string")
        .stream("string")
        .timestamp("string")
        .build())
    .comment("string")
    .copyGrants(false)
    .insertOnly("string")
    .name("string")
    .build());
Copy
stream_on_external_table_resource = snowflake.StreamOnExternalTable("streamOnExternalTableResource",
    database="string",
    external_table="string",
    schema="string",
    at={
        "offset": "string",
        "statement": "string",
        "stream": "string",
        "timestamp": "string",
    },
    before={
        "offset": "string",
        "statement": "string",
        "stream": "string",
        "timestamp": "string",
    },
    comment="string",
    copy_grants=False,
    insert_only="string",
    name="string")
Copy
const streamOnExternalTableResource = new snowflake.StreamOnExternalTable("streamOnExternalTableResource", {
    database: "string",
    externalTable: "string",
    schema: "string",
    at: {
        offset: "string",
        statement: "string",
        stream: "string",
        timestamp: "string",
    },
    before: {
        offset: "string",
        statement: "string",
        stream: "string",
        timestamp: "string",
    },
    comment: "string",
    copyGrants: false,
    insertOnly: "string",
    name: "string",
});
Copy
type: snowflake:StreamOnExternalTable
properties:
    at:
        offset: string
        statement: string
        stream: string
        timestamp: string
    before:
        offset: string
        statement: string
        stream: string
        timestamp: string
    comment: string
    copyGrants: false
    database: string
    externalTable: string
    insertOnly: string
    name: string
    schema: string
Copy

StreamOnExternalTable 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 StreamOnExternalTable 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: |, ., ".
ExternalTable This property is required. string
Specifies an identifier for the external table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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: |, ., ".
At StreamOnExternalTableAt
Before StreamOnExternalTableBefore
Comment string
Specifies a comment for the stream.
CopyGrants bool
InsertOnly string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this is an insert-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.
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: |, ., ".
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: |, ., ".
ExternalTable This property is required. string
Specifies an identifier for the external table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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: |, ., ".
At StreamOnExternalTableAtArgs
Before StreamOnExternalTableBeforeArgs
Comment string
Specifies a comment for the stream.
CopyGrants bool
InsertOnly string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this is an insert-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.
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: |, ., ".
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: |, ., ".
externalTable This property is required. String
Specifies an identifier for the external table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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: |, ., ".
at StreamOnExternalTableAt
before StreamOnExternalTableBefore
comment String
Specifies a comment for the stream.
copyGrants Boolean
insertOnly String
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this is an insert-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.
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: |, ., ".
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: |, ., ".
externalTable This property is required. string
Specifies an identifier for the external table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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: |, ., ".
at StreamOnExternalTableAt
before StreamOnExternalTableBefore
comment string
Specifies a comment for the stream.
copyGrants boolean
insertOnly string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this is an insert-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.
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: |, ., ".
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: |, ., ".
external_table This property is required. str
Specifies an identifier for the external table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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: |, ., ".
at StreamOnExternalTableAtArgs
before StreamOnExternalTableBeforeArgs
comment str
Specifies a comment for the stream.
copy_grants bool
insert_only str
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this is an insert-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.
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: |, ., ".
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: |, ., ".
externalTable This property is required. String
Specifies an identifier for the external table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
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: |, ., ".
at Property Map
before Property Map
comment String
Specifies a comment for the stream.
copyGrants Boolean
insertOnly String
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this is an insert-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.
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: |, ., ".

Outputs

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

DescribeOutputs List<StreamOnExternalTableDescribeOutput>
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<StreamOnExternalTableShowOutput>
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 []StreamOnExternalTableDescribeOutput
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 []StreamOnExternalTableShowOutput
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<StreamOnExternalTableDescribeOutput>
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<StreamOnExternalTableShowOutput>
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 StreamOnExternalTableDescribeOutput[]
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 StreamOnExternalTableShowOutput[]
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[StreamOnExternalTableDescribeOutput]
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[StreamOnExternalTableShowOutput]
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 StreamOnExternalTable Resource

Get an existing StreamOnExternalTable 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?: StreamOnExternalTableState, opts?: CustomResourceOptions): StreamOnExternalTable
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        at: Optional[StreamOnExternalTableAtArgs] = None,
        before: Optional[StreamOnExternalTableBeforeArgs] = None,
        comment: Optional[str] = None,
        copy_grants: Optional[bool] = None,
        database: Optional[str] = None,
        describe_outputs: Optional[Sequence[StreamOnExternalTableDescribeOutputArgs]] = None,
        external_table: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        insert_only: Optional[str] = None,
        name: Optional[str] = None,
        schema: Optional[str] = None,
        show_outputs: Optional[Sequence[StreamOnExternalTableShowOutputArgs]] = None,
        stale: Optional[bool] = None,
        stream_type: Optional[str] = None) -> StreamOnExternalTable
func GetStreamOnExternalTable(ctx *Context, name string, id IDInput, state *StreamOnExternalTableState, opts ...ResourceOption) (*StreamOnExternalTable, error)
public static StreamOnExternalTable Get(string name, Input<string> id, StreamOnExternalTableState? state, CustomResourceOptions? opts = null)
public static StreamOnExternalTable get(String name, Output<String> id, StreamOnExternalTableState state, CustomResourceOptions options)
resources:  _:    type: snowflake:StreamOnExternalTable    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:
At StreamOnExternalTableAt
Before StreamOnExternalTableBefore
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<StreamOnExternalTableDescribeOutput>
Outputs the result of DESCRIBE STREAM for the given stream.
ExternalTable string
Specifies an identifier for the external table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
InsertOnly string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this is an insert-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.
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: |, ., ".
ShowOutputs List<StreamOnExternalTableShowOutput>
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.
At StreamOnExternalTableAtArgs
Before StreamOnExternalTableBeforeArgs
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 []StreamOnExternalTableDescribeOutputArgs
Outputs the result of DESCRIBE STREAM for the given stream.
ExternalTable string
Specifies an identifier for the external table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
InsertOnly string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this is an insert-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.
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: |, ., ".
ShowOutputs []StreamOnExternalTableShowOutputArgs
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.
at StreamOnExternalTableAt
before StreamOnExternalTableBefore
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<StreamOnExternalTableDescribeOutput>
Outputs the result of DESCRIBE STREAM for the given stream.
externalTable String
Specifies an identifier for the external table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
insertOnly String
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this is an insert-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.
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: |, ., ".
showOutputs List<StreamOnExternalTableShowOutput>
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.
at StreamOnExternalTableAt
before StreamOnExternalTableBefore
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 StreamOnExternalTableDescribeOutput[]
Outputs the result of DESCRIBE STREAM for the given stream.
externalTable string
Specifies an identifier for the external table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
fullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
insertOnly string
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this is an insert-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.
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: |, ., ".
showOutputs StreamOnExternalTableShowOutput[]
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.
at StreamOnExternalTableAtArgs
before StreamOnExternalTableBeforeArgs
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[StreamOnExternalTableDescribeOutputArgs]
Outputs the result of DESCRIBE STREAM for the given stream.
external_table str
Specifies an identifier for the external table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
fully_qualified_name str
Fully qualified name of the resource. For more information, see object name resolution.
insert_only str
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this is an insert-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.
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_outputs Sequence[StreamOnExternalTableShowOutputArgs]
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.
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.
externalTable String
Specifies an identifier for the external table the stream will monitor. Due to technical limitations (read more here), avoid using the following characters: |, ., ". For more information about this resource, see docs.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
insertOnly String
(Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether this is an insert-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.
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: |, ., ".
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.

Supporting Types

StreamOnExternalTableAt
, StreamOnExternalTableAtArgs

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.

StreamOnExternalTableBefore
, StreamOnExternalTableBeforeArgs

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.

StreamOnExternalTableDescribeOutput
, StreamOnExternalTableDescribeOutputArgs

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

StreamOnExternalTableShowOutput
, StreamOnExternalTableShowOutputArgs

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-snowflake