1. Pulumi Registry
  2. Snowflake
  3. API Docs
  4. ExternalTableGrant
snowflake logo
Snowflake v0.16.0, Jan 30 23

snowflake.ExternalTableGrant

Import

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

 $ pulumi import snowflake:index/externalTableGrant:ExternalTableGrant example 'dbName|schemaName|externalTableName|SELECT|false'

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var grant = new Snowflake.ExternalTableGrant("grant", new()
    {
        DatabaseName = "database",
        ExternalTableName = "external_table",
        OnFuture = false,
        Privilege = "SELECT",
        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.NewExternalTableGrant(ctx, "grant", &snowflake.ExternalTableGrantArgs{
			DatabaseName:      pulumi.String("database"),
			ExternalTableName: pulumi.String("external_table"),
			OnFuture:          pulumi.Bool(false),
			Privilege:         pulumi.String("SELECT"),
			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.ExternalTableGrant;
import com.pulumi.snowflake.ExternalTableGrantArgs;
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 ExternalTableGrant("grant", ExternalTableGrantArgs.builder()        
            .databaseName("database")
            .externalTableName("external_table")
            .onFuture(false)
            .privilege("SELECT")
            .roles(            
                "role1",
                "role2")
            .schemaName("schema")
            .shares(            
                "share1",
                "share2")
            .withGrantOption(false)
            .build());

    }
}

import pulumi
import pulumi_snowflake as snowflake

grant = snowflake.ExternalTableGrant("grant",
    database_name="database",
    external_table_name="external_table",
    on_future=False,
    privilege="SELECT",
    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.ExternalTableGrant("grant", {
    databaseName: "database",
    externalTableName: "external_table",
    onFuture: false,
    privilege: "SELECT",
    roles: [
        "role1",
        "role2",
    ],
    schemaName: "schema",
    shares: [
        "share1",
        "share2",
    ],
    withGrantOption: false,
});

resources:
  grant:
    type: snowflake:ExternalTableGrant
    properties:
      databaseName: database
      externalTableName: external_table
      onFuture: false
      privilege: SELECT
      roles:
        - role1
        - role2
      schemaName: schema
      shares:
        - share1
        - share2
      withGrantOption: false

Create ExternalTableGrant Resource

new ExternalTableGrant(name: string, args: ExternalTableGrantArgs, opts?: CustomResourceOptions);
@overload
def ExternalTableGrant(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       database_name: Optional[str] = None,
                       enable_multiple_grants: Optional[bool] = None,
                       external_table_name: Optional[str] = None,
                       on_future: Optional[bool] = None,
                       privilege: 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 ExternalTableGrant(resource_name: str,
                       args: ExternalTableGrantArgs,
                       opts: Optional[ResourceOptions] = None)
func NewExternalTableGrant(ctx *Context, name string, args ExternalTableGrantArgs, opts ...ResourceOption) (*ExternalTableGrant, error)
public ExternalTableGrant(string name, ExternalTableGrantArgs args, CustomResourceOptions? opts = null)
public ExternalTableGrant(String name, ExternalTableGrantArgs args)
public ExternalTableGrant(String name, ExternalTableGrantArgs args, CustomResourceOptions options)

type: snowflake:ExternalTableGrant
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ExternalTableGrantArgs
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 ExternalTableGrantArgs
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 ExternalTableGrantArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ExternalTableGrantArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ExternalTableGrantArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

DatabaseName string

The name of the database containing the current or future external tables on which to grant privileges.

Roles List<string>

Grants privilege to these roles.

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.

ExternalTableName string

The name of the external table on which to grant privileges immediately (only valid if on_future is false).

OnFuture bool

When this is set to true and a schemaname is provided, apply this grant on all future external tables in the given schema. When this is true and no schemaname is provided apply this grant on all future external tables in the given database. The externaltablename and shares fields must be unset in order to use on_future.

Privilege string

The privilege to grant on the current or future external table.

SchemaName string

The name of the schema containing the current or future external tables on which to grant privileges.

Shares List<string>

Grants privilege to these shares (only valid if on_future is false).

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 external tables on which to grant privileges.

Roles []string

Grants privilege to these roles.

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.

ExternalTableName string

The name of the external table on which to grant privileges immediately (only valid if on_future is false).

OnFuture bool

When this is set to true and a schemaname is provided, apply this grant on all future external tables in the given schema. When this is true and no schemaname is provided apply this grant on all future external tables in the given database. The externaltablename and shares fields must be unset in order to use on_future.

Privilege string

The privilege to grant on the current or future external table.

SchemaName string

The name of the schema containing the current or future external tables on which to grant privileges.

Shares []string

Grants privilege to these shares (only valid if on_future is false).

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 external tables on which to grant privileges.

roles List<String>

Grants privilege to these roles.

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.

externalTableName String

The name of the external table on which to grant privileges immediately (only valid if on_future is false).

onFuture Boolean

When this is set to true and a schemaname is provided, apply this grant on all future external tables in the given schema. When this is true and no schemaname is provided apply this grant on all future external tables in the given database. The externaltablename and shares fields must be unset in order to use on_future.

privilege String

The privilege to grant on the current or future external table.

schemaName String

The name of the schema containing the current or future external tables on which to grant privileges.

shares List<String>

Grants privilege to these shares (only valid if on_future is false).

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 external tables on which to grant privileges.

roles string[]

Grants privilege to these roles.

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.

externalTableName string

The name of the external table on which to grant privileges immediately (only valid if on_future is false).

onFuture boolean

When this is set to true and a schemaname is provided, apply this grant on all future external tables in the given schema. When this is true and no schemaname is provided apply this grant on all future external tables in the given database. The externaltablename and shares fields must be unset in order to use on_future.

privilege string

The privilege to grant on the current or future external table.

schemaName string

The name of the schema containing the current or future external tables on which to grant privileges.

shares string[]

Grants privilege to these shares (only valid if on_future is false).

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 external tables on which to grant privileges.

roles Sequence[str]

Grants privilege to these roles.

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.

external_table_name str

The name of the external table on which to grant privileges immediately (only valid if on_future is false).

on_future bool

When this is set to true and a schemaname is provided, apply this grant on all future external tables in the given schema. When this is true and no schemaname is provided apply this grant on all future external tables in the given database. The externaltablename and shares fields must be unset in order to use on_future.

privilege str

The privilege to grant on the current or future external table.

schema_name str

The name of the schema containing the current or future external tables on which to grant privileges.

shares Sequence[str]

Grants privilege to these shares (only valid if on_future is false).

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 external tables on which to grant privileges.

roles List<String>

Grants privilege to these roles.

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.

externalTableName String

The name of the external table on which to grant privileges immediately (only valid if on_future is false).

onFuture Boolean

When this is set to true and a schemaname is provided, apply this grant on all future external tables in the given schema. When this is true and no schemaname is provided apply this grant on all future external tables in the given database. The externaltablename and shares fields must be unset in order to use on_future.

privilege String

The privilege to grant on the current or future external table.

schemaName String

The name of the schema containing the current or future external tables on which to grant privileges.

shares List<String>

Grants privilege to these shares (only valid if on_future is false).

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 ExternalTableGrant 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 ExternalTableGrant Resource

Get an existing ExternalTableGrant 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?: ExternalTableGrantState, opts?: CustomResourceOptions): ExternalTableGrant
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        database_name: Optional[str] = None,
        enable_multiple_grants: Optional[bool] = None,
        external_table_name: Optional[str] = None,
        on_future: Optional[bool] = None,
        privilege: Optional[str] = None,
        roles: Optional[Sequence[str]] = None,
        schema_name: Optional[str] = None,
        shares: Optional[Sequence[str]] = None,
        with_grant_option: Optional[bool] = None) -> ExternalTableGrant
func GetExternalTableGrant(ctx *Context, name string, id IDInput, state *ExternalTableGrantState, opts ...ResourceOption) (*ExternalTableGrant, error)
public static ExternalTableGrant Get(string name, Input<string> id, ExternalTableGrantState? state, CustomResourceOptions? opts = null)
public static ExternalTableGrant get(String name, Output<String> id, ExternalTableGrantState 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 external tables 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.

ExternalTableName string

The name of the external table on which to grant privileges immediately (only valid if on_future is false).

OnFuture bool

When this is set to true and a schemaname is provided, apply this grant on all future external tables in the given schema. When this is true and no schemaname is provided apply this grant on all future external tables in the given database. The externaltablename and shares fields must be unset in order to use on_future.

Privilege string

The privilege to grant on the current or future external table.

Roles List<string>

Grants privilege to these roles.

SchemaName string

The name of the schema containing the current or future external tables on which to grant privileges.

Shares List<string>

Grants privilege to these shares (only valid if on_future is false).

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 external tables 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.

ExternalTableName string

The name of the external table on which to grant privileges immediately (only valid if on_future is false).

OnFuture bool

When this is set to true and a schemaname is provided, apply this grant on all future external tables in the given schema. When this is true and no schemaname is provided apply this grant on all future external tables in the given database. The externaltablename and shares fields must be unset in order to use on_future.

Privilege string

The privilege to grant on the current or future external table.

Roles []string

Grants privilege to these roles.

SchemaName string

The name of the schema containing the current or future external tables on which to grant privileges.

Shares []string

Grants privilege to these shares (only valid if on_future is false).

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 external tables 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.

externalTableName String

The name of the external table on which to grant privileges immediately (only valid if on_future is false).

onFuture Boolean

When this is set to true and a schemaname is provided, apply this grant on all future external tables in the given schema. When this is true and no schemaname is provided apply this grant on all future external tables in the given database. The externaltablename and shares fields must be unset in order to use on_future.

privilege String

The privilege to grant on the current or future external table.

roles List<String>

Grants privilege to these roles.

schemaName String

The name of the schema containing the current or future external tables on which to grant privileges.

shares List<String>

Grants privilege to these shares (only valid if on_future is false).

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 external tables 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.

externalTableName string

The name of the external table on which to grant privileges immediately (only valid if on_future is false).

onFuture boolean

When this is set to true and a schemaname is provided, apply this grant on all future external tables in the given schema. When this is true and no schemaname is provided apply this grant on all future external tables in the given database. The externaltablename and shares fields must be unset in order to use on_future.

privilege string

The privilege to grant on the current or future external table.

roles string[]

Grants privilege to these roles.

schemaName string

The name of the schema containing the current or future external tables on which to grant privileges.

shares string[]

Grants privilege to these shares (only valid if on_future is false).

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 external tables 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.

external_table_name str

The name of the external table on which to grant privileges immediately (only valid if on_future is false).

on_future bool

When this is set to true and a schemaname is provided, apply this grant on all future external tables in the given schema. When this is true and no schemaname is provided apply this grant on all future external tables in the given database. The externaltablename and shares fields must be unset in order to use on_future.

privilege str

The privilege to grant on the current or future external table.

roles Sequence[str]

Grants privilege to these roles.

schema_name str

The name of the schema containing the current or future external tables on which to grant privileges.

shares Sequence[str]

Grants privilege to these shares (only valid if on_future is false).

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 external tables 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.

externalTableName String

The name of the external table on which to grant privileges immediately (only valid if on_future is false).

onFuture Boolean

When this is set to true and a schemaname is provided, apply this grant on all future external tables in the given schema. When this is true and no schemaname is provided apply this grant on all future external tables in the given database. The externaltablename and shares fields must be unset in order to use on_future.

privilege String

The privilege to grant on the current or future external table.

roles List<String>

Grants privilege to these roles.

schemaName String

The name of the schema containing the current or future external tables on which to grant privileges.

shares List<String>

Grants privilege to these shares (only valid if on_future is false).

withGrantOption Boolean

When this is set to true, allows the recipient role to grant the privileges to other roles.

Package Details

Repository
Snowflake pulumi/pulumi-snowflake
License
Apache-2.0
Notes

This Pulumi package is based on the snowflake Terraform Provider.