Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Snowflake

v0.2.1 published on Monday, Sep 27, 2021 by Pulumi

Stream

Import

format is database name | schema name | on table name

 $ pulumi import snowflake:index/stream:Stream example 'dbName|schemaName|tableName'

Example Usage

Coming soon!

Coming soon!

Coming soon!

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

const stream = new snowflake.Stream("stream", {
    appendOnly: false,
    comment: "A stream.",
    database: "db",
    insertOnly: false,
    onTable: "table",
    owner: "role1",
    schema: "schema",
});

Create a Stream Resource

new Stream(name: string, args: StreamArgs, opts?: CustomResourceOptions);
@overload
def Stream(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           append_only: Optional[bool] = None,
           comment: Optional[str] = None,
           database: Optional[str] = None,
           insert_only: Optional[bool] = None,
           name: Optional[str] = None,
           on_table: Optional[str] = None,
           schema: Optional[str] = None,
           show_initial_rows: Optional[bool] = None)
@overload
def Stream(resource_name: str,
           args: StreamArgs,
           opts: Optional[ResourceOptions] = None)
func NewStream(ctx *Context, name string, args StreamArgs, opts ...ResourceOption) (*Stream, error)
public Stream(string name, StreamArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args StreamArgs
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 StreamArgs
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 StreamArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args StreamArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Stream Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Stream resource accepts the following input properties:

Database string
The database in which to create the stream.
Schema string
The schema in which to create the stream.
AppendOnly bool
Type of the stream that will be created.
Comment string
Specifies a comment for the stream.
InsertOnly bool
Create an insert only stream type.
Name string
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created.
OnTable string
Name of the table the stream will monitor.
ShowInitialRows bool
Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed.
Database string
The database in which to create the stream.
Schema string
The schema in which to create the stream.
AppendOnly bool
Type of the stream that will be created.
Comment string
Specifies a comment for the stream.
InsertOnly bool
Create an insert only stream type.
Name string
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created.
OnTable string
Name of the table the stream will monitor.
ShowInitialRows bool
Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed.
database string
The database in which to create the stream.
schema string
The schema in which to create the stream.
appendOnly boolean
Type of the stream that will be created.
comment string
Specifies a comment for the stream.
insertOnly boolean
Create an insert only stream type.
name string
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created.
onTable string
Name of the table the stream will monitor.
showInitialRows boolean
Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed.
database str
The database in which to create the stream.
schema str
The schema in which to create the stream.
append_only bool
Type of the stream that will be created.
comment str
Specifies a comment for the stream.
insert_only bool
Create an insert only stream type.
name str
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created.
on_table str
Name of the table the stream will monitor.
show_initial_rows bool
Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Owner string
Name of the role that owns the stream.
Id string
The provider-assigned unique ID for this managed resource.
Owner string
Name of the role that owns the stream.
id string
The provider-assigned unique ID for this managed resource.
owner string
Name of the role that owns the stream.
id str
The provider-assigned unique ID for this managed resource.
owner str
Name of the role that owns the stream.

Look up an Existing Stream Resource

Get an existing Stream 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?: StreamState, opts?: CustomResourceOptions): Stream
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        append_only: Optional[bool] = None,
        comment: Optional[str] = None,
        database: Optional[str] = None,
        insert_only: Optional[bool] = None,
        name: Optional[str] = None,
        on_table: Optional[str] = None,
        owner: Optional[str] = None,
        schema: Optional[str] = None,
        show_initial_rows: Optional[bool] = None) -> Stream
func GetStream(ctx *Context, name string, id IDInput, state *StreamState, opts ...ResourceOption) (*Stream, error)
public static Stream Get(string name, Input<string> id, StreamState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

AppendOnly bool
Type of the stream that will be created.
Comment string
Specifies a comment for the stream.
Database string
The database in which to create the stream.
InsertOnly bool
Create an insert only stream type.
Name string
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created.
OnTable string
Name of the table the stream will monitor.
Owner string
Name of the role that owns the stream.
Schema string
The schema in which to create the stream.
ShowInitialRows bool
Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed.
AppendOnly bool
Type of the stream that will be created.
Comment string
Specifies a comment for the stream.
Database string
The database in which to create the stream.
InsertOnly bool
Create an insert only stream type.
Name string
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created.
OnTable string
Name of the table the stream will monitor.
Owner string
Name of the role that owns the stream.
Schema string
The schema in which to create the stream.
ShowInitialRows bool
Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed.
appendOnly boolean
Type of the stream that will be created.
comment string
Specifies a comment for the stream.
database string
The database in which to create the stream.
insertOnly boolean
Create an insert only stream type.
name string
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created.
onTable string
Name of the table the stream will monitor.
owner string
Name of the role that owns the stream.
schema string
The schema in which to create the stream.
showInitialRows boolean
Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed.
append_only bool
Type of the stream that will be created.
comment str
Specifies a comment for the stream.
database str
The database in which to create the stream.
insert_only bool
Create an insert only stream type.
name str
Specifies the identifier for the stream; must be unique for the database and schema in which the stream is created.
on_table str
Name of the table the stream will monitor.
owner str
Name of the role that owns the stream.
schema str
The schema in which to create the stream.
show_initial_rows bool
Specifies whether to return all existing rows in the source table as row inserts the first time the stream is consumed.

Package Details

Repository
https://github.com/pulumi/pulumi-snowflake
License
Apache-2.0
Notes
This Pulumi package is based on the snowflake Terraform Provider.