1. Packages
  2. Snowflake Provider
  3. API Docs
  4. getRowAccessPolicies
Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi

snowflake.getRowAccessPolicies

Explore with Pulumi AI

snowflake logo
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 row access policies. Filtering is aligned with the current possibilities for SHOW ROW ACCESS POLICIES query. The results of SHOW and DESCRIBE are encapsulated in one output collection row_access_policies.

    Using getRowAccessPolicies

    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 getRowAccessPolicies(args: GetRowAccessPoliciesArgs, opts?: InvokeOptions): Promise<GetRowAccessPoliciesResult>
    function getRowAccessPoliciesOutput(args: GetRowAccessPoliciesOutputArgs, opts?: InvokeOptions): Output<GetRowAccessPoliciesResult>
    def get_row_access_policies(in_: Optional[GetRowAccessPoliciesIn] = None,
                                like: Optional[str] = None,
                                limit: Optional[GetRowAccessPoliciesLimit] = None,
                                with_describe: Optional[bool] = None,
                                opts: Optional[InvokeOptions] = None) -> GetRowAccessPoliciesResult
    def get_row_access_policies_output(in_: Optional[pulumi.Input[GetRowAccessPoliciesInArgs]] = None,
                                like: Optional[pulumi.Input[str]] = None,
                                limit: Optional[pulumi.Input[GetRowAccessPoliciesLimitArgs]] = None,
                                with_describe: Optional[pulumi.Input[bool]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetRowAccessPoliciesResult]
    func GetRowAccessPolicies(ctx *Context, args *GetRowAccessPoliciesArgs, opts ...InvokeOption) (*GetRowAccessPoliciesResult, error)
    func GetRowAccessPoliciesOutput(ctx *Context, args *GetRowAccessPoliciesOutputArgs, opts ...InvokeOption) GetRowAccessPoliciesResultOutput

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

    public static class GetRowAccessPolicies 
    {
        public static Task<GetRowAccessPoliciesResult> InvokeAsync(GetRowAccessPoliciesArgs args, InvokeOptions? opts = null)
        public static Output<GetRowAccessPoliciesResult> Invoke(GetRowAccessPoliciesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRowAccessPoliciesResult> getRowAccessPolicies(GetRowAccessPoliciesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: snowflake:index/getRowAccessPolicies:getRowAccessPolicies
      arguments:
        # arguments dictionary

    The following arguments are supported:

    In GetRowAccessPoliciesIn
    IN clause to filter the list of row access policies
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    Limit GetRowAccessPoliciesLimit
    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 ROW ACCESS POLICY for each row access policy returned by SHOW ROW ACCESS POLICIES. The output of describe is saved to the description field. By default this value is set to true.
    In GetRowAccessPoliciesIn
    IN clause to filter the list of row access policies
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    Limit GetRowAccessPoliciesLimit
    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 ROW ACCESS POLICY for each row access policy returned by SHOW ROW ACCESS POLICIES. The output of describe is saved to the description field. By default this value is set to true.
    in GetRowAccessPoliciesIn
    IN clause to filter the list of row access policies
    like String
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetRowAccessPoliciesLimit
    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 ROW ACCESS POLICY for each row access policy returned by SHOW ROW ACCESS POLICIES. The output of describe is saved to the description field. By default this value is set to true.
    in GetRowAccessPoliciesIn
    IN clause to filter the list of row access policies
    like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetRowAccessPoliciesLimit
    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 ROW ACCESS POLICY for each row access policy returned by SHOW ROW ACCESS POLICIES. The output of describe is saved to the description field. By default this value is set to true.
    in_ GetRowAccessPoliciesIn
    IN clause to filter the list of row access policies
    like str
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetRowAccessPoliciesLimit
    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 ROW ACCESS POLICY for each row access policy returned by SHOW ROW ACCESS 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 row access 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 ROW ACCESS POLICY for each row access policy returned by SHOW ROW ACCESS POLICIES. The output of describe is saved to the description field. By default this value is set to true.

    getRowAccessPolicies Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    RowAccessPolicies List<GetRowAccessPoliciesRowAccessPolicy>
    Holds the aggregated output of all views details queries.
    In GetRowAccessPoliciesIn
    IN clause to filter the list of row access policies
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    Limit GetRowAccessPoliciesLimit
    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 ROW ACCESS POLICY for each row access policy returned by SHOW ROW ACCESS 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.
    RowAccessPolicies []GetRowAccessPoliciesRowAccessPolicy
    Holds the aggregated output of all views details queries.
    In GetRowAccessPoliciesIn
    IN clause to filter the list of row access policies
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    Limit GetRowAccessPoliciesLimit
    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 ROW ACCESS POLICY for each row access policy returned by SHOW ROW ACCESS 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.
    rowAccessPolicies List<GetRowAccessPoliciesRowAccessPolicy>
    Holds the aggregated output of all views details queries.
    in GetRowAccessPoliciesIn
    IN clause to filter the list of row access policies
    like String
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetRowAccessPoliciesLimit
    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 ROW ACCESS POLICY for each row access policy returned by SHOW ROW ACCESS 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.
    rowAccessPolicies GetRowAccessPoliciesRowAccessPolicy[]
    Holds the aggregated output of all views details queries.
    in GetRowAccessPoliciesIn
    IN clause to filter the list of row access policies
    like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetRowAccessPoliciesLimit
    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 ROW ACCESS POLICY for each row access policy returned by SHOW ROW ACCESS 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.
    row_access_policies Sequence[GetRowAccessPoliciesRowAccessPolicy]
    Holds the aggregated output of all views details queries.
    in_ GetRowAccessPoliciesIn
    IN clause to filter the list of row access policies
    like str
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetRowAccessPoliciesLimit
    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 ROW ACCESS POLICY for each row access policy returned by SHOW ROW ACCESS 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.
    rowAccessPolicies List<Property Map>
    Holds the aggregated output of all views details queries.
    in Property Map
    IN clause to filter the list of row access 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 ROW ACCESS POLICY for each row access policy returned by SHOW ROW ACCESS POLICIES. The output of describe is saved to the description field. By default this value is set to true.

    Supporting Types

    GetRowAccessPoliciesIn

    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.

    GetRowAccessPoliciesLimit

    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.

    GetRowAccessPoliciesRowAccessPolicy

    DescribeOutputs List<GetRowAccessPoliciesRowAccessPolicyDescribeOutput>
    Holds the output of DESCRIBE ROW ACCESS POLICY.
    ShowOutputs List<GetRowAccessPoliciesRowAccessPolicyShowOutput>
    Holds the output of SHOW ROW ACCESS POLICIES.
    DescribeOutputs []GetRowAccessPoliciesRowAccessPolicyDescribeOutput
    Holds the output of DESCRIBE ROW ACCESS POLICY.
    ShowOutputs []GetRowAccessPoliciesRowAccessPolicyShowOutput
    Holds the output of SHOW ROW ACCESS POLICIES.
    describeOutputs List<GetRowAccessPoliciesRowAccessPolicyDescribeOutput>
    Holds the output of DESCRIBE ROW ACCESS POLICY.
    showOutputs List<GetRowAccessPoliciesRowAccessPolicyShowOutput>
    Holds the output of SHOW ROW ACCESS POLICIES.
    describeOutputs GetRowAccessPoliciesRowAccessPolicyDescribeOutput[]
    Holds the output of DESCRIBE ROW ACCESS POLICY.
    showOutputs GetRowAccessPoliciesRowAccessPolicyShowOutput[]
    Holds the output of SHOW ROW ACCESS POLICIES.
    describeOutputs List<Property Map>
    Holds the output of DESCRIBE ROW ACCESS POLICY.
    showOutputs List<Property Map>
    Holds the output of SHOW ROW ACCESS POLICIES.

    GetRowAccessPoliciesRowAccessPolicyDescribeOutput

    GetRowAccessPoliciesRowAccessPolicyDescribeOutputSignature

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

    GetRowAccessPoliciesRowAccessPolicyShowOutput

    Comment string
    CreatedOn string
    DatabaseName string
    Kind string
    Name string
    Options string
    Owner string
    OwnerRoleType string
    SchemaName string
    Comment string
    CreatedOn string
    DatabaseName string
    Kind string
    Name string
    Options string
    Owner string
    OwnerRoleType string
    SchemaName string
    comment String
    createdOn String
    databaseName String
    kind String
    name String
    options String
    owner String
    ownerRoleType String
    schemaName String
    comment string
    createdOn string
    databaseName string
    kind string
    name string
    options string
    owner string
    ownerRoleType string
    schemaName string
    comment String
    createdOn String
    databaseName String
    kind String
    name String
    options 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 logo
    Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi