Skip to content

Resource: awsLakeformationResourceLfTags

Manages an attachment between one or more existing LF-tags and an existing Lake Formation resource.

Example Usage

Database Example

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
const awsLakeformationLfTagExample =
  new aws.lakeformationLfTag.LakeformationLfTag(this, "example", {
    key: "right",
    values: [
      "abbey",
      "village",
      "luffield",
      "woodcote",
      "copse",
      "chapel",
      "stowe",
      "club",
    ],
  });
const awsLakeformationResourceLfTagsExample =
  new aws.lakeformationResourceLfTags.LakeformationResourceLfTags(
    this,
    "example_1",
    {
      database: {
        name: "${aws_glue_catalog_database.example.name}",
      },
      lfTag: [
        {
          key: awsLakeformationLfTagExample.key,
          value: "stowe",
        },
      ],
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
awsLakeformationResourceLfTagsExample.overrideLogicalId("example");

Multiple Tags Example

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.lakeformationLfTag.LakeformationLfTag(this, "example", {
  key: "right",
  values: [
    "abbey",
    "village",
    "luffield",
    "woodcote",
    "copse",
    "chapel",
    "stowe",
    "club",
  ],
});
new aws.lakeformationLfTag.LakeformationLfTag(this, "example2", {
  key: "left",
  values: [
    "farm",
    "theloop",
    "aintree",
    "brooklands",
    "maggotts",
    "becketts",
    "vale",
  ],
});
const awsLakeformationResourceLfTagsExample =
  new aws.lakeformationResourceLfTags.LakeformationResourceLfTags(
    this,
    "example_2",
    {
      database: {
        name: "${aws_glue_catalog_database.example.name}",
      },
      lfTag: [
        {
          key: "right",
          value: "luffield",
        },
        {
          key: "left",
          value: "aintree",
        },
      ],
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
awsLakeformationResourceLfTagsExample.overrideLogicalId("example");

Argument Reference

The following arguments are required:

  • lfTag – (Required) Set of LF-tags to attach to the resource. See below.

Exactly one of the following is required:

  • database - (Optional) Configuration block for a database resource. See below.
  • table - (Optional) Configuration block for a table resource. See below.
  • tableWithColumns - (Optional) Configuration block for a table with columns resource. See below.

The following arguments are optional:

  • catalogId – (Optional) Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.

lfTag

The following arguments are required:

  • key – (Required) Key name for an existing LF-tag.
  • value - (Required) Value from the possible values for the LF-tag.

The following argument is optional:

  • catalogId - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller.

database

The following argument is required:

  • name – (Required) Name of the database resource. Unique to the Data Catalog.

The following argument is optional:

  • catalogId - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller.

table

The following argument is required:

  • databaseName – (Required) Name of the database for the table. Unique to a Data Catalog.
  • name - (Required, at least one of name or wildcard) Name of the table.
  • wildcard - (Required, at least one of name or wildcard) Whether to use a wildcard representing every table under a database. Defaults to false.

The following arguments are optional:

  • catalogId - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller.

tableWithColumns

The following arguments are required:

  • columnNames - (Required, at least one of columnNames or wildcard) Set of column names for the table.
  • databaseName – (Required) Name of the database for the table with columns resource. Unique to the Data Catalog.
  • name – (Required) Name of the table resource.
  • wildcard - (Required, at least one of columnNames or wildcard) Whether to use a column wildcard. If excludedColumnNames is included, wildcard must be set to true to avoid Terraform reporting a difference.

The following arguments are optional:

  • catalogId - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller.
  • excludedColumnNames - (Optional) Set of column names for the table to exclude. If excludedColumnNames is included, wildcard must be set to true to avoid Terraform reporting a difference.

Attributes Reference

No additional attributes are exported.