Set up and enable tdextroutine (XRInstallation) CLI tool - Teradata VantageCloud Lake

Lake - Using Queries, UDFs, and External Stored Procedures

Deployment
VantageCloud
Edition
Lake
Product
Teradata VantageCloud Lake
Release Number
Published
February 2025
ft:locale
en-US
ft:lastEdition
2025-08-12
dita:mapPath
vgj1683671089901.ditamap
dita:ditavalPath
pny1626732985837.ditaval
dita:id
vgj1683671089901
Contact Teradata Support to get access to a custom version of the tdextroutine CLI tool (XRInstallation) at https://tssprod.teradata.com:8443/TSFS/.
UDCF supports XRInstallationTool_Linux_8664.01.06.00 and later.

Refer to Specifying tdextroutine Options and Environment Variables for required and optional arguments. The following commands assume the use of ~/.tdextroutine/config.yml to specify these arguments.

    Set up the tdextroutine tool using VantageCloud Lake Console

  1. Sign in to VantageCloud Lake Console as a database user.
  2. Create a Personal Access Token.
  3. Note down the org_key listed as Domain name under the Organization details section on the Home page of your VantageCloud Lake Console.
  4. Enable UDCF feature using tdextroutine (XRInstallation) CLI tool

  5. Enable the UDCF feature:
    tdextroutine udcf enable

    The process takes a few minutes.

  6. Check the status of the UDCF feature:
    tdextroutine udcf status

    When the feature is successfully enabled, the response will have a json formatted output that contains principals in the "Resource" key. Note these AWS role ARNs as they will be used to establish trust.

    You may choose to allow any Principal to access your Lambda function. Teradata recommends allowing only the Principals listed in the output for authorizing access to your AWS Lambda account.

    {
        "Version": "2012-10-17",
        "Statement": [
            {
                "Effect": "Allow",
                "Action": "sts.AssumeRole",
                "Resource": 
                       "arn:aws:iam: :<your account>:role/tc83ccf2/tenants/07/tc83ccf2-07-cog2024071015541226400000005c",
                       "arn:aws:iam: :<your account>:role/tc83ccf2/tenants/07/tc83ccf2-07-cog20240710155404933000000015"
            }
        ]
    }