snowflake.SchemaGrant
Explore with Pulumi AI
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.SchemaGrant("grant", {
databaseName: "database",
schemaName: "schema",
privilege: "USAGE",
roles: [
"role1",
"role2",
],
shares: [
"share1",
"share2",
],
onFuture: false,
withGrantOption: false,
});
import pulumi
import pulumi_snowflake as snowflake
grant = snowflake.SchemaGrant("grant",
database_name="database",
schema_name="schema",
privilege="USAGE",
roles=[
"role1",
"role2",
],
shares=[
"share1",
"share2",
],
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.NewSchemaGrant(ctx, "grant", &snowflake.SchemaGrantArgs{
DatabaseName: pulumi.String("database"),
SchemaName: pulumi.String("schema"),
Privilege: pulumi.String("USAGE"),
Roles: pulumi.StringArray{
pulumi.String("role1"),
pulumi.String("role2"),
},
Shares: pulumi.StringArray{
pulumi.String("share1"),
pulumi.String("share2"),
},
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.SchemaGrant("grant", new()
{
DatabaseName = "database",
SchemaName = "schema",
Privilege = "USAGE",
Roles = new[]
{
"role1",
"role2",
},
Shares = new[]
{
"share1",
"share2",
},
OnFuture = false,
WithGrantOption = false,
});
});
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")
.schemaName("schema")
.privilege("USAGE")
.roles(
"role1",
"role2")
.shares(
"share1",
"share2")
.onFuture(false)
.withGrantOption(false)
.build());
}
}
resources:
grant:
type: snowflake:SchemaGrant
properties:
databaseName: database
schemaName: schema
privilege: USAGE
roles:
- role1
- role2
shares:
- share1
- share2
onFuture: false
withGrantOption: false
Create SchemaGrant Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SchemaGrant(name: string, args: SchemaGrantArgs, opts?: CustomResourceOptions);
@overload
def SchemaGrant(resource_name: str,
args: SchemaGrantArgs,
opts: Optional[ResourceOptions] = None)
@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)
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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var schemaGrantResource = new Snowflake.SchemaGrant("schemaGrantResource", new()
{
DatabaseName = "string",
EnableMultipleGrants = false,
OnAll = false,
OnFuture = false,
Privilege = "string",
RevertOwnershipToRoleName = "string",
Roles = new[]
{
"string",
},
SchemaName = "string",
Shares = new[]
{
"string",
},
WithGrantOption = false,
});
example, err := snowflake.NewSchemaGrant(ctx, "schemaGrantResource", &snowflake.SchemaGrantArgs{
DatabaseName: pulumi.String("string"),
EnableMultipleGrants: pulumi.Bool(false),
OnAll: pulumi.Bool(false),
OnFuture: pulumi.Bool(false),
Privilege: pulumi.String("string"),
RevertOwnershipToRoleName: pulumi.String("string"),
Roles: pulumi.StringArray{
pulumi.String("string"),
},
SchemaName: pulumi.String("string"),
Shares: pulumi.StringArray{
pulumi.String("string"),
},
WithGrantOption: pulumi.Bool(false),
})
var schemaGrantResource = new SchemaGrant("schemaGrantResource", SchemaGrantArgs.builder()
.databaseName("string")
.enableMultipleGrants(false)
.onAll(false)
.onFuture(false)
.privilege("string")
.revertOwnershipToRoleName("string")
.roles("string")
.schemaName("string")
.shares("string")
.withGrantOption(false)
.build());
schema_grant_resource = snowflake.SchemaGrant("schemaGrantResource",
database_name="string",
enable_multiple_grants=False,
on_all=False,
on_future=False,
privilege="string",
revert_ownership_to_role_name="string",
roles=["string"],
schema_name="string",
shares=["string"],
with_grant_option=False)
const schemaGrantResource = new snowflake.SchemaGrant("schemaGrantResource", {
databaseName: "string",
enableMultipleGrants: false,
onAll: false,
onFuture: false,
privilege: "string",
revertOwnershipToRoleName: "string",
roles: ["string"],
schemaName: "string",
shares: ["string"],
withGrantOption: false,
});
type: snowflake:SchemaGrant
properties:
databaseName: string
enableMultipleGrants: false
onAll: false
onFuture: false
privilege: string
revertOwnershipToRoleName: string
roles:
- string
schemaName: string
shares:
- string
withGrantOption: false
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:
- Database
Name string - The name of the database containing the schema on which to grant privileges.
- Enable
Multiple boolGrants - 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 string
- Revert
Ownership stringTo Role Name - The name of the role to revert ownership to on destroy. Has no effect unless
privilege
is set toOWNERSHIP
- Roles List<string>
- Grants privilege to these roles.
- Schema
Name string - The name of the schema on which to grant privileges.
- List<string>
- Grants privilege to these shares (only valid if onfuture and onall are unset).
- With
Grant boolOption - When this is set to true, allows the recipient role to grant the privileges to other roles.
- Database
Name string - The name of the database containing the schema on which to grant privileges.
- Enable
Multiple boolGrants - 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 string
- Revert
Ownership stringTo Role Name - The name of the role to revert ownership to on destroy. Has no effect unless
privilege
is set toOWNERSHIP
- Roles []string
- Grants privilege to these roles.
- Schema
Name string - The name of the schema on which to grant privileges.
- []string
- Grants privilege to these shares (only valid if onfuture and onall are unset).
- With
Grant boolOption - When this is set to true, allows the recipient role to grant the privileges to other roles.
- database
Name String - The name of the database containing the schema on which to grant privileges.
- enable
Multiple BooleanGrants - on
All 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.
- on
Future 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
- revert
Ownership StringTo Role Name - The name of the role to revert ownership to on destroy. Has no effect unless
privilege
is set toOWNERSHIP
- roles List<String>
- Grants privilege to these roles.
- schema
Name String - The name of the schema on which to grant privileges.
- List<String>
- Grants privilege to these shares (only valid if onfuture and onall are unset).
- with
Grant BooleanOption - When this is set to true, allows the recipient role to grant the privileges to other roles.
- database
Name string - The name of the database containing the schema on which to grant privileges.
- enable
Multiple booleanGrants - on
All 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.
- on
Future 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
- revert
Ownership stringTo Role Name - The name of the role to revert ownership to on destroy. Has no effect unless
privilege
is set toOWNERSHIP
- roles string[]
- Grants privilege to these roles.
- schema
Name string - The name of the schema on which to grant privileges.
- string[]
- Grants privilege to these shares (only valid if onfuture and onall are unset).
- with
Grant booleanOption - 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_ boolgrants - 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
- revert_
ownership_ strto_ role_ name - The name of the role to revert ownership to on destroy. Has no effect unless
privilege
is set toOWNERSHIP
- roles Sequence[str]
- Grants privilege to these roles.
- schema_
name str - The name of the schema on which to grant privileges.
- Sequence[str]
- Grants privilege to these shares (only valid if onfuture and onall are unset).
- with_
grant_ booloption - When this is set to true, allows the recipient role to grant the privileges to other roles.
- database
Name String - The name of the database containing the schema on which to grant privileges.
- enable
Multiple BooleanGrants - on
All 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.
- on
Future 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
- revert
Ownership StringTo Role Name - The name of the role to revert ownership to on destroy. Has no effect unless
privilege
is set toOWNERSHIP
- roles List<String>
- Grants privilege to these roles.
- schema
Name String - The name of the schema on which to grant privileges.
- List<String>
- Grants privilege to these shares (only valid if onfuture and onall are unset).
- with
Grant BooleanOption - 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.
- Database
Name string - The name of the database containing the schema on which to grant privileges.
- Enable
Multiple boolGrants - 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 string
- Revert
Ownership stringTo Role Name - The name of the role to revert ownership to on destroy. Has no effect unless
privilege
is set toOWNERSHIP
- Roles List<string>
- Grants privilege to these roles.
- Schema
Name string - The name of the schema on which to grant privileges.
- List<string>
- Grants privilege to these shares (only valid if onfuture and onall are unset).
- With
Grant boolOption - When this is set to true, allows the recipient role to grant the privileges to other roles.
- Database
Name string - The name of the database containing the schema on which to grant privileges.
- Enable
Multiple boolGrants - 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 string
- Revert
Ownership stringTo Role Name - The name of the role to revert ownership to on destroy. Has no effect unless
privilege
is set toOWNERSHIP
- Roles []string
- Grants privilege to these roles.
- Schema
Name string - The name of the schema on which to grant privileges.
- []string
- Grants privilege to these shares (only valid if onfuture and onall are unset).
- With
Grant boolOption - When this is set to true, allows the recipient role to grant the privileges to other roles.
- database
Name String - The name of the database containing the schema on which to grant privileges.
- enable
Multiple BooleanGrants - on
All 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.
- on
Future 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
- revert
Ownership StringTo Role Name - The name of the role to revert ownership to on destroy. Has no effect unless
privilege
is set toOWNERSHIP
- roles List<String>
- Grants privilege to these roles.
- schema
Name String - The name of the schema on which to grant privileges.
- List<String>
- Grants privilege to these shares (only valid if onfuture and onall are unset).
- with
Grant BooleanOption - When this is set to true, allows the recipient role to grant the privileges to other roles.
- database
Name string - The name of the database containing the schema on which to grant privileges.
- enable
Multiple booleanGrants - on
All 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.
- on
Future 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
- revert
Ownership stringTo Role Name - The name of the role to revert ownership to on destroy. Has no effect unless
privilege
is set toOWNERSHIP
- roles string[]
- Grants privilege to these roles.
- schema
Name string - The name of the schema on which to grant privileges.
- string[]
- Grants privilege to these shares (only valid if onfuture and onall are unset).
- with
Grant booleanOption - 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_ boolgrants - 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
- revert_
ownership_ strto_ role_ name - The name of the role to revert ownership to on destroy. Has no effect unless
privilege
is set toOWNERSHIP
- roles Sequence[str]
- Grants privilege to these roles.
- schema_
name str - The name of the schema on which to grant privileges.
- Sequence[str]
- Grants privilege to these shares (only valid if onfuture and onall are unset).
- with_
grant_ booloption - When this is set to true, allows the recipient role to grant the privileges to other roles.
- database
Name String - The name of the database containing the schema on which to grant privileges.
- enable
Multiple BooleanGrants - on
All 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.
- on
Future 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
- revert
Ownership StringTo Role Name - The name of the role to revert ownership to on destroy. Has no effect unless
privilege
is set toOWNERSHIP
- roles List<String>
- Grants privilege to these roles.
- schema
Name String - The name of the schema on which to grant privileges.
- List<String>
- Grants privilege to these shares (only valid if onfuture and onall are unset).
- with
Grant BooleanOption - 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"
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.