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

snowflake.UserGrant

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.UserGrant("grant", {
    userName: "user",
    privilege: "MONITOR",
    roles: [
        "role1",
        "role2",
    ],
    withGrantOption: false,
});

    import pulumi
import pulumi_snowflake as snowflake

grant = snowflake.UserGrant("grant",
    user_name="user",
    privilege="MONITOR",
    roles=[
        "role1",
        "role2",
    ],
    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.NewUserGrant(ctx, "grant", &snowflake.UserGrantArgs{
			UserName:  pulumi.String("user"),
			Privilege: pulumi.String("MONITOR"),
			Roles: pulumi.StringArray{
				pulumi.String("role1"),
				pulumi.String("role2"),
			},
			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.UserGrant("grant", new()
    {
        UserName = "user",
        Privilege = "MONITOR",
        Roles = new[]
        {
            "role1",
            "role2",
        },
        WithGrantOption = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.UserGrant;
import com.pulumi.snowflake.UserGrantArgs;
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 UserGrant("grant", UserGrantArgs.builder()
            .userName("user")
            .privilege("MONITOR")
            .roles(            
                "role1",
                "role2")
            .withGrantOption(false)
            .build());

    }
}

    resources:
  grant:
    type: snowflake:UserGrant
    properties:
      userName: user
      privilege: MONITOR
      roles:
        - role1
        - role2
      withGrantOption: false

    Create UserGrant Resource

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

    Constructor syntax

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

@overload
def UserGrant(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              privilege: Optional[str] = None,
              user_name: Optional[str] = None,
              enable_multiple_grants: Optional[bool] = None,
              roles: Optional[Sequence[str]] = None,
              with_grant_option: Optional[bool] = None)
    func NewUserGrant(ctx *Context, name string, args UserGrantArgs, opts ...ResourceOption) (*UserGrant, error)
    public UserGrant(string name, UserGrantArgs args, CustomResourceOptions? opts = null)
    public UserGrant(String name, UserGrantArgs args)
public UserGrant(String name, UserGrantArgs args, CustomResourceOptions options)

    type: snowflake:UserGrant
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 UserGrantArgs
    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 UserGrantArgs
    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 UserGrantArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserGrantArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserGrantArgs
    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 userGrantResource = new Snowflake.UserGrant("userGrantResource", new()
{
    Privilege = "string",
    UserName = "string",
    EnableMultipleGrants = false,
    Roles = new[]
    {
        "string",
    },
    WithGrantOption = false,
});

    example, err := snowflake.NewUserGrant(ctx, "userGrantResource", &snowflake.UserGrantArgs{
	Privilege:            pulumi.String("string"),
	UserName:             pulumi.String("string"),
	EnableMultipleGrants: pulumi.Bool(false),
	Roles: pulumi.StringArray{
		pulumi.String("string"),
	},
	WithGrantOption: pulumi.Bool(false),
})

    var userGrantResource = new UserGrant("userGrantResource", UserGrantArgs.builder()
    .privilege("string")
    .userName("string")
    .enableMultipleGrants(false)
    .roles("string")
    .withGrantOption(false)
    .build());

    user_grant_resource = snowflake.UserGrant("userGrantResource",
    privilege="string",
    user_name="string",
    enable_multiple_grants=False,
    roles=["string"],
    with_grant_option=False)

    const userGrantResource = new snowflake.UserGrant("userGrantResource", {
    privilege: "string",
    userName: "string",
    enableMultipleGrants: false,
    roles: ["string"],
    withGrantOption: false,
});

    type: snowflake:UserGrant
properties:
    enableMultipleGrants: false
    privilege: string
    roles:
        - string
    userName: string
    withGrantOption: false

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

    Privilege string
    The privilege to grant on the user. To grant all privileges, use the value ALL PRIVILEGES.
    UserName string
    The name of the user on which to grant privileges.
    EnableMultipleGrants bool
    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.
    Privilege string
    The privilege to grant on the user. To grant all privileges, use the value ALL PRIVILEGES.
    UserName string
    The name of the user on which to grant privileges.
    EnableMultipleGrants bool
    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.
    privilege String
    The privilege to grant on the user. To grant all privileges, use the value ALL PRIVILEGES.
    userName String
    The name of the user on which to grant privileges.
    enableMultipleGrants Boolean
    roles List<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.
    privilege string
    The privilege to grant on the user. To grant all privileges, use the value ALL PRIVILEGES.
    userName string
    The name of the user on which to grant privileges.
    enableMultipleGrants boolean
    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.
    privilege str
    The privilege to grant on the user. To grant all privileges, use the value ALL PRIVILEGES.
    user_name str
    The name of the user on which to grant privileges.
    enable_multiple_grants bool
    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.
    privilege String
    The privilege to grant on the user. To grant all privileges, use the value ALL PRIVILEGES.
    userName String
    The name of the user on which to grant privileges.
    enableMultipleGrants Boolean
    roles List<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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UserGrant 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 UserGrant Resource

    Get an existing UserGrant 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?: UserGrantState, opts?: CustomResourceOptions): UserGrant
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enable_multiple_grants: Optional[bool] = None,
        privilege: Optional[str] = None,
        roles: Optional[Sequence[str]] = None,
        user_name: Optional[str] = None,
        with_grant_option: Optional[bool] = None) -> UserGrant
    func GetUserGrant(ctx *Context, name string, id IDInput, state *UserGrantState, opts ...ResourceOption) (*UserGrant, error)
    public static UserGrant Get(string name, Input<string> id, UserGrantState? state, CustomResourceOptions? opts = null)
    public static UserGrant get(String name, Output<String> id, UserGrantState 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:
    EnableMultipleGrants bool
    Privilege string
    The privilege to grant on the user. To grant all privileges, use the value ALL PRIVILEGES.
    Roles List<string>
    Grants privilege to these roles.
    UserName string
    The name of the user on which to grant privileges.
    WithGrantOption bool
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    EnableMultipleGrants bool
    Privilege string
    The privilege to grant on the user. To grant all privileges, use the value ALL PRIVILEGES.
    Roles []string
    Grants privilege to these roles.
    UserName string
    The name of the user on which to grant privileges.
    WithGrantOption bool
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    enableMultipleGrants Boolean
    privilege String
    The privilege to grant on the user. To grant all privileges, use the value ALL PRIVILEGES.
    roles List<String>
    Grants privilege to these roles.
    userName String
    The name of the user on which to grant privileges.
    withGrantOption Boolean
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    enableMultipleGrants boolean
    privilege string
    The privilege to grant on the user. To grant all privileges, use the value ALL PRIVILEGES.
    roles string[]
    Grants privilege to these roles.
    userName string
    The name of the user on which to grant privileges.
    withGrantOption boolean
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    enable_multiple_grants bool
    privilege str
    The privilege to grant on the user. To grant all privileges, use the value ALL PRIVILEGES.
    roles Sequence[str]
    Grants privilege to these roles.
    user_name str
    The name of the user 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.
    enableMultipleGrants Boolean
    privilege String
    The privilege to grant on the user. To grant all privileges, use the value ALL PRIVILEGES.
    roles List<String>
    Grants privilege to these roles.
    userName String
    The name of the user 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 user_name|privilege|with_grant_option|roles

    $ pulumi import snowflake:index/userGrant:UserGrant example "USERNAME|MONITOR|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