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

snowflake.PipeGrant

Explore with Pulumi AI

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

    Deprecation This resource is deprecated and will be removed in a future major version release. Please use snowflake.GrantPrivilegesToAccountRole instead.

    Example Usage

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

const grant = new snowflake.PipeGrant("grant", {
    databaseName: "database",
    schemaName: "schema",
    pipeName: "pipe",
    privilege: "OPERATE",
    roles: [
        "role1",
        "role2",
    ],
    onFuture: false,
    withGrantOption: false,
});

    import pulumi
import pulumi_snowflake as snowflake

grant = snowflake.PipeGrant("grant",
    database_name="database",
    schema_name="schema",
    pipe_name="pipe",
    privilege="OPERATE",
    roles=[
        "role1",
        "role2",
    ],
    on_future=False,
    with_grant_option=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.NewPipeGrant(ctx, "grant", &snowflake.PipeGrantArgs{
			DatabaseName: pulumi.String("database"),
			SchemaName:   pulumi.String("schema"),
			PipeName:     pulumi.String("pipe"),
			Privilege:    pulumi.String("OPERATE"),
			Roles: pulumi.StringArray{
				pulumi.String("role1"),
				pulumi.String("role2"),
			},
			OnFuture:        pulumi.Bool(false),
			WithGrantOption: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Snowflake = Pulumi.Snowflake;

return await Deployment.RunAsync(() => 
{
    var grant = new Snowflake.PipeGrant("grant", new()
    {
        DatabaseName = "database",
        SchemaName = "schema",
        PipeName = "pipe",
        Privilege = "OPERATE",
        Roles = new[]
        {
            "role1",
            "role2",
        },
        OnFuture = false,
        WithGrantOption = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.PipeGrant;
import com.pulumi.snowflake.PipeGrantArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var grant = new PipeGrant("grant", PipeGrantArgs.builder()
            .databaseName("database")
            .schemaName("schema")
            .pipeName("pipe")
            .privilege("OPERATE")
            .roles(            
                "role1",
                "role2")
            .onFuture(false)
            .withGrantOption(false)
            .build());

    }
}

    resources:
  grant:
    type: snowflake:PipeGrant
    properties:
      databaseName: database
      schemaName: schema
      pipeName: pipe
      privilege: OPERATE
      roles:
        - role1
        - role2
      onFuture: false
      withGrantOption: false

    Create PipeGrant Resource

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

    Constructor syntax

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

@overload
def PipeGrant(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              database_name: Optional[str] = None,
              enable_multiple_grants: Optional[bool] = None,
              on_future: Optional[bool] = None,
              pipe_name: Optional[str] = None,
              privilege: Optional[str] = None,
              revert_ownership_to_role_name: Optional[str] = None,
              roles: Optional[Sequence[str]] = None,
              schema_name: Optional[str] = None,
              with_grant_option: Optional[bool] = None)
    func NewPipeGrant(ctx *Context, name string, args PipeGrantArgs, opts ...ResourceOption) (*PipeGrant, error)
    public PipeGrant(string name, PipeGrantArgs args, CustomResourceOptions? opts = null)
    public PipeGrant(String name, PipeGrantArgs args)
public PipeGrant(String name, PipeGrantArgs args, CustomResourceOptions options)

    type: snowflake:PipeGrant
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 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.
    name String
    The unique name of the resource.
    args PipeGrantArgs
    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 pipeGrantResource = new Snowflake.PipeGrant("pipeGrantResource", new()
{
    DatabaseName = "string",
    EnableMultipleGrants = false,
    OnFuture = false,
    PipeName = "string",
    Privilege = "string",
    RevertOwnershipToRoleName = "string",
    Roles = new[]
    {
        "string",
    },
    SchemaName = "string",
    WithGrantOption = false,
});

    example, err := snowflake.NewPipeGrant(ctx, "pipeGrantResource", &snowflake.PipeGrantArgs{
	DatabaseName:              pulumi.String("string"),
	EnableMultipleGrants:      pulumi.Bool(false),
	OnFuture:                  pulumi.Bool(false),
	PipeName:                  pulumi.String("string"),
	Privilege:                 pulumi.String("string"),
	RevertOwnershipToRoleName: pulumi.String("string"),
	Roles: pulumi.StringArray{
		pulumi.String("string"),
	},
	SchemaName:      pulumi.String("string"),
	WithGrantOption: pulumi.Bool(false),
})

    var pipeGrantResource = new PipeGrant("pipeGrantResource", PipeGrantArgs.builder()
    .databaseName("string")
    .enableMultipleGrants(false)
    .onFuture(false)
    .pipeName("string")
    .privilege("string")
    .revertOwnershipToRoleName("string")
    .roles("string")
    .schemaName("string")
    .withGrantOption(false)
    .build());

    pipe_grant_resource = snowflake.PipeGrant("pipeGrantResource",
    database_name="string",
    enable_multiple_grants=False,
    on_future=False,
    pipe_name="string",
    privilege="string",
    revert_ownership_to_role_name="string",
    roles=["string"],
    schema_name="string",
    with_grant_option=False)

    const pipeGrantResource = new snowflake.PipeGrant("pipeGrantResource", {
    databaseName: "string",
    enableMultipleGrants: false,
    onFuture: false,
    pipeName: "string",
    privilege: "string",
    revertOwnershipToRoleName: "string",
    roles: ["string"],
    schemaName: "string",
    withGrantOption: false,
});

    type: snowflake:PipeGrant
properties:
    databaseName: string
    enableMultipleGrants: false
    onFuture: false
    pipeName: string
    privilege: string
    revertOwnershipToRoleName: string
    roles:
        - string
    schemaName: string
    withGrantOption: false

    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.
    EnableMultipleGrants bool
    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. To grant all privileges, use the value ALL PRIVILEGES
    RevertOwnershipToRoleName string
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    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.
    EnableMultipleGrants bool
    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. To grant all privileges, use the value ALL PRIVILEGES
    RevertOwnershipToRoleName string
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    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.
    enableMultipleGrants Boolean
    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. To grant all privileges, use the value ALL PRIVILEGES
    revertOwnershipToRoleName String
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    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 Boolean
    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.
    enableMultipleGrants boolean
    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. To grant all privileges, use the value ALL PRIVILEGES
    revertOwnershipToRoleName string
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    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.
    enable_multiple_grants bool
    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. To grant all privileges, use the value ALL PRIVILEGES
    revert_ownership_to_role_name str
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    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.
    databaseName String
    The name of the database containing the current or future pipes on which to grant privileges.
    enableMultipleGrants Boolean
    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. To grant all privileges, use the value ALL PRIVILEGES
    revertOwnershipToRoleName String
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    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 Boolean
    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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up 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,
        enable_multiple_grants: Optional[bool] = None,
        on_future: Optional[bool] = None,
        pipe_name: Optional[str] = None,
        privilege: Optional[str] = None,
        revert_ownership_to_role_name: 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)
    public static PipeGrant get(String name, Output<String> id, PipeGrantState 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:
    DatabaseName string
    The name of the database containing the current or future pipes on which to grant privileges.
    EnableMultipleGrants bool
    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. To grant all privileges, use the value ALL PRIVILEGES
    RevertOwnershipToRoleName string
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    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.
    EnableMultipleGrants bool
    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. To grant all privileges, use the value ALL PRIVILEGES
    RevertOwnershipToRoleName string
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    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.
    enableMultipleGrants Boolean
    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. To grant all privileges, use the value ALL PRIVILEGES
    revertOwnershipToRoleName String
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    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 Boolean
    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.
    enableMultipleGrants boolean
    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. To grant all privileges, use the value ALL PRIVILEGES
    revertOwnershipToRoleName string
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    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.
    enable_multiple_grants bool
    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. To grant all privileges, use the value ALL PRIVILEGES
    revert_ownership_to_role_name str
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    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.
    databaseName String
    The name of the database containing the current or future pipes on which to grant privileges.
    enableMultipleGrants Boolean
    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. To grant all privileges, use the value ALL PRIVILEGES
    revertOwnershipToRoleName String
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    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 Boolean
    When this is set to true, allows the recipient role to grant the privileges to other roles.

    Import

    format is database_name|schema_name|pipe_name|privilege|with_grant_option|on_future|roles

    $ pulumi import snowflake:index/pipeGrant:PipeGrant example "MY_DATABASE|MY_SCHEMA|MY_PIPE_NAME|OPERATE|false|false|role1,role2'

    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