Snowflake v0.61.1, Nov 14 24

Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi

snowflake.StreamOnDirectoryTable

Explore with Pulumi AI

Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi

Import

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

Create StreamOnDirectoryTable Resource

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

Constructor syntax

new StreamOnDirectoryTable(name: string, args: StreamOnDirectoryTableArgs, opts?: CustomResourceOptions);

@overload
def StreamOnDirectoryTable(resource_name: str,
                           args: StreamOnDirectoryTableArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def StreamOnDirectoryTable(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           database: Optional[str] = None,
                           schema: Optional[str] = None,
                           stage: Optional[str] = None,
                           comment: Optional[str] = None,
                           copy_grants: Optional[bool] = None,
                           name: Optional[str] = None)

func NewStreamOnDirectoryTable(ctx *Context, name string, args StreamOnDirectoryTableArgs, opts ...ResourceOption) (*StreamOnDirectoryTable, error)

public StreamOnDirectoryTable(string name, StreamOnDirectoryTableArgs args, CustomResourceOptions? opts = null)

public StreamOnDirectoryTable(String name, StreamOnDirectoryTableArgs args)
public StreamOnDirectoryTable(String name, StreamOnDirectoryTableArgs args, CustomResourceOptions options)

type: snowflake:StreamOnDirectoryTable
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 StreamOnDirectoryTableArgs: 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 StreamOnDirectoryTableArgs: 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 StreamOnDirectoryTableArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args StreamOnDirectoryTableArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args StreamOnDirectoryTableArgs: 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 streamOnDirectoryTableResource = new Snowflake.StreamOnDirectoryTable("streamOnDirectoryTableResource", new()
{
    Database = "string",
    Schema = "string",
    Stage = "string",
    Comment = "string",
    CopyGrants = false,
    Name = "string",
});

example, err := snowflake.NewStreamOnDirectoryTable(ctx, "streamOnDirectoryTableResource", &snowflake.StreamOnDirectoryTableArgs{
	Database:   pulumi.String("string"),
	Schema:     pulumi.String("string"),
	Stage:      pulumi.String("string"),
	Comment:    pulumi.String("string"),
	CopyGrants: pulumi.Bool(false),
	Name:       pulumi.String("string"),
})

var streamOnDirectoryTableResource = new StreamOnDirectoryTable("streamOnDirectoryTableResource", StreamOnDirectoryTableArgs.builder()
    .database("string")
    .schema("string")
    .stage("string")
    .comment("string")
    .copyGrants(false)
    .name("string")
    .build());

stream_on_directory_table_resource = snowflake.StreamOnDirectoryTable("streamOnDirectoryTableResource",
    database="string",
    schema="string",
    stage="string",
    comment="string",
    copy_grants=False,
    name="string")

const streamOnDirectoryTableResource = new snowflake.StreamOnDirectoryTable("streamOnDirectoryTableResource", {
    database: "string",
    schema: "string",
    stage: "string",
    comment: "string",
    copyGrants: false,
    name: "string",
});

type: snowflake:StreamOnDirectoryTable
properties:
    comment: string
    copyGrants: false
    database: string
    name: string
    schema: string
    stage: string

StreamOnDirectoryTable 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 StreamOnDirectoryTable 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: |, ., (, ), "
Stage string: Specifies an identifier for the stage the stream will monitor. Due to Snowflake limitations, the provider can not read the stage's database and schema. For stages, Snowflake returns only partially qualified name instead of fully qualified name. Please use stages located in the same schema as the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
Comment string: Specifies a comment for the stream.
CopyGrants bool: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
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: |, ., (, ), "

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: |, ., (, ), "
Stage string: Specifies an identifier for the stage the stream will monitor. Due to Snowflake limitations, the provider can not read the stage's database and schema. For stages, Snowflake returns only partially qualified name instead of fully qualified name. Please use stages located in the same schema as the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
Comment string: Specifies a comment for the stream.
CopyGrants bool: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
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: |, ., (, ), "

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: |, ., (, ), "
stage String: Specifies an identifier for the stage the stream will monitor. Due to Snowflake limitations, the provider can not read the stage's database and schema. For stages, Snowflake returns only partially qualified name instead of fully qualified name. Please use stages located in the same schema as the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
comment String: Specifies a comment for the stream.
copyGrants Boolean: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
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: |, ., (, ), "

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: |, ., (, ), "
stage string: Specifies an identifier for the stage the stream will monitor. Due to Snowflake limitations, the provider can not read the stage's database and schema. For stages, Snowflake returns only partially qualified name instead of fully qualified name. Please use stages located in the same schema as the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
comment string: Specifies a comment for the stream.
copyGrants boolean: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
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: |, ., (, ), "

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: |, ., (, ), "
stage str: Specifies an identifier for the stage the stream will monitor. Due to Snowflake limitations, the provider can not read the stage's database and schema. For stages, Snowflake returns only partially qualified name instead of fully qualified name. Please use stages located in the same schema as the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
comment str: Specifies a comment for the stream.
copy_grants bool: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
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: |, ., (, ), "

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: |, ., (, ), "
stage String: Specifies an identifier for the stage the stream will monitor. Due to Snowflake limitations, the provider can not read the stage's database and schema. For stages, Snowflake returns only partially qualified name instead of fully qualified name. Please use stages located in the same schema as the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
comment String: Specifies a comment for the stream.
copyGrants Boolean: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
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: |, ., (, ), "

Outputs

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

DescribeOutputs List<StreamOnDirectoryTableDescribeOutput>: 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<StreamOnDirectoryTableShowOutput>: Outputs the result of SHOW STREAMS for the given stream.
Stale bool
StreamType string: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

DescribeOutputs []StreamOnDirectoryTableDescribeOutput: 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 []StreamOnDirectoryTableShowOutput: Outputs the result of SHOW STREAMS for the given stream.
Stale bool
StreamType string: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

describeOutputs List<StreamOnDirectoryTableDescribeOutput>: 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<StreamOnDirectoryTableShowOutput>: Outputs the result of SHOW STREAMS for the given stream.
stale Boolean
streamType String: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

describeOutputs StreamOnDirectoryTableDescribeOutput[]: 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 StreamOnDirectoryTableShowOutput[]: Outputs the result of SHOW STREAMS for the given stream.
stale boolean
streamType string: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

describe_outputs Sequence[StreamOnDirectoryTableDescribeOutput]: 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[StreamOnDirectoryTableShowOutput]: Outputs the result of SHOW STREAMS for the given stream.
stale bool
stream_type str: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

describeOutputs List<Property Map>: Outputs the result of DESCRIBE STREAM for the given stream.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
id String: The provider-assigned unique ID for this managed resource.
showOutputs List<Property Map>: Outputs the result of SHOW STREAMS for the given stream.
stale Boolean
streamType String: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

Look up Existing StreamOnDirectoryTable Resource

Get an existing StreamOnDirectoryTable 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?: StreamOnDirectoryTableState, opts?: CustomResourceOptions): StreamOnDirectoryTable

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        copy_grants: Optional[bool] = None,
        database: Optional[str] = None,
        describe_outputs: Optional[Sequence[StreamOnDirectoryTableDescribeOutputArgs]] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        schema: Optional[str] = None,
        show_outputs: Optional[Sequence[StreamOnDirectoryTableShowOutputArgs]] = None,
        stage: Optional[str] = None,
        stale: Optional[bool] = None,
        stream_type: Optional[str] = None) -> StreamOnDirectoryTable

func GetStreamOnDirectoryTable(ctx *Context, name string, id IDInput, state *StreamOnDirectoryTableState, opts ...ResourceOption) (*StreamOnDirectoryTable, error)

public static StreamOnDirectoryTable Get(string name, Input<string> id, StreamOnDirectoryTableState? state, CustomResourceOptions? opts = null)

public static StreamOnDirectoryTable get(String name, Output<String> id, StreamOnDirectoryTableState 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:

Comment string: Specifies a comment for the stream.
CopyGrants bool: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
Database string: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
DescribeOutputs List<StreamOnDirectoryTableDescribeOutput>: 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: |, ., (, ), "
ShowOutputs List<StreamOnDirectoryTableShowOutput>: Outputs the result of SHOW STREAMS for the given stream.
Stage string: Specifies an identifier for the stage the stream will monitor. Due to Snowflake limitations, the provider can not read the stage's database and schema. For stages, Snowflake returns only partially qualified name instead of fully qualified name. Please use stages located in the same schema as the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
Stale bool
StreamType string: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

Comment string: Specifies a comment for the stream.
CopyGrants bool: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
Database string: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
DescribeOutputs []StreamOnDirectoryTableDescribeOutputArgs: 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: |, ., (, ), "
ShowOutputs []StreamOnDirectoryTableShowOutputArgs: Outputs the result of SHOW STREAMS for the given stream.
Stage string: Specifies an identifier for the stage the stream will monitor. Due to Snowflake limitations, the provider can not read the stage's database and schema. For stages, Snowflake returns only partially qualified name instead of fully qualified name. Please use stages located in the same schema as the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
Stale bool
StreamType string: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

comment String: Specifies a comment for the stream.
copyGrants Boolean: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
database String: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
describeOutputs List<StreamOnDirectoryTableDescribeOutput>: 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: |, ., (, ), "
showOutputs List<StreamOnDirectoryTableShowOutput>: Outputs the result of SHOW STREAMS for the given stream.
stage String: Specifies an identifier for the stage the stream will monitor. Due to Snowflake limitations, the provider can not read the stage's database and schema. For stages, Snowflake returns only partially qualified name instead of fully qualified name. Please use stages located in the same schema as the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
stale Boolean
streamType String: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

comment string: Specifies a comment for the stream.
copyGrants boolean: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
database string: The database in which to create the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
describeOutputs StreamOnDirectoryTableDescribeOutput[]: 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: |, ., (, ), "
showOutputs StreamOnDirectoryTableShowOutput[]: Outputs the result of SHOW STREAMS for the given stream.
stage string: Specifies an identifier for the stage the stream will monitor. Due to Snowflake limitations, the provider can not read the stage's database and schema. For stages, Snowflake returns only partially qualified name instead of fully qualified name. Please use stages located in the same schema as the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
stale boolean
streamType string: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

comment str: Specifies a comment for the stream.
copy_grants bool: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
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[StreamOnDirectoryTableDescribeOutputArgs]: 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_outputs Sequence[StreamOnDirectoryTableShowOutputArgs]: Outputs the result of SHOW STREAMS for the given stream.
stage str: Specifies an identifier for the stage the stream will monitor. Due to Snowflake limitations, the provider can not read the stage's database and schema. For stages, Snowflake returns only partially qualified name instead of fully qualified name. Please use stages located in the same schema as the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
stale bool
stream_type str: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.

comment String: Specifies a comment for the stream.
copyGrants Boolean: Retains the access permissions from the original stream when a stream is recreated using the OR REPLACE clause. That is sometimes used when the provider detects changes for fields that can not be changed by ALTER. This value will not have any effect when creating a new stream.
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: |, ., (, ), "
showOutputs List<Property Map>: Outputs the result of SHOW STREAMS for the given stream.
stage String: Specifies an identifier for the stage the stream will monitor. Due to Snowflake limitations, the provider can not read the stage's database and schema. For stages, Snowflake returns only partially qualified name instead of fully qualified name. Please use stages located in the same schema as the stream. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
stale Boolean
streamType String: Specifies a type for the stream. This field is used for checking external changes and recreating the resources if needed.