1. Packages
  2. Snowflake
  3. API Docs
  4. SchemaGrant
Snowflake v0.50.2 published on Friday, Mar 8, 2024 by Pulumi

snowflake.SchemaGrant

Explore with Pulumi AI

snowflake logo
Snowflake v0.50.2 published on Friday, Mar 8, 2024 by Pulumi

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

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Snowflake = Pulumi.Snowflake;
    
    return await Deployment.RunAsync(() => 
    {
        var grant = new Snowflake.SchemaGrant("grant", new()
        {
            DatabaseName = "database",
            OnFuture = false,
            Privilege = "USAGE",
            Roles = new[]
            {
                "role1",
                "role2",
            },
            SchemaName = "schema",
            Shares = new[]
            {
                "share1",
                "share2",
            },
            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.NewSchemaGrant(ctx, "grant", &snowflake.SchemaGrantArgs{
    			DatabaseName: pulumi.String("database"),
    			OnFuture:     pulumi.Bool(false),
    			Privilege:    pulumi.String("USAGE"),
    			Roles: pulumi.StringArray{
    				pulumi.String("role1"),
    				pulumi.String("role2"),
    			},
    			SchemaName: pulumi.String("schema"),
    			Shares: pulumi.StringArray{
    				pulumi.String("share1"),
    				pulumi.String("share2"),
    			},
    			WithGrantOption: pulumi.Bool(false),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.snowflake.SchemaGrant;
    import com.pulumi.snowflake.SchemaGrantArgs;
    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 SchemaGrant("grant", SchemaGrantArgs.builder()        
                .databaseName("database")
                .onFuture(false)
                .privilege("USAGE")
                .roles(            
                    "role1",
                    "role2")
                .schemaName("schema")
                .shares(            
                    "share1",
                    "share2")
                .withGrantOption(false)
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_snowflake as snowflake
    
    grant = snowflake.SchemaGrant("grant",
        database_name="database",
        on_future=False,
        privilege="USAGE",
        roles=[
            "role1",
            "role2",
        ],
        schema_name="schema",
        shares=[
            "share1",
            "share2",
        ],
        with_grant_option=False)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as snowflake from "@pulumi/snowflake";
    
    const grant = new snowflake.SchemaGrant("grant", {
        databaseName: "database",
        onFuture: false,
        privilege: "USAGE",
        roles: [
            "role1",
            "role2",
        ],
        schemaName: "schema",
        shares: [
            "share1",
            "share2",
        ],
        withGrantOption: false,
    });
    
    resources:
      grant:
        type: snowflake:SchemaGrant
        properties:
          databaseName: database
          onFuture: false
          privilege: USAGE
          roles:
            - role1
            - role2
          schemaName: schema
          shares:
            - share1
            - share2
          withGrantOption: false
    

    Create SchemaGrant Resource

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

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

    DatabaseName string
    The name of the database containing the schema on which to grant privileges.
    EnableMultipleGrants bool
    When this is set to true, multiple grants of the same type can be created. This will cause Terraform to not revoke grants applied to roles and objects outside Terraform.
    OnAll bool
    When this is set to true, apply this grant on all schemas in the given database. The schemaname and shares fields must be unset in order to use onall. Cannot be used together with on_future.
    OnFuture bool
    When this is set to true, apply this grant on all future schemas in the given database. The schemaname and shares fields must be unset in order to use onfuture. Cannot be used together with on_all.
    Privilege string
    The privilege to grant on the current or future schema. Note that if "OWNERSHIP" is specified, ensure that the role that terraform is using is granted access. 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 on which to grant privileges.
    Shares List<string>
    Grants privilege to these shares (only valid if onfuture and onall are unset).
    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 schema on which to grant privileges.
    EnableMultipleGrants bool
    When this is set to true, multiple grants of the same type can be created. This will cause Terraform to not revoke grants applied to roles and objects outside Terraform.
    OnAll bool
    When this is set to true, apply this grant on all schemas in the given database. The schemaname and shares fields must be unset in order to use onall. Cannot be used together with on_future.
    OnFuture bool
    When this is set to true, apply this grant on all future schemas in the given database. The schemaname and shares fields must be unset in order to use onfuture. Cannot be used together with on_all.
    Privilege string
    The privilege to grant on the current or future schema. Note that if "OWNERSHIP" is specified, ensure that the role that terraform is using is granted access. 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 on which to grant privileges.
    Shares []string
    Grants privilege to these shares (only valid if onfuture and onall are unset).
    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 schema on which to grant privileges.
    enableMultipleGrants Boolean
    When this is set to true, multiple grants of the same type can be created. This will cause Terraform to not revoke grants applied to roles and objects outside Terraform.
    onAll Boolean
    When this is set to true, apply this grant on all schemas in the given database. The schemaname and shares fields must be unset in order to use onall. Cannot be used together with on_future.
    onFuture Boolean
    When this is set to true, apply this grant on all future schemas in the given database. The schemaname and shares fields must be unset in order to use onfuture. Cannot be used together with on_all.
    privilege String
    The privilege to grant on the current or future schema. Note that if "OWNERSHIP" is specified, ensure that the role that terraform is using is granted access. 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 on which to grant privileges.
    shares List<String>
    Grants privilege to these shares (only valid if onfuture and onall are unset).
    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 schema on which to grant privileges.
    enableMultipleGrants boolean
    When this is set to true, multiple grants of the same type can be created. This will cause Terraform to not revoke grants applied to roles and objects outside Terraform.
    onAll boolean
    When this is set to true, apply this grant on all schemas in the given database. The schemaname and shares fields must be unset in order to use onall. Cannot be used together with on_future.
    onFuture boolean
    When this is set to true, apply this grant on all future schemas in the given database. The schemaname and shares fields must be unset in order to use onfuture. Cannot be used together with on_all.
    privilege string
    The privilege to grant on the current or future schema. Note that if "OWNERSHIP" is specified, ensure that the role that terraform is using is granted access. 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 on which to grant privileges.
    shares string[]
    Grants privilege to these shares (only valid if onfuture and onall are unset).
    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 schema on which to grant privileges.
    enable_multiple_grants bool
    When this is set to true, multiple grants of the same type can be created. This will cause Terraform to not revoke grants applied to roles and objects outside Terraform.
    on_all bool
    When this is set to true, apply this grant on all schemas in the given database. The schemaname and shares fields must be unset in order to use onall. Cannot be used together with on_future.
    on_future bool
    When this is set to true, apply this grant on all future schemas in the given database. The schemaname and shares fields must be unset in order to use onfuture. Cannot be used together with on_all.
    privilege str
    The privilege to grant on the current or future schema. Note that if "OWNERSHIP" is specified, ensure that the role that terraform is using is granted access. 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 on which to grant privileges.
    shares Sequence[str]
    Grants privilege to these shares (only valid if onfuture and onall are unset).
    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 schema on which to grant privileges.
    enableMultipleGrants Boolean
    When this is set to true, multiple grants of the same type can be created. This will cause Terraform to not revoke grants applied to roles and objects outside Terraform.
    onAll Boolean
    When this is set to true, apply this grant on all schemas in the given database. The schemaname and shares fields must be unset in order to use onall. Cannot be used together with on_future.
    onFuture Boolean
    When this is set to true, apply this grant on all future schemas in the given database. The schemaname and shares fields must be unset in order to use onfuture. Cannot be used together with on_all.
    privilege String
    The privilege to grant on the current or future schema. Note that if "OWNERSHIP" is specified, ensure that the role that terraform is using is granted access. 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 on which to grant privileges.
    shares List<String>
    Grants privilege to these shares (only valid if onfuture and onall are unset).
    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 SchemaGrant 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 SchemaGrant Resource

    Get an existing SchemaGrant 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?: SchemaGrantState, opts?: CustomResourceOptions): SchemaGrant
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            database_name: Optional[str] = None,
            enable_multiple_grants: Optional[bool] = None,
            on_all: Optional[bool] = None,
            on_future: Optional[bool] = None,
            privilege: Optional[str] = None,
            revert_ownership_to_role_name: Optional[str] = None,
            roles: Optional[Sequence[str]] = None,
            schema_name: Optional[str] = None,
            shares: Optional[Sequence[str]] = None,
            with_grant_option: Optional[bool] = None) -> SchemaGrant
    func GetSchemaGrant(ctx *Context, name string, id IDInput, state *SchemaGrantState, opts ...ResourceOption) (*SchemaGrant, error)
    public static SchemaGrant Get(string name, Input<string> id, SchemaGrantState? state, CustomResourceOptions? opts = null)
    public static SchemaGrant get(String name, Output<String> id, SchemaGrantState 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 schema on which to grant privileges.
    EnableMultipleGrants bool
    When this is set to true, multiple grants of the same type can be created. This will cause Terraform to not revoke grants applied to roles and objects outside Terraform.
    OnAll bool
    When this is set to true, apply this grant on all schemas in the given database. The schemaname and shares fields must be unset in order to use onall. Cannot be used together with on_future.
    OnFuture bool
    When this is set to true, apply this grant on all future schemas in the given database. The schemaname and shares fields must be unset in order to use onfuture. Cannot be used together with on_all.
    Privilege string
    The privilege to grant on the current or future schema. Note that if "OWNERSHIP" is specified, ensure that the role that terraform is using is granted access. 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 on which to grant privileges.
    Shares List<string>
    Grants privilege to these shares (only valid if onfuture and onall are unset).
    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 schema on which to grant privileges.
    EnableMultipleGrants bool
    When this is set to true, multiple grants of the same type can be created. This will cause Terraform to not revoke grants applied to roles and objects outside Terraform.
    OnAll bool
    When this is set to true, apply this grant on all schemas in the given database. The schemaname and shares fields must be unset in order to use onall. Cannot be used together with on_future.
    OnFuture bool
    When this is set to true, apply this grant on all future schemas in the given database. The schemaname and shares fields must be unset in order to use onfuture. Cannot be used together with on_all.
    Privilege string
    The privilege to grant on the current or future schema. Note that if "OWNERSHIP" is specified, ensure that the role that terraform is using is granted access. 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 on which to grant privileges.
    Shares []string
    Grants privilege to these shares (only valid if onfuture and onall are unset).
    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 schema on which to grant privileges.
    enableMultipleGrants Boolean
    When this is set to true, multiple grants of the same type can be created. This will cause Terraform to not revoke grants applied to roles and objects outside Terraform.
    onAll Boolean
    When this is set to true, apply this grant on all schemas in the given database. The schemaname and shares fields must be unset in order to use onall. Cannot be used together with on_future.
    onFuture Boolean
    When this is set to true, apply this grant on all future schemas in the given database. The schemaname and shares fields must be unset in order to use onfuture. Cannot be used together with on_all.
    privilege String
    The privilege to grant on the current or future schema. Note that if "OWNERSHIP" is specified, ensure that the role that terraform is using is granted access. 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 on which to grant privileges.
    shares List<String>
    Grants privilege to these shares (only valid if onfuture and onall are unset).
    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 schema on which to grant privileges.
    enableMultipleGrants boolean
    When this is set to true, multiple grants of the same type can be created. This will cause Terraform to not revoke grants applied to roles and objects outside Terraform.
    onAll boolean
    When this is set to true, apply this grant on all schemas in the given database. The schemaname and shares fields must be unset in order to use onall. Cannot be used together with on_future.
    onFuture boolean
    When this is set to true, apply this grant on all future schemas in the given database. The schemaname and shares fields must be unset in order to use onfuture. Cannot be used together with on_all.
    privilege string
    The privilege to grant on the current or future schema. Note that if "OWNERSHIP" is specified, ensure that the role that terraform is using is granted access. 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 on which to grant privileges.
    shares string[]
    Grants privilege to these shares (only valid if onfuture and onall are unset).
    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 schema on which to grant privileges.
    enable_multiple_grants bool
    When this is set to true, multiple grants of the same type can be created. This will cause Terraform to not revoke grants applied to roles and objects outside Terraform.
    on_all bool
    When this is set to true, apply this grant on all schemas in the given database. The schemaname and shares fields must be unset in order to use onall. Cannot be used together with on_future.
    on_future bool
    When this is set to true, apply this grant on all future schemas in the given database. The schemaname and shares fields must be unset in order to use onfuture. Cannot be used together with on_all.
    privilege str
    The privilege to grant on the current or future schema. Note that if "OWNERSHIP" is specified, ensure that the role that terraform is using is granted access. 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 on which to grant privileges.
    shares Sequence[str]
    Grants privilege to these shares (only valid if onfuture and onall are unset).
    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 schema on which to grant privileges.
    enableMultipleGrants Boolean
    When this is set to true, multiple grants of the same type can be created. This will cause Terraform to not revoke grants applied to roles and objects outside Terraform.
    onAll Boolean
    When this is set to true, apply this grant on all schemas in the given database. The schemaname and shares fields must be unset in order to use onall. Cannot be used together with on_future.
    onFuture Boolean
    When this is set to true, apply this grant on all future schemas in the given database. The schemaname and shares fields must be unset in order to use onfuture. Cannot be used together with on_all.
    privilege String
    The privilege to grant on the current or future schema. Note that if "OWNERSHIP" is specified, ensure that the role that terraform is using is granted access. 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 on which to grant privileges.
    shares List<String>
    Grants privilege to these shares (only valid if onfuture and onall are unset).
    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|privilege|with_grant_option|on_future|on_all|roles|shares

    $ pulumi import snowflake:index/schemaGrant:SchemaGrant example "MY_DATABASE|MY_SCHEMA|USAGE|false|false|false|role1,role2|share1,share2"
    

    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.50.2 published on Friday, Mar 8, 2024 by Pulumi