1. Packages
  2. Snowflake Provider
  3. API Docs
  4. StreamOnTable
Viewing docs for Snowflake v2.13.0
published on Thursday, Feb 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-snowflake

snowflake.StreamOnTable

snowflake logo
Viewing docs for Snowflake v2.13.0
published on Thursday, Feb 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-snowflake

    Note about copy_grants Fields like table, append_only, at, before, show_initial_rows and stale can not be ALTERed on Snowflake side (check docs), and a change on these fields means recreation of the resource. ForceNew can not be used because it does not preserve grants from copy_grants. Beware that even though a change is marked as update, the resource is recreated.

    Resource used to manage streams on tables. For more information, check stream documentation.

    Create StreamOnTable Resource

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

    Constructor syntax

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

@overload
def StreamOnTable(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  database: Optional[str] = None,
                  schema: Optional[str] = None,
                  table: Optional[str] = None,
                  append_only: Optional[str] = None,
                  at: Optional[StreamOnTableAtArgs] = None,
                  before: Optional[StreamOnTableBeforeArgs] = None,
                  comment: Optional[str] = None,
                  copy_grants: Optional[bool] = None,
                  name: Optional[str] = None,
                  show_initial_rows: Optional[str] = None)
    func NewStreamOnTable(ctx *Context, name string, args StreamOnTableArgs, opts ...ResourceOption) (*StreamOnTable, error)
    public StreamOnTable(string name, StreamOnTableArgs args, CustomResourceOptions? opts = null)
    public StreamOnTable(String name, StreamOnTableArgs args)
public StreamOnTable(String name, StreamOnTableArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args StreamOnTableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StreamOnTableArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StreamOnTableArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StreamOnTableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StreamOnTableArgs
    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 streamOnTableResource = new Snowflake.StreamOnTable("streamOnTableResource", new()
{
    Database = "string",
    Schema = "string",
    Table = "string",
    AppendOnly = "string",
    At = new Snowflake.Inputs.StreamOnTableAtArgs
    {
        Offset = "string",
        Statement = "string",
        Stream = "string",
        Timestamp = "string",
    },
    Before = new Snowflake.Inputs.StreamOnTableBeforeArgs
    {
        Offset = "string",
        Statement = "string",
        Stream = "string",
        Timestamp = "string",
    },
    Comment = "string",
    CopyGrants = false,
    Name = "string",
    ShowInitialRows = "string",
});

    example, err := snowflake.NewStreamOnTable(ctx, "streamOnTableResource", &snowflake.StreamOnTableArgs{
	Database:   pulumi.String("string"),
	Schema:     pulumi.String("string"),
	Table:      pulumi.String("string"),
	AppendOnly: pulumi.String("string"),
	At: &snowflake.StreamOnTableAtArgs{
		Offset:    pulumi.String("string"),
		Statement: pulumi.String("string"),
		Stream:    pulumi.String("string"),
		Timestamp: pulumi.String("string"),
	},
	Before: &snowflake.StreamOnTableBeforeArgs{
		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"),
})

    var streamOnTableResource = new StreamOnTable("streamOnTableResource", StreamOnTableArgs.builder()
    .database("string")
    .schema("string")
    .table("string")
    .appendOnly("string")
    .at(StreamOnTableAtArgs.builder()
        .offset("string")
        .statement("string")
        .stream("string")
        .timestamp("string")
        .build())
    .before(StreamOnTableBeforeArgs.builder()
        .offset("string")
        .statement("string")
        .stream("string")
        .timestamp("string")
        .build())
    .comment("string")
    .copyGrants(false)
    .name("string")
    .showInitialRows("string")
    .build());

    stream_on_table_resource = snowflake.StreamOnTable("streamOnTableResource",
    database="string",
    schema="string",
    table="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")

    const streamOnTableResource = new snowflake.StreamOnTable("streamOnTableResource", {
    database: "string",
    schema: "string",
    table: "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",
});

    type: snowflake:StreamOnTable
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
    table: string

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

    Database string
    The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Schema string
    The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Table string
    Specifies an identifier for the 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.
    AppendOnly string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) 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 StreamOnTableAt
    This field specifies that the request is inclusive of any changes made by a statement or transaction with a timestamp equal to the specified parameter. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    Before StreamOnTableBefore
    This field specifies that the request refers to a point immediately preceding the specified parameter. This point in time is just before the statement, identified by its query ID, is completed. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    Comment string
    Specifies a comment for the stream.
    CopyGrants bool
    (Default: false) Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. This is used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect during creating a new object with Terraform.
    Name 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
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed. 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. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    Database string
    The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Schema string
    The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Table string
    Specifies an identifier for the 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.
    AppendOnly string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) 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 StreamOnTableAtArgs
    This field specifies that the request is inclusive of any changes made by a statement or transaction with a timestamp equal to the specified parameter. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    Before StreamOnTableBeforeArgs
    This field specifies that the request refers to a point immediately preceding the specified parameter. This point in time is just before the statement, identified by its query ID, is completed. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    Comment string
    Specifies a comment for the stream.
    CopyGrants bool
    (Default: false) Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. This is used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect during creating a new object with Terraform.
    Name 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
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed. 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. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    database String
    The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema String
    The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    table String
    Specifies an identifier for the 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.
    appendOnly String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) 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 StreamOnTableAt
    This field specifies that the request is inclusive of any changes made by a statement or transaction with a timestamp equal to the specified parameter. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    before StreamOnTableBefore
    This field specifies that the request refers to a point immediately preceding the specified parameter. This point in time is just before the statement, identified by its query ID, is completed. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    comment String
    Specifies a comment for the stream.
    copyGrants Boolean
    (Default: false) Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. This is used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect during creating a new object with Terraform.
    name 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
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed. 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. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    database string
    The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema string
    The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    table string
    Specifies an identifier for the 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.
    appendOnly string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) 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 StreamOnTableAt
    This field specifies that the request is inclusive of any changes made by a statement or transaction with a timestamp equal to the specified parameter. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    before StreamOnTableBefore
    This field specifies that the request refers to a point immediately preceding the specified parameter. This point in time is just before the statement, identified by its query ID, is completed. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    comment string
    Specifies a comment for the stream.
    copyGrants boolean
    (Default: false) Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. This is used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect during creating a new object with Terraform.
    name 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
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed. 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. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    database str
    The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema str
    The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    table str
    Specifies an identifier for the 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.
    append_only str
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) 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 StreamOnTableAtArgs
    This field specifies that the request is inclusive of any changes made by a statement or transaction with a timestamp equal to the specified parameter. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    before StreamOnTableBeforeArgs
    This field specifies that the request refers to a point immediately preceding the specified parameter. This point in time is just before the statement, identified by its query ID, is completed. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    comment str
    Specifies a comment for the stream.
    copy_grants bool
    (Default: false) Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. This is used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect during creating a new object with Terraform.
    name 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
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed. 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. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    database String
    The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema String
    The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    table String
    Specifies an identifier for the 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.
    appendOnly String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) 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
    This field specifies that the request is inclusive of any changes made by a statement or transaction with a timestamp equal to the specified parameter. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    before Property Map
    This field specifies that the request refers to a point immediately preceding the specified parameter. This point in time is just before the statement, identified by its query ID, is completed. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    comment String
    Specifies a comment for the stream.
    copyGrants Boolean
    (Default: false) Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. This is used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect during creating a new object with Terraform.
    name 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
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed. 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. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".

    Outputs

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

    DescribeOutputs List<StreamOnTableDescribeOutput>
    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<StreamOnTableShowOutput>
    Outputs the result of SHOW STREAMS for the given stream.
    Stale bool
    Indicated if the stream is stale. When Terraform detects that the stream is stale, the stream is recreated with CREATE OR REPLACE. Read more on stream staleness in Snowflake docs.
    StreamType string
    Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
    DescribeOutputs []StreamOnTableDescribeOutput
    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 []StreamOnTableShowOutput
    Outputs the result of SHOW STREAMS for the given stream.
    Stale bool
    Indicated if the stream is stale. When Terraform detects that the stream is stale, the stream is recreated with CREATE OR REPLACE. Read more on stream staleness in Snowflake docs.
    StreamType string
    Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
    describeOutputs List<StreamOnTableDescribeOutput>
    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<StreamOnTableShowOutput>
    Outputs the result of SHOW STREAMS for the given stream.
    stale Boolean
    Indicated if the stream is stale. When Terraform detects that the stream is stale, the stream is recreated with CREATE OR REPLACE. Read more on stream staleness in Snowflake docs.
    streamType String
    Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
    describeOutputs StreamOnTableDescribeOutput[]
    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 StreamOnTableShowOutput[]
    Outputs the result of SHOW STREAMS for the given stream.
    stale boolean
    Indicated if the stream is stale. When Terraform detects that the stream is stale, the stream is recreated with CREATE OR REPLACE. Read more on stream staleness in Snowflake docs.
    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[StreamOnTableDescribeOutput]
    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[StreamOnTableShowOutput]
    Outputs the result of SHOW STREAMS for the given stream.
    stale bool
    Indicated if the stream is stale. When Terraform detects that the stream is stale, the stream is recreated with CREATE OR REPLACE. Read more on stream staleness in Snowflake docs.
    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
    Indicated if the stream is stale. When Terraform detects that the stream is stale, the stream is recreated with CREATE OR REPLACE. Read more on stream staleness in Snowflake docs.
    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 StreamOnTable Resource

    Get an existing StreamOnTable 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?: StreamOnTableState, opts?: CustomResourceOptions): StreamOnTable
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        append_only: Optional[str] = None,
        at: Optional[StreamOnTableAtArgs] = None,
        before: Optional[StreamOnTableBeforeArgs] = None,
        comment: Optional[str] = None,
        copy_grants: Optional[bool] = None,
        database: Optional[str] = None,
        describe_outputs: Optional[Sequence[StreamOnTableDescribeOutputArgs]] = 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[StreamOnTableShowOutputArgs]] = None,
        stale: Optional[bool] = None,
        stream_type: Optional[str] = None,
        table: Optional[str] = None) -> StreamOnTable
    func GetStreamOnTable(ctx *Context, name string, id IDInput, state *StreamOnTableState, opts ...ResourceOption) (*StreamOnTable, error)
    public static StreamOnTable Get(string name, Input<string> id, StreamOnTableState? state, CustomResourceOptions? opts = null)
    public static StreamOnTable get(String name, Output<String> id, StreamOnTableState state, CustomResourceOptions options)
    resources:  _:    type: snowflake:StreamOnTable    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AppendOnly string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) 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 StreamOnTableAt
    This field specifies that the request is inclusive of any changes made by a statement or transaction with a timestamp equal to the specified parameter. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    Before StreamOnTableBefore
    This field specifies that the request refers to a point immediately preceding the specified parameter. This point in time is just before the statement, identified by its query ID, is completed. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    Comment string
    Specifies a comment for the stream.
    CopyGrants bool
    (Default: false) Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. This is used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect during creating a new object with Terraform.
    Database string
    The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    DescribeOutputs List<StreamOnTableDescribeOutput>
    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 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 string
    The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    ShowInitialRows string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed. 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. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    ShowOutputs List<StreamOnTableShowOutput>
    Outputs the result of SHOW STREAMS for the given stream.
    Stale bool
    Indicated if the stream is stale. When Terraform detects that the stream is stale, the stream is recreated with CREATE OR REPLACE. Read more on stream staleness in Snowflake docs.
    StreamType string
    Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
    Table string
    Specifies an identifier for the 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.
    AppendOnly string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) 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 StreamOnTableAtArgs
    This field specifies that the request is inclusive of any changes made by a statement or transaction with a timestamp equal to the specified parameter. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    Before StreamOnTableBeforeArgs
    This field specifies that the request refers to a point immediately preceding the specified parameter. This point in time is just before the statement, identified by its query ID, is completed. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    Comment string
    Specifies a comment for the stream.
    CopyGrants bool
    (Default: false) Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. This is used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect during creating a new object with Terraform.
    Database string
    The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    DescribeOutputs []StreamOnTableDescribeOutputArgs
    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 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 string
    The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    ShowInitialRows string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed. 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. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    ShowOutputs []StreamOnTableShowOutputArgs
    Outputs the result of SHOW STREAMS for the given stream.
    Stale bool
    Indicated if the stream is stale. When Terraform detects that the stream is stale, the stream is recreated with CREATE OR REPLACE. Read more on stream staleness in Snowflake docs.
    StreamType string
    Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
    Table string
    Specifies an identifier for the 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.
    appendOnly String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) 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 StreamOnTableAt
    This field specifies that the request is inclusive of any changes made by a statement or transaction with a timestamp equal to the specified parameter. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    before StreamOnTableBefore
    This field specifies that the request refers to a point immediately preceding the specified parameter. This point in time is just before the statement, identified by its query ID, is completed. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    comment String
    Specifies a comment for the stream.
    copyGrants Boolean
    (Default: false) Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. This is used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect during creating a new object with Terraform.
    database String
    The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describeOutputs List<StreamOnTableDescribeOutput>
    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 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 String
    The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showInitialRows String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed. 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. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    showOutputs List<StreamOnTableShowOutput>
    Outputs the result of SHOW STREAMS for the given stream.
    stale Boolean
    Indicated if the stream is stale. When Terraform detects that the stream is stale, the stream is recreated with CREATE OR REPLACE. Read more on stream staleness in Snowflake docs.
    streamType String
    Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
    table String
    Specifies an identifier for the 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.
    appendOnly string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) 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 StreamOnTableAt
    This field specifies that the request is inclusive of any changes made by a statement or transaction with a timestamp equal to the specified parameter. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    before StreamOnTableBefore
    This field specifies that the request refers to a point immediately preceding the specified parameter. This point in time is just before the statement, identified by its query ID, is completed. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    comment string
    Specifies a comment for the stream.
    copyGrants boolean
    (Default: false) Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. This is used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect during creating a new object with Terraform.
    database string
    The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describeOutputs StreamOnTableDescribeOutput[]
    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 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 string
    The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showInitialRows string
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed. 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. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    showOutputs StreamOnTableShowOutput[]
    Outputs the result of SHOW STREAMS for the given stream.
    stale boolean
    Indicated if the stream is stale. When Terraform detects that the stream is stale, the stream is recreated with CREATE OR REPLACE. Read more on stream staleness in Snowflake docs.
    streamType string
    Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
    table string
    Specifies an identifier for the 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.
    append_only str
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) 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 StreamOnTableAtArgs
    This field specifies that the request is inclusive of any changes made by a statement or transaction with a timestamp equal to the specified parameter. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    before StreamOnTableBeforeArgs
    This field specifies that the request refers to a point immediately preceding the specified parameter. This point in time is just before the statement, identified by its query ID, is completed. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    comment str
    Specifies a comment for the stream.
    copy_grants bool
    (Default: false) Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. This is used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect during creating a new object with Terraform.
    database str
    The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describe_outputs Sequence[StreamOnTableDescribeOutputArgs]
    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 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 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
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed. 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. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    show_outputs Sequence[StreamOnTableShowOutputArgs]
    Outputs the result of SHOW STREAMS for the given stream.
    stale bool
    Indicated if the stream is stale. When Terraform detects that the stream is stale, the stream is recreated with CREATE OR REPLACE. Read more on stream staleness in Snowflake docs.
    stream_type str
    Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
    table str
    Specifies an identifier for the 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.
    appendOnly String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) 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
    This field specifies that the request is inclusive of any changes made by a statement or transaction with a timestamp equal to the specified parameter. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    before Property Map
    This field specifies that the request refers to a point immediately preceding the specified parameter. This point in time is just before the statement, identified by its query ID, is completed. Due to Snowflake limitations, the provider does not detect external changes on this field. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    comment String
    Specifies a comment for the stream.
    copyGrants Boolean
    (Default: false) Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. This is used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect during creating a new object with Terraform.
    database 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 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 String
    The schema in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showInitialRows String
    (Default: fallback to Snowflake default - uses special value that cannot be set in the configuration manually (default)) Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed. 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. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    showOutputs List<Property Map>
    Outputs the result of SHOW STREAMS for the given stream.
    stale Boolean
    Indicated if the stream is stale. When Terraform detects that the stream is stale, the stream is recreated with CREATE OR REPLACE. Read more on stream staleness in Snowflake docs.
    streamType String
    Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.
    table String
    Specifies an identifier for the 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.

    Supporting Types

    StreamOnTableAt, StreamOnTableAtArgs

    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.

    StreamOnTableBefore, StreamOnTableBeforeArgs

    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.

    StreamOnTableDescribeOutput, StreamOnTableDescribeOutputArgs

    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

    StreamOnTableShowOutput, StreamOnTableShowOutputArgs

    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

    Import

    $ pulumi import snowflake:index/streamOnTable:StreamOnTable example '"<database_name>"."<schema_name>"."<stream_name>"'

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

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Viewing docs for Snowflake v2.13.0
    published on Thursday, Feb 26, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-snowflake
      Try Pulumi Cloud free. Your team will thank you.