Docs Packages
  1. Packages
  2. Snowflake
  3. API Docs
  4. Stream
Snowflake v0.55.0 published on Friday, Jun 7, 2024 by Pulumi
pulumi/pulumi-snowflake

snowflake.Stream

Explore with Pulumi AI

snowflake logo
Snowflake v0.55.0 published on Friday, Jun 7, 2024 by Pulumi
pulumi/pulumi-snowflake

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  table:
    type: snowflake:Table
    properties:
      database: database
      schema: schema
      name: name
      columns:
        - type: NUMBER(38,0)
          name: id
  stream:
    type: snowflake:Stream
    properties:
      comment: A stream.
      database: database
      schema: schema
      name: stream
      onTable: ${table.qualifiedName}
      appendOnly: false
      insertOnly: false
      owner: role1

    Create Stream Resource

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

    Constructor syntax

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

@overload
def Stream(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           database: Optional[str] = None,
           schema: Optional[str] = None,
           append_only: Optional[bool] = None,
           comment: Optional[str] = None,
           insert_only: Optional[bool] = None,
           name: Optional[str] = None,
           on_stage: Optional[str] = None,
           on_table: Optional[str] = None,
           on_view: Optional[str] = None,
           show_initial_rows: Optional[bool] = None)
    func NewStream(ctx *Context, name string, args StreamArgs, opts ...ResourceOption) (*Stream, error)
    public Stream(string name, StreamArgs args, CustomResourceOptions? opts = null)
    public Stream(String name, StreamArgs args)
public Stream(String name, StreamArgs args, CustomResourceOptions options)

    type: snowflake:Stream
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 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.
    name String
    The unique name of the resource.
    args StreamArgs
    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 streamResource = new Snowflake.Stream("streamResource", new()
{
    Database = "string",
    Schema = "string",
    AppendOnly = false,
    Comment = "string",
    InsertOnly = false,
    Name = "string",
    OnStage = "string",
    OnTable = "string",
    OnView = "string",
    ShowInitialRows = false,
});

    example, err := snowflake.NewStream(ctx, "streamResource", &snowflake.StreamArgs{
	Database:        pulumi.String("string"),
	Schema:          pulumi.String("string"),
	AppendOnly:      pulumi.Bool(false),
	Comment:         pulumi.String("string"),
	InsertOnly:      pulumi.Bool(false),
	Name:            pulumi.String("string"),
	OnStage:         pulumi.String("string"),
	OnTable:         pulumi.String("string"),
	OnView:          pulumi.String("string"),
	ShowInitialRows: pulumi.Bool(false),
})

    var streamResource = new Stream("streamResource", StreamArgs.builder()
    .database("string")
    .schema("string")
    .appendOnly(false)
    .comment("string")
    .insertOnly(false)
    .name("string")
    .onStage("string")
    .onTable("string")
    .onView("string")
    .showInitialRows(false)
    .build());

    stream_resource = snowflake.Stream("streamResource",
    database="string",
    schema="string",
    append_only=False,
    comment="string",
    insert_only=False,
    name="string",
    on_stage="string",
    on_table="string",
    on_view="string",
    show_initial_rows=False)

    const streamResource = new snowflake.Stream("streamResource", {
    database: "string",
    schema: "string",
    appendOnly: false,
    comment: "string",
    insertOnly: false,
    name: "string",
    onStage: "string",
    onTable: "string",
    onView: "string",
    showInitialRows: false,
});

    type: snowflake:Stream
properties:
    appendOnly: false
    comment: string
    database: string
    insertOnly: false
    name: string
    onStage: string
    onTable: string
    onView: string
    schema: string
    showInitialRows: false

    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.
    OnStage string
    Specifies an identifier for the stage the stream will monitor.
    OnTable string
    Specifies an identifier for the table the stream will monitor.
    OnView string
    Specifies an identifier for the view 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.
    OnStage string
    Specifies an identifier for the stage the stream will monitor.
    OnTable string
    Specifies an identifier for the table the stream will monitor.
    OnView string
    Specifies an identifier for the view 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.
    onStage String
    Specifies an identifier for the stage the stream will monitor.
    onTable String
    Specifies an identifier for the table the stream will monitor.
    onView String
    Specifies an identifier for the view 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 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.
    onStage string
    Specifies an identifier for the stage the stream will monitor.
    onTable string
    Specifies an identifier for the table the stream will monitor.
    onView string
    Specifies an identifier for the view 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_stage str
    Specifies an identifier for the stage the stream will monitor.
    on_table str
    Specifies an identifier for the table the stream will monitor.
    on_view str
    Specifies an identifier for the view 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.
    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.
    onStage String
    Specifies an identifier for the stage the stream will monitor.
    onTable String
    Specifies an identifier for the table the stream will monitor.
    onView String
    Specifies an identifier for the view 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.

    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 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.
    id String
    The provider-assigned unique ID for this managed resource.
    owner String
    Name of the role that owns the stream.

    Look up 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_stage: Optional[str] = None,
        on_table: Optional[str] = None,
        on_view: 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)
    public static Stream get(String name, Output<String> id, StreamState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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 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.
    OnStage string
    Specifies an identifier for the stage the stream will monitor.
    OnTable string
    Specifies an identifier for the table the stream will monitor.
    OnView string
    Specifies an identifier for the view 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.
    OnStage string
    Specifies an identifier for the stage the stream will monitor.
    OnTable string
    Specifies an identifier for the table the stream will monitor.
    OnView string
    Specifies an identifier for the view 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.
    onStage String
    Specifies an identifier for the stage the stream will monitor.
    onTable String
    Specifies an identifier for the table the stream will monitor.
    onView String
    Specifies an identifier for the view 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.
    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.
    onStage string
    Specifies an identifier for the stage the stream will monitor.
    onTable string
    Specifies an identifier for the table the stream will monitor.
    onView string
    Specifies an identifier for the view 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_stage str
    Specifies an identifier for the stage the stream will monitor.
    on_table str
    Specifies an identifier for the table the stream will monitor.
    on_view str
    Specifies an identifier for the view 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.
    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.
    onStage String
    Specifies an identifier for the stage the stream will monitor.
    onTable String
    Specifies an identifier for the table the stream will monitor.
    onView String
    Specifies an identifier for the view 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.

    Import

    format is database name | schema name | stream name

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

    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
    Snowflake v0.55.0 published on Friday, Jun 7, 2024 by Pulumi
    pulumi/pulumi-snowflake