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

Snowflake

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

PipeGrant

Import

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

 $ pulumi import snowflake:index/pipeGrant:PipeGrant example 'dbName|schemaName|pipeName|OPERATE|false'

Example Usage

Coming soon!

Coming soon!

Coming soon!

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

const grant = new snowflake.PipeGrant("grant", {
    databaseName: "db",
    onFuture: false,
    privilege: "operate",
    roles: [
        "role1",
        "role2",
    ],
    schemaName: "schema",
    sequenceName: "sequence",
    withGrantOption: false,
});

Create a PipeGrant Resource

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

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

DatabaseName string
The name of the database containing the current or future pipes on which to grant privileges.
SchemaName string
The name of the schema containing the current or future pipes on which to grant privileges.
OnFuture bool
When this is set to true and a schemaname is provided, apply this grant on all future pipes in the given schema. When this is true and no schemaname is provided apply this grant on all future pipes in the given database. The pipename field must be unset in order to use onfuture.
PipeName string
The name of the pipe on which to grant privileges immediately (only valid if on_future is false).
Privilege string
The privilege to grant on the current or future pipe.
Roles List<string>
Grants privilege to these roles.
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 pipes on which to grant privileges.
SchemaName string
The name of the schema containing the current or future pipes on which to grant privileges.
OnFuture bool
When this is set to true and a schemaname is provided, apply this grant on all future pipes in the given schema. When this is true and no schemaname is provided apply this grant on all future pipes in the given database. The pipename field must be unset in order to use onfuture.
PipeName string
The name of the pipe on which to grant privileges immediately (only valid if on_future is false).
Privilege string
The privilege to grant on the current or future pipe.
Roles []string
Grants privilege to these roles.
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 pipes on which to grant privileges.
schemaName string
The name of the schema containing the current or future pipes on which to grant privileges.
onFuture boolean
When this is set to true and a schemaname is provided, apply this grant on all future pipes in the given schema. When this is true and no schemaname is provided apply this grant on all future pipes in the given database. The pipename field must be unset in order to use onfuture.
pipeName string
The name of the pipe on which to grant privileges immediately (only valid if on_future is false).
privilege string
The privilege to grant on the current or future pipe.
roles string[]
Grants privilege to these roles.
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 pipes on which to grant privileges.
schema_name str
The name of the schema containing the current or future pipes 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 pipes in the given schema. When this is true and no schemaname is provided apply this grant on all future pipes in the given database. The pipename field must be unset in order to use onfuture.
pipe_name str
The name of the pipe on which to grant privileges immediately (only valid if on_future is false).
privilege str
The privilege to grant on the current or future pipe.
roles Sequence[str]
Grants privilege to these roles.
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 PipeGrant 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 PipeGrant Resource

Get an existing PipeGrant 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?: PipeGrantState, opts?: CustomResourceOptions): PipeGrant
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        database_name: Optional[str] = None,
        on_future: Optional[bool] = None,
        pipe_name: Optional[str] = None,
        privilege: Optional[str] = None,
        roles: Optional[Sequence[str]] = None,
        schema_name: Optional[str] = None,
        with_grant_option: Optional[bool] = None) -> PipeGrant
func GetPipeGrant(ctx *Context, name string, id IDInput, state *PipeGrantState, opts ...ResourceOption) (*PipeGrant, error)
public static PipeGrant Get(string name, Input<string> id, PipeGrantState? 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 pipes on which to grant privileges.
OnFuture bool
When this is set to true and a schemaname is provided, apply this grant on all future pipes in the given schema. When this is true and no schemaname is provided apply this grant on all future pipes in the given database. The pipename field must be unset in order to use onfuture.
PipeName string
The name of the pipe on which to grant privileges immediately (only valid if on_future is false).
Privilege string
The privilege to grant on the current or future pipe.
Roles List<string>
Grants privilege to these roles.
SchemaName string
The name of the schema containing the current or future pipes on which to grant privileges.
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 pipes on which to grant privileges.
OnFuture bool
When this is set to true and a schemaname is provided, apply this grant on all future pipes in the given schema. When this is true and no schemaname is provided apply this grant on all future pipes in the given database. The pipename field must be unset in order to use onfuture.
PipeName string
The name of the pipe on which to grant privileges immediately (only valid if on_future is false).
Privilege string
The privilege to grant on the current or future pipe.
Roles []string
Grants privilege to these roles.
SchemaName string
The name of the schema containing the current or future pipes on which to grant privileges.
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 pipes on which to grant privileges.
onFuture boolean
When this is set to true and a schemaname is provided, apply this grant on all future pipes in the given schema. When this is true and no schemaname is provided apply this grant on all future pipes in the given database. The pipename field must be unset in order to use onfuture.
pipeName string
The name of the pipe on which to grant privileges immediately (only valid if on_future is false).
privilege string
The privilege to grant on the current or future pipe.
roles string[]
Grants privilege to these roles.
schemaName string
The name of the schema containing the current or future pipes on which to grant privileges.
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 pipes 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 pipes in the given schema. When this is true and no schemaname is provided apply this grant on all future pipes in the given database. The pipename field must be unset in order to use onfuture.
pipe_name str
The name of the pipe on which to grant privileges immediately (only valid if on_future is false).
privilege str
The privilege to grant on the current or future pipe.
roles Sequence[str]
Grants privilege to these roles.
schema_name str
The name of the schema containing the current or future pipes on which to grant privileges.
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.