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

snowflake.MaskingPolicyGrant

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 example = new snowflake.MaskingPolicyGrant("example", {
    maskingPolicyName: "EXAMPLE_MASKING_POLICY_NAME",
    databaseName: "EXAMPLE_DB_NAME",
    schemaName: "EXAMPLE_SCHEMA_NAME",
    privilege: "APPLY",
    roles: [
        "ROLE1_NAME",
        "ROLE2_NAME",
    ],
    withGrantOption: true,
    enableMultipleGrants: true,
});

    import pulumi
import pulumi_snowflake as snowflake

example = snowflake.MaskingPolicyGrant("example",
    masking_policy_name="EXAMPLE_MASKING_POLICY_NAME",
    database_name="EXAMPLE_DB_NAME",
    schema_name="EXAMPLE_SCHEMA_NAME",
    privilege="APPLY",
    roles=[
        "ROLE1_NAME",
        "ROLE2_NAME",
    ],
    with_grant_option=True,
    enable_multiple_grants=True)

    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.NewMaskingPolicyGrant(ctx, "example", &snowflake.MaskingPolicyGrantArgs{
			MaskingPolicyName: pulumi.String("EXAMPLE_MASKING_POLICY_NAME"),
			DatabaseName:      pulumi.String("EXAMPLE_DB_NAME"),
			SchemaName:        pulumi.String("EXAMPLE_SCHEMA_NAME"),
			Privilege:         pulumi.String("APPLY"),
			Roles: pulumi.StringArray{
				pulumi.String("ROLE1_NAME"),
				pulumi.String("ROLE2_NAME"),
			},
			WithGrantOption:      pulumi.Bool(true),
			EnableMultipleGrants: pulumi.Bool(true),
		})
		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 example = new Snowflake.MaskingPolicyGrant("example", new()
    {
        MaskingPolicyName = "EXAMPLE_MASKING_POLICY_NAME",
        DatabaseName = "EXAMPLE_DB_NAME",
        SchemaName = "EXAMPLE_SCHEMA_NAME",
        Privilege = "APPLY",
        Roles = new[]
        {
            "ROLE1_NAME",
            "ROLE2_NAME",
        },
        WithGrantOption = true,
        EnableMultipleGrants = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.MaskingPolicyGrant;
import com.pulumi.snowflake.MaskingPolicyGrantArgs;
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 example = new MaskingPolicyGrant("example", MaskingPolicyGrantArgs.builder()
            .maskingPolicyName("EXAMPLE_MASKING_POLICY_NAME")
            .databaseName("EXAMPLE_DB_NAME")
            .schemaName("EXAMPLE_SCHEMA_NAME")
            .privilege("APPLY")
            .roles(            
                "ROLE1_NAME",
                "ROLE2_NAME")
            .withGrantOption(true)
            .enableMultipleGrants(true)
            .build());

    }
}

    resources:
  example:
    type: snowflake:MaskingPolicyGrant
    properties:
      maskingPolicyName: EXAMPLE_MASKING_POLICY_NAME
      databaseName: EXAMPLE_DB_NAME
      schemaName: EXAMPLE_SCHEMA_NAME
      privilege: APPLY
      roles:
        - ROLE1_NAME
        - ROLE2_NAME
      withGrantOption: true
      enableMultipleGrants: true

    Create MaskingPolicyGrant Resource

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

    Constructor syntax

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

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

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

    example, err := snowflake.NewMaskingPolicyGrant(ctx, "maskingPolicyGrantResource", &snowflake.MaskingPolicyGrantArgs{
	DatabaseName:              pulumi.String("string"),
	MaskingPolicyName:         pulumi.String("string"),
	SchemaName:                pulumi.String("string"),
	EnableMultipleGrants:      pulumi.Bool(false),
	Privilege:                 pulumi.String("string"),
	RevertOwnershipToRoleName: pulumi.String("string"),
	Roles: pulumi.StringArray{
		pulumi.String("string"),
	},
	WithGrantOption: pulumi.Bool(false),
})

    var maskingPolicyGrantResource = new MaskingPolicyGrant("maskingPolicyGrantResource", MaskingPolicyGrantArgs.builder()
    .databaseName("string")
    .maskingPolicyName("string")
    .schemaName("string")
    .enableMultipleGrants(false)
    .privilege("string")
    .revertOwnershipToRoleName("string")
    .roles("string")
    .withGrantOption(false)
    .build());

    masking_policy_grant_resource = snowflake.MaskingPolicyGrant("maskingPolicyGrantResource",
    database_name="string",
    masking_policy_name="string",
    schema_name="string",
    enable_multiple_grants=False,
    privilege="string",
    revert_ownership_to_role_name="string",
    roles=["string"],
    with_grant_option=False)

    const maskingPolicyGrantResource = new snowflake.MaskingPolicyGrant("maskingPolicyGrantResource", {
    databaseName: "string",
    maskingPolicyName: "string",
    schemaName: "string",
    enableMultipleGrants: false,
    privilege: "string",
    revertOwnershipToRoleName: "string",
    roles: ["string"],
    withGrantOption: false,
});

    type: snowflake:MaskingPolicyGrant
properties:
    databaseName: string
    enableMultipleGrants: false
    maskingPolicyName: string
    privilege: string
    revertOwnershipToRoleName: string
    roles:
        - string
    schemaName: string
    withGrantOption: false

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

    DatabaseName string
    The name of the database containing the masking policy on which to grant privileges.
    MaskingPolicyName string
    The name of the masking policy on which to grant privileges immediately.
    SchemaName string
    The name of the schema containing the masking policy on which to grant privileges.
    EnableMultipleGrants bool
    Privilege string
    The privilege to grant on the masking policy. 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.
    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 masking policy on which to grant privileges.
    MaskingPolicyName string
    The name of the masking policy on which to grant privileges immediately.
    SchemaName string
    The name of the schema containing the masking policy on which to grant privileges.
    EnableMultipleGrants bool
    Privilege string
    The privilege to grant on the masking policy. 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.
    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 masking policy on which to grant privileges.
    maskingPolicyName String
    The name of the masking policy on which to grant privileges immediately.
    schemaName String
    The name of the schema containing the masking policy on which to grant privileges.
    enableMultipleGrants Boolean
    privilege String
    The privilege to grant on the masking policy. 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.
    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 masking policy on which to grant privileges.
    maskingPolicyName string
    The name of the masking policy on which to grant privileges immediately.
    schemaName string
    The name of the schema containing the masking policy on which to grant privileges.
    enableMultipleGrants boolean
    privilege string
    The privilege to grant on the masking policy. 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.
    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 masking policy on which to grant privileges.
    masking_policy_name str
    The name of the masking policy on which to grant privileges immediately.
    schema_name str
    The name of the schema containing the masking policy on which to grant privileges.
    enable_multiple_grants bool
    privilege str
    The privilege to grant on the masking policy. 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.
    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 masking policy on which to grant privileges.
    maskingPolicyName String
    The name of the masking policy on which to grant privileges immediately.
    schemaName String
    The name of the schema containing the masking policy on which to grant privileges.
    enableMultipleGrants Boolean
    privilege String
    The privilege to grant on the masking policy. 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.
    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 MaskingPolicyGrant 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 MaskingPolicyGrant Resource

    Get an existing MaskingPolicyGrant 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?: MaskingPolicyGrantState, opts?: CustomResourceOptions): MaskingPolicyGrant
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        database_name: Optional[str] = None,
        enable_multiple_grants: Optional[bool] = None,
        masking_policy_name: Optional[str] = None,
        privilege: Optional[str] = None,
        revert_ownership_to_role_name: Optional[str] = None,
        roles: Optional[Sequence[str]] = None,
        schema_name: Optional[str] = None,
        with_grant_option: Optional[bool] = None) -> MaskingPolicyGrant
    func GetMaskingPolicyGrant(ctx *Context, name string, id IDInput, state *MaskingPolicyGrantState, opts ...ResourceOption) (*MaskingPolicyGrant, error)
    public static MaskingPolicyGrant Get(string name, Input<string> id, MaskingPolicyGrantState? state, CustomResourceOptions? opts = null)
    public static MaskingPolicyGrant get(String name, Output<String> id, MaskingPolicyGrantState 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 masking policy on which to grant privileges.
    EnableMultipleGrants bool
    MaskingPolicyName string
    The name of the masking policy on which to grant privileges immediately.
    Privilege string
    The privilege to grant on the masking policy. To grant all privileges, use the value ALL PRIVILEGES
    RevertOwnershipToRoleName string
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    Roles List<string>
    Grants privilege to these roles.
    SchemaName string
    The name of the schema containing the masking policy on which to grant privileges.
    WithGrantOption bool
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    DatabaseName string
    The name of the database containing the masking policy on which to grant privileges.
    EnableMultipleGrants bool
    MaskingPolicyName string
    The name of the masking policy on which to grant privileges immediately.
    Privilege string
    The privilege to grant on the masking policy. To grant all privileges, use the value ALL PRIVILEGES
    RevertOwnershipToRoleName string
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    Roles []string
    Grants privilege to these roles.
    SchemaName string
    The name of the schema containing the masking policy on which to grant privileges.
    WithGrantOption bool
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    databaseName String
    The name of the database containing the masking policy on which to grant privileges.
    enableMultipleGrants Boolean
    maskingPolicyName String
    The name of the masking policy on which to grant privileges immediately.
    privilege String
    The privilege to grant on the masking policy. To grant all privileges, use the value ALL PRIVILEGES
    revertOwnershipToRoleName String
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    roles List<String>
    Grants privilege to these roles.
    schemaName String
    The name of the schema containing the masking policy on which to grant privileges.
    withGrantOption Boolean
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    databaseName string
    The name of the database containing the masking policy on which to grant privileges.
    enableMultipleGrants boolean
    maskingPolicyName string
    The name of the masking policy on which to grant privileges immediately.
    privilege string
    The privilege to grant on the masking policy. To grant all privileges, use the value ALL PRIVILEGES
    revertOwnershipToRoleName string
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    roles string[]
    Grants privilege to these roles.
    schemaName string
    The name of the schema containing the masking policy on which to grant privileges.
    withGrantOption boolean
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    database_name str
    The name of the database containing the masking policy on which to grant privileges.
    enable_multiple_grants bool
    masking_policy_name str
    The name of the masking policy on which to grant privileges immediately.
    privilege str
    The privilege to grant on the masking policy. To grant all privileges, use the value ALL PRIVILEGES
    revert_ownership_to_role_name str
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    roles Sequence[str]
    Grants privilege to these roles.
    schema_name str
    The name of the schema containing the masking policy on which to grant privileges.
    with_grant_option bool
    When this is set to true, allows the recipient role to grant the privileges to other roles.
    databaseName String
    The name of the database containing the masking policy on which to grant privileges.
    enableMultipleGrants Boolean
    maskingPolicyName String
    The name of the masking policy on which to grant privileges immediately.
    privilege String
    The privilege to grant on the masking policy. To grant all privileges, use the value ALL PRIVILEGES
    revertOwnershipToRoleName String
    The name of the role to revert ownership to on destroy. Has no effect unless privilege is set to OWNERSHIP
    roles List<String>
    Grants privilege to these roles.
    schemaName String
    The name of the schema containing the masking policy on which to grant privileges.
    withGrantOption Boolean
    When this is set to true, allows the recipient role to grant the privileges to other roles.

    Import

    format is database_name|schema_name|masking_policy_name|privilege|with_grant_option|roles

    $ pulumi import snowflake:index/maskingPolicyGrant:MaskingPolicyGrant example "dbName|schemaName|maskingPolicyName|USAGE|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