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

Snowflake

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

StreamGrant

Import

format is database name | schema name | stream name | privilege | true/false for with_grant_option

 $ pulumi import snowflake:index/streamGrant:StreamGrant example 'dbName|schemaName|streamName|SELECT|false'

Example Usage

using Pulumi;
using Snowflake = Pulumi.Snowflake;

class MyStack : Stack
{
    public MyStack()
    {
        var grant = new Snowflake.StreamGrant("grant", new Snowflake.StreamGrantArgs
        {
            DatabaseName = "db",
            OnFuture = false,
            Privilege = "select",
            Roles = 
            {
                "role1",
                "role2",
            },
            SchemaName = "schema",
            StreamName = "view",
            WithGrantOption = false,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-snowflake/sdk/go/snowflake"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := snowflake.NewStreamGrant(ctx, "grant", &snowflake.StreamGrantArgs{
			DatabaseName: pulumi.String("db"),
			OnFuture:     pulumi.Bool(false),
			Privilege:    pulumi.String("select"),
			Roles: pulumi.StringArray{
				pulumi.String("role1"),
				pulumi.String("role2"),
			},
			SchemaName:      pulumi.String("schema"),
			StreamName:      pulumi.String("view"),
			WithGrantOption: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_snowflake as snowflake

grant = snowflake.StreamGrant("grant",
    database_name="db",
    on_future=False,
    privilege="select",
    roles=[
        "role1",
        "role2",
    ],
    schema_name="schema",
    stream_name="view",
    with_grant_option=False)
import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";

const grant = new snowflake.StreamGrant("grant", {
    databaseName: "db",
    onFuture: false,
    privilege: "select",
    roles: [
        "role1",
        "role2",
    ],
    schemaName: "schema",
    streamName: "view",
    withGrantOption: false,
});

Create a StreamGrant Resource

new StreamGrant(name: string, args: StreamGrantArgs, opts?: CustomResourceOptions);
@overload
def StreamGrant(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                database_name: Optional[str] = None,
                on_future: Optional[bool] = None,
                privilege: Optional[str] = None,
                roles: Optional[Sequence[str]] = None,
                schema_name: Optional[str] = None,
                stream_name: Optional[str] = None,
                with_grant_option: Optional[bool] = None)
@overload
def StreamGrant(resource_name: str,
                args: StreamGrantArgs,
                opts: Optional[ResourceOptions] = None)
func NewStreamGrant(ctx *Context, name string, args StreamGrantArgs, opts ...ResourceOption) (*StreamGrant, error)
public StreamGrant(string name, StreamGrantArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args StreamGrantArgs
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 StreamGrantArgs
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 StreamGrantArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args StreamGrantArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

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

DatabaseName string
The name of the database containing the current or future streams on which to grant privileges.
SchemaName string
The name of the schema containing the current or future streams on which to grant privileges.
OnFuture bool
When this is set to true and a schemaname is provided, apply this grant on all future streams in the given schema. When this is true and no schemaname is provided apply this grant on all future streams in the given database. The streamname field must be unset in order to use onfuture.
Privilege string
The privilege to grant on the current or future stream.
Roles List<string>
Grants privilege to these roles.
StreamName string
The name of the stream on which to grant privileges immediately (only valid if on_future is false).
WithGrantOption bool
When this is set to true, allows the recipient role to grant the privileges to other roles.
DatabaseName string
The name of the database containing the current or future streams on which to grant privileges.
SchemaName string
The name of the schema containing the current or future streams on which to grant privileges.
OnFuture bool
When this is set to true and a schemaname is provided, apply this grant on all future streams in the given schema. When this is true and no schemaname is provided apply this grant on all future streams in the given database. The streamname field must be unset in order to use onfuture.
Privilege string
The privilege to grant on the current or future stream.
Roles []string
Grants privilege to these roles.
StreamName string
The name of the stream on which to grant privileges immediately (only valid if on_future is false).
WithGrantOption bool
When this is set to true, allows the recipient role to grant the privileges to other roles.
databaseName string
The name of the database containing the current or future streams on which to grant privileges.
schemaName string
The name of the schema containing the current or future streams on which to grant privileges.
onFuture boolean
When this is set to true and a schemaname is provided, apply this grant on all future streams in the given schema. When this is true and no schemaname is provided apply this grant on all future streams in the given database. The streamname field must be unset in order to use onfuture.
privilege string
The privilege to grant on the current or future stream.
roles string[]
Grants privilege to these roles.
streamName string
The name of the stream on which to grant privileges immediately (only valid if on_future is false).
withGrantOption boolean
When this is set to true, allows the recipient role to grant the privileges to other roles.
database_name str
The name of the database containing the current or future streams on which to grant privileges.
schema_name str
The name of the schema containing the current or future streams on which to grant privileges.
on_future bool
When this is set to true and a schemaname is provided, apply this grant on all future streams in the given schema. When this is true and no schemaname is provided apply this grant on all future streams in the given database. The streamname field must be unset in order to use onfuture.
privilege str
The privilege to grant on the current or future stream.
roles Sequence[str]
Grants privilege to these roles.
stream_name str
The name of the stream on which to grant privileges immediately (only valid if on_future is false).
with_grant_option bool
When this is set to true, allows the recipient role to grant the privileges to other roles.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing StreamGrant Resource

Get an existing StreamGrant 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?: StreamGrantState, opts?: CustomResourceOptions): StreamGrant
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        database_name: Optional[str] = None,
        on_future: Optional[bool] = None,
        privilege: Optional[str] = None,
        roles: Optional[Sequence[str]] = None,
        schema_name: Optional[str] = None,
        stream_name: Optional[str] = None,
        with_grant_option: Optional[bool] = None) -> StreamGrant
func GetStreamGrant(ctx *Context, name string, id IDInput, state *StreamGrantState, opts ...ResourceOption) (*StreamGrant, error)
public static StreamGrant Get(string name, Input<string> id, StreamGrantState? 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:

DatabaseName string
The name of the database containing the current or future streams on which to grant privileges.
OnFuture bool
When this is set to true and a schemaname is provided, apply this grant on all future streams in the given schema. When this is true and no schemaname is provided apply this grant on all future streams in the given database. The streamname field must be unset in order to use onfuture.
Privilege string
The privilege to grant on the current or future stream.
Roles List<string>
Grants privilege to these roles.
SchemaName string
The name of the schema containing the current or future streams on which to grant privileges.
StreamName string
The name of the stream on which to grant privileges immediately (only valid if on_future is false).
WithGrantOption bool
When this is set to true, allows the recipient role to grant the privileges to other roles.
DatabaseName string
The name of the database containing the current or future streams on which to grant privileges.
OnFuture bool
When this is set to true and a schemaname is provided, apply this grant on all future streams in the given schema. When this is true and no schemaname is provided apply this grant on all future streams in the given database. The streamname field must be unset in order to use onfuture.
Privilege string
The privilege to grant on the current or future stream.
Roles []string
Grants privilege to these roles.
SchemaName string
The name of the schema containing the current or future streams on which to grant privileges.
StreamName string
The name of the stream on which to grant privileges immediately (only valid if on_future is false).
WithGrantOption bool
When this is set to true, allows the recipient role to grant the privileges to other roles.
databaseName string
The name of the database containing the current or future streams on which to grant privileges.
onFuture boolean
When this is set to true and a schemaname is provided, apply this grant on all future streams in the given schema. When this is true and no schemaname is provided apply this grant on all future streams in the given database. The streamname field must be unset in order to use onfuture.
privilege string
The privilege to grant on the current or future stream.
roles string[]
Grants privilege to these roles.
schemaName string
The name of the schema containing the current or future streams on which to grant privileges.
streamName string
The name of the stream on which to grant privileges immediately (only valid if on_future is false).
withGrantOption boolean
When this is set to true, allows the recipient role to grant the privileges to other roles.
database_name str
The name of the database containing the current or future streams on which to grant privileges.
on_future bool
When this is set to true and a schemaname is provided, apply this grant on all future streams in the given schema. When this is true and no schemaname is provided apply this grant on all future streams in the given database. The streamname field must be unset in order to use onfuture.
privilege str
The privilege to grant on the current or future stream.
roles Sequence[str]
Grants privilege to these roles.
schema_name str
The name of the schema containing the current or future streams on which to grant privileges.
stream_name str
The name of the stream on which to grant privileges immediately (only valid if on_future is false).
with_grant_option bool
When this is set to true, allows the recipient role to grant the privileges to other roles.

Package Details

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