snowflake.getMaskingPolicies

Explore with Pulumi AI

Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi

!> V1 release candidate This data source was reworked and is a release candidate for the V1. We do not expect significant changes in it before the V1. We will welcome any feedback and adjust the data source if needed. Any errors reported will be resolved with a higher priority. We encourage checking this data source out before the V1 release. Please follow the migration guide to use it.

Datasource used to get details of filtered masking policies. Filtering is aligned with the current possibilities for SHOW MASKING POLICIES query. The results of SHOW and DESCRIBE are encapsulated in one output collection masking_policies.

Using getMaskingPolicies

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMaskingPolicies(args: GetMaskingPoliciesArgs, opts?: InvokeOptions): Promise<GetMaskingPoliciesResult>
function getMaskingPoliciesOutput(args: GetMaskingPoliciesOutputArgs, opts?: InvokeOptions): Output<GetMaskingPoliciesResult>

def get_masking_policies(in_: Optional[GetMaskingPoliciesIn] = None,
                         like: Optional[str] = None,
                         limit: Optional[GetMaskingPoliciesLimit] = None,
                         with_describe: Optional[bool] = None,
                         opts: Optional[InvokeOptions] = None) -> GetMaskingPoliciesResult
def get_masking_policies_output(in_: Optional[pulumi.Input[GetMaskingPoliciesInArgs]] = None,
                         like: Optional[pulumi.Input[str]] = None,
                         limit: Optional[pulumi.Input[GetMaskingPoliciesLimitArgs]] = None,
                         with_describe: Optional[pulumi.Input[bool]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetMaskingPoliciesResult]

func GetMaskingPolicies(ctx *Context, args *GetMaskingPoliciesArgs, opts ...InvokeOption) (*GetMaskingPoliciesResult, error)
func GetMaskingPoliciesOutput(ctx *Context, args *GetMaskingPoliciesOutputArgs, opts ...InvokeOption) GetMaskingPoliciesResultOutput

> Note: This function is named GetMaskingPolicies in the Go SDK.

public static class GetMaskingPolicies 
{
    public static Task<GetMaskingPoliciesResult> InvokeAsync(GetMaskingPoliciesArgs args, InvokeOptions? opts = null)
    public static Output<GetMaskingPoliciesResult> Invoke(GetMaskingPoliciesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetMaskingPoliciesResult> getMaskingPolicies(GetMaskingPoliciesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: snowflake:index/getMaskingPolicies:getMaskingPolicies
  arguments:
    # arguments dictionary

The following arguments are supported:

In GetMaskingPoliciesIn: IN clause to filter the list of masking policies
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetMaskingPoliciesLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
WithDescribe bool: Runs DESC MASKING POLICY for each masking policy returned by SHOW MASKING POLICIES. The output of describe is saved to the description field. By default this value is set to true.

In GetMaskingPoliciesIn: IN clause to filter the list of masking policies
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetMaskingPoliciesLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
WithDescribe bool: Runs DESC MASKING POLICY for each masking policy returned by SHOW MASKING POLICIES. The output of describe is saved to the description field. By default this value is set to true.

in GetMaskingPoliciesIn: IN clause to filter the list of masking policies
like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetMaskingPoliciesLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
withDescribe Boolean: Runs DESC MASKING POLICY for each masking policy returned by SHOW MASKING POLICIES. The output of describe is saved to the description field. By default this value is set to true.

in GetMaskingPoliciesIn: IN clause to filter the list of masking policies
like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetMaskingPoliciesLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
withDescribe boolean: Runs DESC MASKING POLICY for each masking policy returned by SHOW MASKING POLICIES. The output of describe is saved to the description field. By default this value is set to true.

in_ GetMaskingPoliciesIn: IN clause to filter the list of masking policies
like str: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetMaskingPoliciesLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
with_describe bool: Runs DESC MASKING POLICY for each masking policy returned by SHOW MASKING POLICIES. The output of describe is saved to the description field. By default this value is set to true.

in Property Map: IN clause to filter the list of masking policies
like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit Property Map: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
withDescribe Boolean: Runs DESC MASKING POLICY for each masking policy returned by SHOW MASKING POLICIES. The output of describe is saved to the description field. By default this value is set to true.

getMaskingPolicies Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
MaskingPolicies List<GetMaskingPoliciesMaskingPolicy>: Holds the aggregated output of all views details queries.
In GetMaskingPoliciesIn: IN clause to filter the list of masking policies
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetMaskingPoliciesLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
WithDescribe bool: Runs DESC MASKING POLICY for each masking policy returned by SHOW MASKING POLICIES. The output of describe is saved to the description field. By default this value is set to true.

Id string: The provider-assigned unique ID for this managed resource.
MaskingPolicies []GetMaskingPoliciesMaskingPolicy: Holds the aggregated output of all views details queries.
In GetMaskingPoliciesIn: IN clause to filter the list of masking policies
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetMaskingPoliciesLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
WithDescribe bool: Runs DESC MASKING POLICY for each masking policy returned by SHOW MASKING POLICIES. The output of describe is saved to the description field. By default this value is set to true.

id String: The provider-assigned unique ID for this managed resource.
maskingPolicies List<GetMaskingPoliciesMaskingPolicy>: Holds the aggregated output of all views details queries.
in GetMaskingPoliciesIn: IN clause to filter the list of masking policies
like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetMaskingPoliciesLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
withDescribe Boolean: Runs DESC MASKING POLICY for each masking policy returned by SHOW MASKING POLICIES. The output of describe is saved to the description field. By default this value is set to true.

id string: The provider-assigned unique ID for this managed resource.
maskingPolicies GetMaskingPoliciesMaskingPolicy[]: Holds the aggregated output of all views details queries.
in GetMaskingPoliciesIn: IN clause to filter the list of masking policies
like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetMaskingPoliciesLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
withDescribe boolean: Runs DESC MASKING POLICY for each masking policy returned by SHOW MASKING POLICIES. The output of describe is saved to the description field. By default this value is set to true.

id str: The provider-assigned unique ID for this managed resource.
masking_policies Sequence[GetMaskingPoliciesMaskingPolicy]: Holds the aggregated output of all views details queries.
in_ GetMaskingPoliciesIn: IN clause to filter the list of masking policies
like str: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetMaskingPoliciesLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
with_describe bool: Runs DESC MASKING POLICY for each masking policy returned by SHOW MASKING POLICIES. The output of describe is saved to the description field. By default this value is set to true.

id String: The provider-assigned unique ID for this managed resource.
maskingPolicies List<Property Map>: Holds the aggregated output of all views details queries.
in Property Map: IN clause to filter the list of masking policies
like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit Property Map: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
withDescribe Boolean: Runs DESC MASKING POLICY for each masking policy returned by SHOW MASKING POLICIES. The output of describe is saved to the description field. By default this value is set to true.

Supporting Types

GetMaskingPoliciesIn

Account bool: Returns records for the entire account.
Application string: Returns records for the specified application.
ApplicationPackage string: Returns records for the specified application package.
Database string: Returns records for the current database in use or for a specified database.
Schema string: Returns records for the current schema in use or a specified schema. Use fully qualified name.

Account bool: Returns records for the entire account.
Application string: Returns records for the specified application.
ApplicationPackage string: Returns records for the specified application package.
Database string: Returns records for the current database in use or for a specified database.
Schema string: Returns records for the current schema in use or a specified schema. Use fully qualified name.

account Boolean: Returns records for the entire account.
application String: Returns records for the specified application.
applicationPackage String: Returns records for the specified application package.
database String: Returns records for the current database in use or for a specified database.
schema String: Returns records for the current schema in use or a specified schema. Use fully qualified name.

account boolean: Returns records for the entire account.
application string: Returns records for the specified application.
applicationPackage string: Returns records for the specified application package.
database string: Returns records for the current database in use or for a specified database.
schema string: Returns records for the current schema in use or a specified schema. Use fully qualified name.

account bool: Returns records for the entire account.
application str: Returns records for the specified application.
application_package str: Returns records for the specified application package.
database str: Returns records for the current database in use or for a specified database.
schema str: Returns records for the current schema in use or a specified schema. Use fully qualified name.

account Boolean: Returns records for the entire account.
application String: Returns records for the specified application.
applicationPackage String: Returns records for the specified application package.
database String: Returns records for the current database in use or for a specified database.
schema String: Returns records for the current schema in use or a specified schema. Use fully qualified name.

GetMaskingPoliciesLimit

Rows int: The maximum number of rows to return.
From string: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

Rows int: The maximum number of rows to return.
From string: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

rows Integer: The maximum number of rows to return.
from String: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

rows number: The maximum number of rows to return.
from string: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

rows int: The maximum number of rows to return.
from_ str: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

rows Number: The maximum number of rows to return.
from String: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.