Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake Provider
  3. API Docs
  4. MaskingPolicy
Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake

snowflake.MaskingPolicy

Explore with Pulumi AI

Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake

Import

$ pulumi import snowflake:index/maskingPolicy:MaskingPolicy example '"<database_name>"."<schema_name>"."<masking_policy_name>"'
Copy

Create MaskingPolicy Resource

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

Constructor syntax

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

@overload
def MaskingPolicy(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  arguments: Optional[Sequence[MaskingPolicyArgumentArgs]] = None,
                  body: Optional[str] = None,
                  database: Optional[str] = None,
                  return_data_type: Optional[str] = None,
                  schema: Optional[str] = None,
                  comment: Optional[str] = None,
                  exempt_other_policies: Optional[str] = None,
                  name: Optional[str] = None)
func NewMaskingPolicy(ctx *Context, name string, args MaskingPolicyArgs, opts ...ResourceOption) (*MaskingPolicy, error)
public MaskingPolicy(string name, MaskingPolicyArgs args, CustomResourceOptions? opts = null)
public MaskingPolicy(String name, MaskingPolicyArgs args)
public MaskingPolicy(String name, MaskingPolicyArgs args, CustomResourceOptions options)

type: snowflake:MaskingPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MaskingPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. MaskingPolicyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. MaskingPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MaskingPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. MaskingPolicyArgs
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 maskingPolicyResource = new Snowflake.MaskingPolicy("maskingPolicyResource", new()
{
    Arguments = new[]
    {
        new Snowflake.Inputs.MaskingPolicyArgumentArgs
        {
            Name = "string",
            Type = "string",
        },
    },
    Body = "string",
    Database = "string",
    ReturnDataType = "string",
    Schema = "string",
    Comment = "string",
    ExemptOtherPolicies = "string",
    Name = "string",
});
Copy
example, err := snowflake.NewMaskingPolicy(ctx, "maskingPolicyResource", &snowflake.MaskingPolicyArgs{
	Arguments: snowflake.MaskingPolicyArgumentArray{
		&snowflake.MaskingPolicyArgumentArgs{
			Name: pulumi.String("string"),
			Type: pulumi.String("string"),
		},
	},
	Body:                pulumi.String("string"),
	Database:            pulumi.String("string"),
	ReturnDataType:      pulumi.String("string"),
	Schema:              pulumi.String("string"),
	Comment:             pulumi.String("string"),
	ExemptOtherPolicies: pulumi.String("string"),
	Name:                pulumi.String("string"),
})
Copy
var maskingPolicyResource = new MaskingPolicy("maskingPolicyResource", MaskingPolicyArgs.builder()
    .arguments(MaskingPolicyArgumentArgs.builder()
        .name("string")
        .type("string")
        .build())
    .body("string")
    .database("string")
    .returnDataType("string")
    .schema("string")
    .comment("string")
    .exemptOtherPolicies("string")
    .name("string")
    .build());
Copy
masking_policy_resource = snowflake.MaskingPolicy("maskingPolicyResource",
    arguments=[{
        "name": "string",
        "type": "string",
    }],
    body="string",
    database="string",
    return_data_type="string",
    schema="string",
    comment="string",
    exempt_other_policies="string",
    name="string")
Copy
const maskingPolicyResource = new snowflake.MaskingPolicy("maskingPolicyResource", {
    arguments: [{
        name: "string",
        type: "string",
    }],
    body: "string",
    database: "string",
    returnDataType: "string",
    schema: "string",
    comment: "string",
    exemptOtherPolicies: "string",
    name: "string",
});
Copy
type: snowflake:MaskingPolicy
properties:
    arguments:
        - name: string
          type: string
    body: string
    comment: string
    database: string
    exemptOtherPolicies: string
    name: string
    returnDataType: string
    schema: string
Copy

MaskingPolicy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The MaskingPolicy resource accepts the following input properties:

Arguments
This property is required.
Changes to this property will trigger replacement.
List<MaskingPolicyArgument>
List of the arguments for the masking policy. The first column and its data type always indicate the column data type values to mask or tokenize in the subsequent policy conditions. Note that you can not specify a virtual column as the first column argument in a conditional masking policy.
Body This property is required. string
Specifies the SQL expression that transforms the data. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
Database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ReturnDataType
This property is required.
Changes to this property will trigger replacement.
string
The return data type must match the input data type of the first column that is specified as an input column. For more information about data types, check Snowflake docs.
Schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Comment string
Specifies a comment for the masking policy.
ExemptOtherPolicies Changes to this property will trigger replacement. string
Specifies whether the row access policy or conditional masking policy can reference a column that is already protected by a masking policy. Due to Snowflake limitations, when value is changed, the resource is recreated. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
Name string
Specifies the identifier for the masking policy; must be unique for the database and schema in which the masking policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Arguments
This property is required.
Changes to this property will trigger replacement.
[]MaskingPolicyArgumentArgs
List of the arguments for the masking policy. The first column and its data type always indicate the column data type values to mask or tokenize in the subsequent policy conditions. Note that you can not specify a virtual column as the first column argument in a conditional masking policy.
Body This property is required. string
Specifies the SQL expression that transforms the data. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
Database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ReturnDataType
This property is required.
Changes to this property will trigger replacement.
string
The return data type must match the input data type of the first column that is specified as an input column. For more information about data types, check Snowflake docs.
Schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Comment string
Specifies a comment for the masking policy.
ExemptOtherPolicies Changes to this property will trigger replacement. string
Specifies whether the row access policy or conditional masking policy can reference a column that is already protected by a masking policy. Due to Snowflake limitations, when value is changed, the resource is recreated. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
Name string
Specifies the identifier for the masking policy; must be unique for the database and schema in which the masking policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
arguments
This property is required.
Changes to this property will trigger replacement.
List<MaskingPolicyArgument>
List of the arguments for the masking policy. The first column and its data type always indicate the column data type values to mask or tokenize in the subsequent policy conditions. Note that you can not specify a virtual column as the first column argument in a conditional masking policy.
body This property is required. String
Specifies the SQL expression that transforms the data. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
database
This property is required.
Changes to this property will trigger replacement.
String
The database in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
returnDataType
This property is required.
Changes to this property will trigger replacement.
String
The return data type must match the input data type of the first column that is specified as an input column. For more information about data types, check Snowflake docs.
schema
This property is required.
Changes to this property will trigger replacement.
String
The schema in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
comment String
Specifies a comment for the masking policy.
exemptOtherPolicies Changes to this property will trigger replacement. String
Specifies whether the row access policy or conditional masking policy can reference a column that is already protected by a masking policy. Due to Snowflake limitations, when value is changed, the resource is recreated. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
name String
Specifies the identifier for the masking policy; must be unique for the database and schema in which the masking policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
arguments
This property is required.
Changes to this property will trigger replacement.
MaskingPolicyArgument[]
List of the arguments for the masking policy. The first column and its data type always indicate the column data type values to mask or tokenize in the subsequent policy conditions. Note that you can not specify a virtual column as the first column argument in a conditional masking policy.
body This property is required. string
Specifies the SQL expression that transforms the data. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
returnDataType
This property is required.
Changes to this property will trigger replacement.
string
The return data type must match the input data type of the first column that is specified as an input column. For more information about data types, check Snowflake docs.
schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
comment string
Specifies a comment for the masking policy.
exemptOtherPolicies Changes to this property will trigger replacement. string
Specifies whether the row access policy or conditional masking policy can reference a column that is already protected by a masking policy. Due to Snowflake limitations, when value is changed, the resource is recreated. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
name string
Specifies the identifier for the masking policy; must be unique for the database and schema in which the masking policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
arguments
This property is required.
Changes to this property will trigger replacement.
Sequence[MaskingPolicyArgumentArgs]
List of the arguments for the masking policy. The first column and its data type always indicate the column data type values to mask or tokenize in the subsequent policy conditions. Note that you can not specify a virtual column as the first column argument in a conditional masking policy.
body This property is required. str
Specifies the SQL expression that transforms the data. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
database
This property is required.
Changes to this property will trigger replacement.
str
The database in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
return_data_type
This property is required.
Changes to this property will trigger replacement.
str
The return data type must match the input data type of the first column that is specified as an input column. For more information about data types, check Snowflake docs.
schema
This property is required.
Changes to this property will trigger replacement.
str
The schema in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
comment str
Specifies a comment for the masking policy.
exempt_other_policies Changes to this property will trigger replacement. str
Specifies whether the row access policy or conditional masking policy can reference a column that is already protected by a masking policy. Due to Snowflake limitations, when value is changed, the resource is recreated. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
name str
Specifies the identifier for the masking policy; must be unique for the database and schema in which the masking policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
arguments
This property is required.
Changes to this property will trigger replacement.
List<Property Map>
List of the arguments for the masking policy. The first column and its data type always indicate the column data type values to mask or tokenize in the subsequent policy conditions. Note that you can not specify a virtual column as the first column argument in a conditional masking policy.
body This property is required. String
Specifies the SQL expression that transforms the data. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
database
This property is required.
Changes to this property will trigger replacement.
String
The database in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
returnDataType
This property is required.
Changes to this property will trigger replacement.
String
The return data type must match the input data type of the first column that is specified as an input column. For more information about data types, check Snowflake docs.
schema
This property is required.
Changes to this property will trigger replacement.
String
The schema in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
comment String
Specifies a comment for the masking policy.
exemptOtherPolicies Changes to this property will trigger replacement. String
Specifies whether the row access policy or conditional masking policy can reference a column that is already protected by a masking policy. Due to Snowflake limitations, when value is changed, the resource is recreated. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
name String
Specifies the identifier for the masking policy; must be unique for the database and schema in which the masking policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

Outputs

All input properties are implicitly available as output properties. Additionally, the MaskingPolicy resource produces the following output properties:

DescribeOutputs List<MaskingPolicyDescribeOutput>
Outputs the result of DESCRIBE MASKING POLICY for the given masking policy.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Id string
The provider-assigned unique ID for this managed resource.
ShowOutputs List<MaskingPolicyShowOutput>
Outputs the result of SHOW MASKING POLICIES for the given masking policy.
DescribeOutputs []MaskingPolicyDescribeOutput
Outputs the result of DESCRIBE MASKING POLICY for the given masking policy.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Id string
The provider-assigned unique ID for this managed resource.
ShowOutputs []MaskingPolicyShowOutput
Outputs the result of SHOW MASKING POLICIES for the given masking policy.
describeOutputs List<MaskingPolicyDescribeOutput>
Outputs the result of DESCRIBE MASKING POLICY for the given masking policy.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
id String
The provider-assigned unique ID for this managed resource.
showOutputs List<MaskingPolicyShowOutput>
Outputs the result of SHOW MASKING POLICIES for the given masking policy.
describeOutputs MaskingPolicyDescribeOutput[]
Outputs the result of DESCRIBE MASKING POLICY for the given masking policy.
fullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
id string
The provider-assigned unique ID for this managed resource.
showOutputs MaskingPolicyShowOutput[]
Outputs the result of SHOW MASKING POLICIES for the given masking policy.
describe_outputs Sequence[MaskingPolicyDescribeOutput]
Outputs the result of DESCRIBE MASKING POLICY for the given masking policy.
fully_qualified_name str
Fully qualified name of the resource. For more information, see object name resolution.
id str
The provider-assigned unique ID for this managed resource.
show_outputs Sequence[MaskingPolicyShowOutput]
Outputs the result of SHOW MASKING POLICIES for the given masking policy.
describeOutputs List<Property Map>
Outputs the result of DESCRIBE MASKING POLICY for the given masking policy.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
id String
The provider-assigned unique ID for this managed resource.
showOutputs List<Property Map>
Outputs the result of SHOW MASKING POLICIES for the given masking policy.

Look up Existing MaskingPolicy Resource

Get an existing MaskingPolicy 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?: MaskingPolicyState, opts?: CustomResourceOptions): MaskingPolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arguments: Optional[Sequence[MaskingPolicyArgumentArgs]] = None,
        body: Optional[str] = None,
        comment: Optional[str] = None,
        database: Optional[str] = None,
        describe_outputs: Optional[Sequence[MaskingPolicyDescribeOutputArgs]] = None,
        exempt_other_policies: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        return_data_type: Optional[str] = None,
        schema: Optional[str] = None,
        show_outputs: Optional[Sequence[MaskingPolicyShowOutputArgs]] = None) -> MaskingPolicy
func GetMaskingPolicy(ctx *Context, name string, id IDInput, state *MaskingPolicyState, opts ...ResourceOption) (*MaskingPolicy, error)
public static MaskingPolicy Get(string name, Input<string> id, MaskingPolicyState? state, CustomResourceOptions? opts = null)
public static MaskingPolicy get(String name, Output<String> id, MaskingPolicyState state, CustomResourceOptions options)
resources:  _:    type: snowflake:MaskingPolicy    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Arguments Changes to this property will trigger replacement. List<MaskingPolicyArgument>
List of the arguments for the masking policy. The first column and its data type always indicate the column data type values to mask or tokenize in the subsequent policy conditions. Note that you can not specify a virtual column as the first column argument in a conditional masking policy.
Body string
Specifies the SQL expression that transforms the data. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
Comment string
Specifies a comment for the masking policy.
Database Changes to this property will trigger replacement. string
The database in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
DescribeOutputs List<MaskingPolicyDescribeOutput>
Outputs the result of DESCRIBE MASKING POLICY for the given masking policy.
ExemptOtherPolicies Changes to this property will trigger replacement. string
Specifies whether the row access policy or conditional masking policy can reference a column that is already protected by a masking policy. Due to Snowflake limitations, when value is changed, the resource is recreated. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Name string
Specifies the identifier for the masking policy; must be unique for the database and schema in which the masking policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ReturnDataType Changes to this property will trigger replacement. string
The return data type must match the input data type of the first column that is specified as an input column. For more information about data types, check Snowflake docs.
Schema Changes to this property will trigger replacement. string
The schema in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ShowOutputs List<MaskingPolicyShowOutput>
Outputs the result of SHOW MASKING POLICIES for the given masking policy.
Arguments Changes to this property will trigger replacement. []MaskingPolicyArgumentArgs
List of the arguments for the masking policy. The first column and its data type always indicate the column data type values to mask or tokenize in the subsequent policy conditions. Note that you can not specify a virtual column as the first column argument in a conditional masking policy.
Body string
Specifies the SQL expression that transforms the data. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
Comment string
Specifies a comment for the masking policy.
Database Changes to this property will trigger replacement. string
The database in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
DescribeOutputs []MaskingPolicyDescribeOutputArgs
Outputs the result of DESCRIBE MASKING POLICY for the given masking policy.
ExemptOtherPolicies Changes to this property will trigger replacement. string
Specifies whether the row access policy or conditional masking policy can reference a column that is already protected by a masking policy. Due to Snowflake limitations, when value is changed, the resource is recreated. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Name string
Specifies the identifier for the masking policy; must be unique for the database and schema in which the masking policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ReturnDataType Changes to this property will trigger replacement. string
The return data type must match the input data type of the first column that is specified as an input column. For more information about data types, check Snowflake docs.
Schema Changes to this property will trigger replacement. string
The schema in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ShowOutputs []MaskingPolicyShowOutputArgs
Outputs the result of SHOW MASKING POLICIES for the given masking policy.
arguments Changes to this property will trigger replacement. List<MaskingPolicyArgument>
List of the arguments for the masking policy. The first column and its data type always indicate the column data type values to mask or tokenize in the subsequent policy conditions. Note that you can not specify a virtual column as the first column argument in a conditional masking policy.
body String
Specifies the SQL expression that transforms the data. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
comment String
Specifies a comment for the masking policy.
database Changes to this property will trigger replacement. String
The database in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
describeOutputs List<MaskingPolicyDescribeOutput>
Outputs the result of DESCRIBE MASKING POLICY for the given masking policy.
exemptOtherPolicies Changes to this property will trigger replacement. String
Specifies whether the row access policy or conditional masking policy can reference a column that is already protected by a masking policy. Due to Snowflake limitations, when value is changed, the resource is recreated. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
name String
Specifies the identifier for the masking policy; must be unique for the database and schema in which the masking policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
returnDataType Changes to this property will trigger replacement. String
The return data type must match the input data type of the first column that is specified as an input column. For more information about data types, check Snowflake docs.
schema Changes to this property will trigger replacement. String
The schema in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showOutputs List<MaskingPolicyShowOutput>
Outputs the result of SHOW MASKING POLICIES for the given masking policy.
arguments Changes to this property will trigger replacement. MaskingPolicyArgument[]
List of the arguments for the masking policy. The first column and its data type always indicate the column data type values to mask or tokenize in the subsequent policy conditions. Note that you can not specify a virtual column as the first column argument in a conditional masking policy.
body string
Specifies the SQL expression that transforms the data. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
comment string
Specifies a comment for the masking policy.
database Changes to this property will trigger replacement. string
The database in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
describeOutputs MaskingPolicyDescribeOutput[]
Outputs the result of DESCRIBE MASKING POLICY for the given masking policy.
exemptOtherPolicies Changes to this property will trigger replacement. string
Specifies whether the row access policy or conditional masking policy can reference a column that is already protected by a masking policy. Due to Snowflake limitations, when value is changed, the resource is recreated. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
fullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
name string
Specifies the identifier for the masking policy; must be unique for the database and schema in which the masking policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
returnDataType Changes to this property will trigger replacement. string
The return data type must match the input data type of the first column that is specified as an input column. For more information about data types, check Snowflake docs.
schema Changes to this property will trigger replacement. string
The schema in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showOutputs MaskingPolicyShowOutput[]
Outputs the result of SHOW MASKING POLICIES for the given masking policy.
arguments Changes to this property will trigger replacement. Sequence[MaskingPolicyArgumentArgs]
List of the arguments for the masking policy. The first column and its data type always indicate the column data type values to mask or tokenize in the subsequent policy conditions. Note that you can not specify a virtual column as the first column argument in a conditional masking policy.
body str
Specifies the SQL expression that transforms the data. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
comment str
Specifies a comment for the masking policy.
database Changes to this property will trigger replacement. str
The database in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
describe_outputs Sequence[MaskingPolicyDescribeOutputArgs]
Outputs the result of DESCRIBE MASKING POLICY for the given masking policy.
exempt_other_policies Changes to this property will trigger replacement. str
Specifies whether the row access policy or conditional masking policy can reference a column that is already protected by a masking policy. Due to Snowflake limitations, when value is changed, the resource is recreated. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
fully_qualified_name str
Fully qualified name of the resource. For more information, see object name resolution.
name str
Specifies the identifier for the masking policy; must be unique for the database and schema in which the masking policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
return_data_type Changes to this property will trigger replacement. str
The return data type must match the input data type of the first column that is specified as an input column. For more information about data types, check Snowflake docs.
schema Changes to this property will trigger replacement. str
The schema in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
show_outputs Sequence[MaskingPolicyShowOutputArgs]
Outputs the result of SHOW MASKING POLICIES for the given masking policy.
arguments Changes to this property will trigger replacement. List<Property Map>
List of the arguments for the masking policy. The first column and its data type always indicate the column data type values to mask or tokenize in the subsequent policy conditions. Note that you can not specify a virtual column as the first column argument in a conditional masking policy.
body String
Specifies the SQL expression that transforms the data. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
comment String
Specifies a comment for the masking policy.
database Changes to this property will trigger replacement. String
The database in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
describeOutputs List<Property Map>
Outputs the result of DESCRIBE MASKING POLICY for the given masking policy.
exemptOtherPolicies Changes to this property will trigger replacement. String
Specifies whether the row access policy or conditional masking policy can reference a column that is already protected by a masking policy. Due to Snowflake limitations, when value is changed, the resource is recreated. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
name String
Specifies the identifier for the masking policy; must be unique for the database and schema in which the masking policy is created. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
returnDataType Changes to this property will trigger replacement. String
The return data type must match the input data type of the first column that is specified as an input column. For more information about data types, check Snowflake docs.
schema Changes to this property will trigger replacement. String
The schema in which to create the masking policy. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showOutputs List<Property Map>
Outputs the result of SHOW MASKING POLICIES for the given masking policy.

Supporting Types

MaskingPolicyArgument
, MaskingPolicyArgumentArgs

Name
This property is required.
Changes to this property will trigger replacement.
string
The argument name
Type
This property is required.
Changes to this property will trigger replacement.
string
The argument type. VECTOR data types are not yet supported. For more information about data types, check Snowflake docs.
Name
This property is required.
Changes to this property will trigger replacement.
string
The argument name
Type
This property is required.
Changes to this property will trigger replacement.
string
The argument type. VECTOR data types are not yet supported. For more information about data types, check Snowflake docs.
name
This property is required.
Changes to this property will trigger replacement.
String
The argument name
type
This property is required.
Changes to this property will trigger replacement.
String
The argument type. VECTOR data types are not yet supported. For more information about data types, check Snowflake docs.
name
This property is required.
Changes to this property will trigger replacement.
string
The argument name
type
This property is required.
Changes to this property will trigger replacement.
string
The argument type. VECTOR data types are not yet supported. For more information about data types, check Snowflake docs.
name
This property is required.
Changes to this property will trigger replacement.
str
The argument name
type
This property is required.
Changes to this property will trigger replacement.
str
The argument type. VECTOR data types are not yet supported. For more information about data types, check Snowflake docs.
name
This property is required.
Changes to this property will trigger replacement.
String
The argument name
type
This property is required.
Changes to this property will trigger replacement.
String
The argument type. VECTOR data types are not yet supported. For more information about data types, check Snowflake docs.

MaskingPolicyDescribeOutput
, MaskingPolicyDescribeOutputArgs

MaskingPolicyDescribeOutputSignature
, MaskingPolicyDescribeOutputSignatureArgs

Name string
Type string
Name string
Type string
name String
type String
name string
type string
name str
type str
name String
type String

MaskingPolicyShowOutput
, MaskingPolicyShowOutputArgs

Comment string
CreatedOn string
DatabaseName string
ExemptOtherPolicies bool
Kind string
Name string
Owner string
OwnerRoleType string
SchemaName string
Comment string
CreatedOn string
DatabaseName string
ExemptOtherPolicies bool
Kind string
Name string
Owner string
OwnerRoleType string
SchemaName string
comment String
createdOn String
databaseName String
exemptOtherPolicies Boolean
kind String
name String
owner String
ownerRoleType String
schemaName String
comment string
createdOn string
databaseName string
exemptOtherPolicies boolean
kind string
name string
owner string
ownerRoleType string
schemaName string
comment String
createdOn String
databaseName String
exemptOtherPolicies Boolean
kind String
name String
owner String
ownerRoleType String
schemaName String

Package Details

Repository
Snowflake pulumi/pulumi-snowflake
License
Apache-2.0
Notes
This Pulumi package is based on the snowflake Terraform Provider.
Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake