Updated on 2024-10-21 GMT+08:00

Managing LakeFormation Data Sources

On the GaussDB(DWS console), you can create a LakeFormation data source on the console to access metadata on LakeFormation.

  • This feature is for limited commercial use only. It only supports DWS 3.0 clusters in version 9.0.1 and later, and DWS 2.0 clusters in version 8.2.1.300 and later.
  • LakeFormation is connected through VPC Endpoint. When you create a LakeFormation data source, if there is no VPC endpoint for your GaussDB(DWS) cluster, it will be automatically created. VPC endpoints incur extra fees.

Prerequisites

  • A LakeFormation instance is available. For details, see section "Creating a LakeFormation Instance" in LakeFormation Usage Guide.
  • Create an agency with LakeFormation permissions (including the minimum permissions). For details about how to configure the permissions, see section "Data Permission Authorization" in LakeFormation Usage Guide. If the permissions are not correctly configured, an error will be reported.
  • For an IAM user to use GaussDB(DWS) to call APIs on the LakeFormation management plane, the user must have LakeFormation permissions (at least lakeformation:instance:access and lakeformation:instance:describe).

Creating a LakeFormation Data Source

  1. On the GaussDB(DWS) console, choose Clusters > Dedicated Clusters.
  2. In the cluster list, click the name of a cluster. On the page that is displayed, choose Data Sources > LakeFormation Data Sources.
  3. Click Create LakeFormation Data Source Connection and configure parameters.

    Figure 1 Creating a LakeFormation data source connection
    Table 1 LakeFormation data source connection parameters

    Parameter

    Description

    Data Source

    Name of the LakeFormation data source connection to be created

    LakeFormation Instance

    LakeFormation cluster instance to be bound

    Database

    Database where the LakeFormation data source connection is to be created

    Agency

    An agency authorized by LakeFormation. GaussDB(DWS) interacts with LakeFormation through this agency token o obtain metadata.

    Description

    Description about the LakeFormation data source connection

  4. Confirm the settings and click OK. The creation takes about 1 minute.

Updating a Configuration

Scenario

  • After a data source connection is created, its VPC endpoint is deleted by mistake and the data source cannot be used.
  • The agency needs to be changed.
  • A token fails to be updated. After this issue is fixed, the token needs to be updated immediately.

Procedure

  1. On the GaussDB(DWS) console, choose Clusters > Dedicated Clusters.
  2. In the cluster list, click the name of a cluster. On the page that is displayed, choose Data Sources > LakeFormation Data Sources.
  3. In the Operation column of a LakeFormation data source, click Update Configuration.
  4. During the update, you can only change the agency. After confirming that the agency is correct, click OK to submit the update. The update takes about 1 minute.

    Figure 2 Updating a LakeFormation data source connection

Deleting a LakeFormation Data Source

  1. On the GaussDB(DWS) console, choose Clusters > Dedicated Clusters.
  2. In the cluster list, click the name of a cluster. On the page that is displayed, choose Data Sources > LakeFormation Data Sources.
  3. In the Operation column of a LakeFormation data source, click Delete.
  4. Confirm the settings and click OK. The deletion takes about 10 seconds.

Using a LakeFormation Data Source

For details about how to use the LakeFormation data source, see "Data Migration > Data Import > Using LakeFormation to Import Data" in Data Warehouse Service Developer Guide