Assigning access rules for functions in Managed Service for Trino

Written by

Updated at January 29, 2026

Setting rules when creating a cluster
Setting rules for an existing cluster
Example of setting function access rules

Access rules define the actions users can perform with custom functions in a Managed Service for Trino cluster.

Note

You cannot set restrictions on running functions from the system.builtin virtual schema, i.e., native Trino functions.

For each user-function pair, the rules apply as follows:

Rules are checked for matches in the order they are specified in the configuration file. The first rule matching the user-function pair applies.
If none of the rules match the user-function pair, no actions with the function are allowed to the user.
If no function access rules are set, each user can run only built-in functions.
Function access rules apply together with the top-level rules for objects in catalogs.

Setting rules when creating a cluster

You can set function access rules when creating a Managed Service for Trino cluster.

Warning

Function and schema names specified in the rules are not validated. If a function name or a schema name contains an error, the rule will not apply correctly.

CLI

Terraform

gRPC API

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To set function access rules:

Create a file named access_control.yaml and paste the following code into it:
```
functions:
  # Rule 1
  - privileges: [<list_of_privileges>]
    function:
      names:
        any: [<list_of_function_names>]
      name_regexp: <regular_expression>
    schema:
      names:
        any: [<list_of_schema_names>]
      name_regexp: <regular_expression>
    catalog:
      name_regexp: <regular_expression>
    groups: [<list_of_group_IDs>]
    users: [<list_of_user_IDs>]
    description: <rule_description>
  # Rule 2
  - <Rule_2_parameters>
  ...
  # Rule N
  - <Rule_N_parameters>
```
Where:
- functions: List of function rules. All the rule parameters are optional: privileges, function, schema, catalog, groups, users, and description.
- privileges: List of permitted actions with functions:
  - EXECUTE: Calling a function.
  - GRANT_EXECUTE: Calling a function to create VIEW.
  - OWNERSHIP: Creating and deleting a function.
  If you do not specify the privileges parameter, the rule will prohibit any actions with the functions.
  
  Note
  
  To use the OWNERSHIP privilege for the function, you need the ALL access level for the catalog containing that function.
- function: Functions the rule applies to. If you do not specify function, the rule applies to all functions.
  - names: List of function names.
  - name_regexp: Regular expression. The rule applies to the functions whose names match the regular expression.
  You can specify either names or name_regexp but not both.
- schema: Schemas the rule applies to. If you do not specify schema, the rule applies to all schemas.
  - names: List of schema names.
  - name_regexp: Regular expression. The rule applies to the schemas whose names match the regular expression.
  Specify either names or name_regexp.
- catalog: Cluster catalogs the rule applies to. If you do not specify catalog, the rule applies to all cluster catalogs.
  - name_regexp: Regular expression. The rule applies to the catalogs whose names match the regular expression.
- groups: List of group IDs the rule applies to. If you do not specify groups, the rule applies to all user groups.
- users: List of user IDs the rule applies to. If you do not specify users, the rule applies to all users.
- description: Rule description.
View the description of the CLI command for creating a cluster:
```
yc managed-trino cluster create --help
```

Run this command:

yc managed-trino cluster create \
  ...
  --access-control-from-file access_control.yaml

For available cluster parameters and their descriptions, see this guide.

Create a Terraform configuration file describing your infrastructure.
Add the yandex_trino_access_control resource with the functions rule list to the configuration file.
```
resource "yandex_trino_cluster" "<cluster_name>" {
  ...
}

resource "yandex_trino_catalog" "<catalog_1_name>" {
  ...
}

resource "yandex_trino_catalog" "<catalog_2_name>" {
  ...
}

...

resource "yandex_trino_catalog" "<catalog_N_name>" {
  ...
}

resource "yandex_trino_access_control" "trino_access_control" {
  ...
  cluster_id  = yandex_trino_cluster.<cluster_name>.id
  functions = [
    # Rule 1
    {
      privileges    = ["<list_of_privileges>"]
      function     = {
        names       = ["<list_of_function_names>"]
        name_regexp = "<regular_expression>"
      }
      schema        = {
        names       = ["<list_of_schema_names>"]
        name_regexp = "<regular_expression>"
      }
      catalog       = {
        ids         = [
          yandex_trino_catalog.<catalog_1_name>.id,
          yandex_trino_catalog.<catalog_2_name>.id,
          ... 
          yandex_trino_catalog.<catalog_N_name>.id
        ]
        name_regexp = "<regular_expression>"
      }
      users         = ["<list_of_user_IDs>"]
      groups        = ["<list_of_group_IDs>"]
      description   = "<rule_description>"
    },
    # Rule 2
    {
      ... 
    },
    ...
    # Rule N
    {
      ... 
    }
  ]
  ...
}
```
Where:
- functions: List of function rule sections. All the rule parameters are optional: privileges, function, schema, catalog, groups, users, and description.
- privileges: List of permitted actions with functions:
  - EXECUTE: Calling a function.
  - GRANT_EXECUTE: Calling a function to create VIEW.
  - OWNERSHIP: Creating and deleting a function.
  If you do not specify the privileges parameter, the rule will prohibit any actions with the functions.
  
  Note
  
  To use the OWNERSHIP privilege for the function, you need the ALL access level for the catalog containing that function.
- function: Functions the rule applies to. If the function section is not specified, the rule applies to all functions.
  - names: List of function names.
  - name_regexp: Regular expression. The rule applies to the functions whose names match the regular expression.
  You can specify either names or name_regexp but not both.
- schema: Schemas the rule applies to. If the schema section is not specified, the rule applies to all schemas.
  - names: List of schema names.
  - name_regexp: Regular expression. The rule applies to the schemas whose names match the regular expression.
  You can specify either names or name_regexp but not both.
- catalog: Cluster catalogs the rule applies to. If the catalog section is not specified, the rule applies to all cluster catalogs.
  - ids: List of catalog IDs. These catalogs must be created in the same manifest.
  - name_regexp: Regular expression. The rule applies to the catalogs whose names match the regular expression.
  You can specify either ids or name_regexp but not both.
- groups: List of group IDs the rule applies to. If you do not specify groups, the rule applies to all user groups.
- users: List of user IDs the rule applies to. If you do not specify users, the rule applies to all users.
- description: Rule description.
Make sure the settings are correct.
1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.
2. Run this command:
```
terraform validate
```
  Terraform will show any errors found in your configuration files.
Confirm updating the resources.
1. Run this command to view the planned changes:
```
terraform plan
```
  If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.
2. If everything looks correct, apply the changes:
  1. Run this command:
```
terraform apply
```
  2. Confirm updating the resources.
  3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```
Clone the cloudapi repository:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Below, we assume that the repository contents reside in the ~/cloudapi/ directory.
Create a file named body.json and paste the following code into it:
```
{
  <cluster_parameters>
  ...
  "trino": {
    "catalogs": [
      {
        "name": "catalog_1_name",
        ...
      },
      {
        "name": "catalog_2_name",
        ...
      },
      ...
      {
        "name": "catalog_N_name",
        ...
      }
    ]
    ...
    "access_control": {
      "functions": [
        {
          "privileges": [
            "<list_of_privileges>"
          ],
          "function": {
            "names": {
              "any": [
                "<list_of_function_names>"
              ]
            },
            "name_regexp": "<regular_expression>"
          },
          "schema": {
            "names": {
              "any": [
                "<list_of_schema_names>"
              ]
            },
            "name_regexp": "<regular_expression>"
          },
          "catalog": {
            "names": {
              "any": [
                "<catalog_1_name>",
                "<catalog_2_name>",
                ...
                "<catalog_N_name>"
              ]
            },
            "name_regexp": "<regular_expression>"
          },
          "users": [
            "<list_of_user_IDs>"
          ],
          "groups": [
            "<list_of_group_IDs>"
          ],
          "description": "<rule_description>"
        },
        {
          <Rule_2_section>
        },
        ...
        {
          <Rule_N_section>
        }
      ]
    }
  }
}
```
Where:
- access_control: Access rule configuration in the cluster.
- functions: List of function rule sections. All the rule parameters are optional: privileges, function, schema, catalog, groups, users, and description.
- privileges: List of permitted actions with functions:
  - EXECUTE: Calling a function.
  - GRANT_EXECUTE: Calling a function to create VIEW.
  - OWNERSHIP: Creating and deleting a function.
  If you do not specify the privileges parameter, the rule will prohibit any actions with the functions.
  
  Note
  
  To use the OWNERSHIP privilege for the function, you need the ALL access level for the catalog containing that function.
- function: Functions the rule applies to. If the function section is not specified, the rule applies to all functions.
  - names: List of function names.
  - name_regexp: Regular expression. The rule applies to the functions whose names match the regular expression.
  The function section must contain either the nested names section or the name_regexp parameter.
- schema: Schemas the rule applies to. If the schema section is not specified, the rule applies to all schemas.
  - names: List of schema names.
  - name_regexp: Regular expression. The rule applies to the schemas whose names match the regular expression.
  The schema section must contain either the nested names section or the name_regexp parameter.
- catalog: Catalogs the rule applies to. If the catalog section is not specified, the rule applies to all cluster catalogs.
  - names: List of catalog names. You must create catalogs within the same ClusterService/Create call.
  - name_regexp: Regular expression. The rule applies to the catalogs whose names match the regular expression.
  The catalog section must contain either the nested names section or the name_regexp parameter.
- groups: List of group IDs the rule applies to. If you do not specify groups, the rule applies to all user groups.
- users: List of user IDs the rule applies to. If you do not specify users, the rule applies to all users.
- description: Rule description.
For available cluster parameters and their descriptions, see this guide.

Call the ClusterService/Create method, e.g., via the following gRPCurl request:

grpcurl \
    -format json \
    -import-path ~/cloudapi/ \
    -import-path ~/cloudapi/third_party/googleapis/ \
    -proto ~/cloudapi/yandex/cloud/trino/v1/cluster_service.proto \
    -rpc-header "Authorization: Bearer $IAM_TOKEN" \
    -d @ \
    trino.api.cloud.yandex.net:443 \
    yandex.cloud.trino.v1.ClusterService.Create \
    < body.json

Check the server response to make sure your request was successful.

Setting rules for an existing cluster

You can set or update function access rules for an existing Managed Service for Trino cluster.

Warning

Function and schema names specified in the rules are not validated. If a function name or a schema name contains an error, the rule will not apply correctly.

CLI

Terraform

gRPC API

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

To set function access rules:

If you have not set any access rules yet, create a file named access_control.yaml and paste the following code into it:
```
functions:
  # Rule 1
  - privileges: [<list_of_privileges>]
    function:
      names:
        any: [<list_of_function_names>]
      name_regexp: <regular_expression>
    schema:
      names:
        any: [<list_of_schema_names>]
      name_regexp: <regular_expression>
    catalog:
      ids:
        any: [<list_of_catalog_IDs>]
      names:
        any: [<list_of_catalog_names>]
      name_regexp: <regular_expression>
    groups: [<list_of_group_IDs>]
    users: [<list_of_user_IDs>]
    description: <rule_description>
  # Rule 2
  - <Rule_2_parameters>
  ...
  # Rule N
  - <Rule_N_parameters>
```
Where:
- functions: List of function rules. All the rule parameters are optional: privileges, function, schema, catalog, groups, users, and description.
- privileges: List of permitted actions with functions:
  - EXECUTE: Calling a function.
  - GRANT_EXECUTE: Calling a function to create VIEW.
  - OWNERSHIP: Creating and deleting a function.
  If you do not specify the privileges parameter, the rule will prohibit any actions with the functions.
  
  Note
  
  To use the OWNERSHIP privilege for the function, you need the ALL access level for the catalog containing that function.
- function: Functions the rule applies to. If you do not specify function, the rule applies to all functions.
  - names: List of function names.
  - name_regexp: Regular expression. The rule applies to the functions whose names match the regular expression.
  You can specify either names or name_regexp but not both.
- schema: Schemas the rule applies to. If you do not specify schema, the rule applies to all schemas.
  - names: List of schema names.
  - name_regexp: Regular expression. The rule applies to the schemas whose names match the regular expression.
  You can specify either names or name_regexp but not both.
- catalog: Catalogs the rule applies to. If you do not specify catalog, the rule applies to all cluster catalogs.
  - ids: List of catalog IDs. These must be the existing catalogs.
  - names: List of catalog names. These must be the existing catalogs.
  - name_regexp: Regular expression. The rule applies to the catalogs whose names match the regular expression.
  You can specify only one of the following: ids, names, or name_regexp.
- groups: List of group IDs the rule applies to. If you do not specify groups, the rule applies to all user groups.
- users: List of user IDs the rule applies to. If you do not specify users, the rule applies to all users.
- description: Rule description.
If you have already set the access rules, open access_control.yaml and edit it as needed. You can:
- Add new rules.
- Update the existing ones.
- Delete the rules you no longer need.

Run this command:

yc managed-trino cluster set-access-control <cluster_name_or_ID> \
  --from-file access_control.yaml

You can get the cluster ID and name with the list of clusters in the folder.

Open the current Terraform configuration file describing your infrastructure.

To learn how to create this file, see Creating a cluster.
If you have not set any access rules yet, add the yandex_trino_access_control resource containing the functions rule list.
```
resource "yandex_trino_cluster" "<cluster_name>" {
  ...
}

resource "yandex_trino_catalog" "<catalog_1_name>" {
  ...
}

resource "yandex_trino_catalog" "<catalog_2_name>" {
  ...
}

...

resource "yandex_trino_catalog" "<catalog_N_name>" {
  ...
}

resource "yandex_trino_access_control" "trino_access_control" {
  ...
  cluster_id  = yandex_trino_cluster.<cluster_name>.id
  functions = [
    # Rule 1
    {
      privileges    = ["<list_of_privileges>"]
      function     = {
        names       = ["<list_of_function_names>"]
        name_regexp = "<regular_expression>"
      }
      schema        = {
        names       = ["<list_of_schema_names>"]
        name_regexp = "<regular_expression>"
      }
      catalog       = {
        ids         = [
          yandex_trino_catalog.<catalog_1_name>.id,
          yandex_trino_catalog.<catalog_2_name>.id,
          ... 
          yandex_trino_catalog.<catalog_N_name>.id
        ]
        name_regexp = "<regular_expression>"
      }
      users         = ["<list_of_user_IDs>"]
      groups        = ["<list_of_group_IDs>"]
      description   = "<rule_description>"
    },
    # Rule 2
    {
      ... 
    },
    ...
    # Rule N
    {
      ... 
    }
  ]
  ...
}
```
Where:
- functions: List of function rule sections. All the rule parameters are optional: privileges, function, schema, catalog, groups, users, and description.
- privileges: List of permitted actions with functions:
  - EXECUTE: Calling a function.
  - GRANT_EXECUTE: Calling a function to create VIEW.
  - OWNERSHIP: Creating and deleting a function.
  If you do not specify the privileges parameter, the rule will prohibit any actions with the functions.
  
  Note
  
  To use the OWNERSHIP privilege for the function, you need the ALL access level for the catalog containing that function.
- function: Functions the rule applies to. If the function section is not specified, the rule applies to all functions.
  - names: List of function names.
  - name_regexp: Regular expression. The rule applies to the functions whose names match the regular expression.
  You can specify either names or name_regexp but not both.
- schema: Schemas the rule applies to. If the schema section is not specified, the rule applies to all schemas.
  - names: List of schema names.
  - name_regexp: Regular expression. The rule applies to the schemas whose names match the regular expression.
  You can specify either names or name_regexp but not both.
- catalog: Cluster catalogs the rule applies to. If the catalog section is not specified, the rule applies to all cluster catalogs.
  - ids: List of catalog IDs. These must exist or be created in the same manifest.
  - name_regexp: Regular expression. The rule applies to the catalogs whose names match the regular expression.
  You can specify either ids or name_regexp but not both.
- groups: List of group IDs the rule applies to. If you do not specify groups, the rule applies to all user groups.
- users: List of user IDs the rule applies to. If you do not specify users, the rule applies to all users.
- description: Rule description.
If you have already set the access rules, edit the yandex_trino_access_control resource description. You can:
- Add new rules.
- Update the existing ones.
- Delete the rules you no longer need.
Make sure the settings are correct.
1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.
2. Run this command:
```
terraform validate
```
  Terraform will show any errors found in your configuration files.
Confirm updating the resources.
1. Run this command to view the planned changes:
```
terraform plan
```
  If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.
2. If everything looks correct, apply the changes:
  1. Run this command:
```
terraform apply
```
  2. Confirm updating the resources.
  3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

Get an IAM token for API authentication and put it in an environment variable:
```
export IAM_TOKEN="<IAM_token>"
```
Clone the cloudapi repository:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Below, we assume that the repository contents reside in the ~/cloudapi/ directory.
If you have not set any access rules yet, create a file named body.json and paste the following code into it:
```
{
  "cluster_id": "<cluster_ID>",
  "update_mask": {
    "paths": [
      "trino.access_control.functions"
    ]
  },
  "trino": {
    "access_control": {
      "functions": [
        {
          "privileges": [
            "<list_of_privileges>"
          ],
          "function": {
            "names": {
              "any": [
                "<list_of_function_names>"
              ]
            },
            "name_regexp": "<regular_expression>"
          },
          "schema": {
            "names": {
              "any": [
                "<list_of_schema_names>"
              ]
            },
            "name_regexp": "<regular_expression>"
          },
          "catalog": {
            "ids": {
              "any": [
                "<list_of_catalog_IDs>"
              ]
            },
            "names": {
              "any": [
                "<catalog_1_name>",
                "<catalog_2_name>",
                ...
                "<catalog_N_name>"
              ]
            },
            "name_regexp": "<regular_expression>"
          },
          "users": [
            "<list_of_user_IDs>"
          ],
          "groups": [
            "<list_of_group_IDs>"
          ],
          "description": "<rule_description>"
        },
        {
          <Rule_2_section>
        },
        ...
        {
          <Rule_N_section>
        }
      ]
    }
  }
}
```
Where:
- cluster_id: Cluster ID.
  
  You can get the cluster ID with the list of clusters in the folder.
- update_mask: List of parameters to update as an array of strings (paths[]).
  Format for listing settings
  "update_mask": { "paths": [ "<setting_1>", "<setting_2>", ... "<setting_N>" ] }
  Warning
  
  When you update a cluster, all parameters of the object you are modifying will take their defaults unless explicitly provided in the request. To avoid this, list the settings you want to change in the update_mask parameter.
- access_control: Access rule configuration in the cluster.
- functions: List of function rule sections. All the rule parameters are optional: privileges, function, schema, catalog, groups, users, and description.
- privileges: List of permitted actions with functions:
  - EXECUTE: Calling a function.
  - GRANT_EXECUTE: Calling a function to create VIEW.
  - OWNERSHIP: Creating and deleting a function.
  If you do not specify the privileges parameter, the rule will prohibit any actions with the functions.
  
  Note
  
  To use the OWNERSHIP privilege for the function, you need the ALL access level for the catalog containing that function.
- function: Functions the rule applies to. If the function section is not specified, the rule applies to all functions.
  - names: List of function names.
  - name_regexp: Regular expression. The rule applies to the functions whose names match the regular expression.
  The function section must contain either the nested names section or the name_regexp parameter.
- schema: Schemas the rule applies to. If the schema section is not specified, the rule applies to all schemas.
  - names: List of schema names.
  - name_regexp: Regular expression. The rule applies to the schemas whose names match the regular expression.
  The schema section must contain either the nested names section or the name_regexp parameter.
- catalog: Catalogs the rule applies to. If the catalog section is not specified, the rule applies to all cluster catalogs.
  - ids: List of catalog IDs. These must be the existing catalogs.
  - names: List of catalog names. These must be the existing catalogs.
  - name_regexp: Regular expression. The rule applies to the catalogs whose names match the regular expression.
  The catalog section must contain either one of the nested ids or names sections, or the name_regexp parameter.
- groups: List of group IDs the rule applies to. If you do not specify groups, the rule applies to all user groups.
- users: List of user IDs the rule applies to. If you do not specify users, the rule applies to all users.
- description: Rule description.
If you have already set the access rules, open the existing body.json rules file and edit it as needed. You can:
- Add new rules.
- Update the existing ones.
- Delete the rules you no longer need.

Call the ClusterService.Update method, e.g., via the following gRPCurl request:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/trino/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d @ \
  trino.api.cloud.yandex.net:443 \
  yandex.cloud.trino.v1.ClusterService.Update \
  < body.json

Check the server response to make sure your request was successful.

Example of setting function access rules

Let's configure access rules for custom functions in a Trino cluster:

Prohibit any actions with functions to the user with the banned_user_id ID.
Allow users in the group with the admins_group_id to create and delete any functions, and also call them to create a VIEW.
Allow all other users to call functions with with the naming pattern of .*_public.

CLI

Terraform

gRPC API

The access_control.yaml file for this rule set is as follows:

functions:
  - users:
      - banned_user_id

  - groups:
      - admins_group_id
    privileges:
      - GRANT_EXECUTE
      - OWNERSHIP

  - function:
      name_regexp: ".*_public"
    privileges:
      - EXECUTE

The configuration file for this rule set is as follows:

resource "yandex_trino_access_control" "trino_access_control" {
  ...
  cluster_id  = <cluster_ID>
  functions = [
    {
      users         = ["banned_user_id"]
    },
    {
      groups        = ["admins_group_id"]
      privileges    = ["GRANT_EXECUTE", "OWNERSHIP"]
    },
    {
      function      = {
        name_regexp = ".*_public"
      }
      privileges    = ["EXECUTE"]
    }
  ]
  ...
}

The body.json file for this rule set is as follows:

{
  "cluster_id": "<cluster_ID>",
  "update_mask": {
    "paths": [
      "trino.access_control.functions"
    ]
  },
  "trino": {
    "access_control": {
      "functions": [
        {
          "users": [
            "banned_user_id"
          ]
        },
        {
          "groups": [
            "admins_group_id"
          ],
          "privileges": [
            "GRANT_EXECUTE",
            "OWNERSHIP"
          ]
        },
        {
          "function": {
            "name_regexp": ".*_public"
          },
          "privileges": [
            "EXECUTE"
          ]
        }
      ]
    }
  }
}

Assigning access rules for functions in Managed Service for Trino

Setting rules when creating a clusterSetting rules when creating a cluster

Setting rules for an existing clusterSetting rules for an existing cluster

Example of setting function access rulesExample of setting function access rules

Was the article helpful?

Setting rules when creating a cluster

Setting rules for an existing cluster

Example of setting function access rules