AWS::LakeFormation::Tag

The AWS::LakeFormation::Tag resource represents an LF-tag, which consists of a key and one or more possible values for the key. During a stack operation, AWS CloudFormation calls the AWS Lake Formation CreateLFTag API to create a tag, and UpdateLFTag API to update a tag resource, and a DeleteLFTag to delete it.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

{
  "Type" : "AWS::LakeFormation::Tag",
  "Properties" : {
      "CatalogId" : String,
      "TagKey" : String,
      "TagValues" : [ String, ... ]
    }
}

Type: AWS::LakeFormation::Tag
Properties:
  CatalogId: String
  TagKey: String
  TagValues: 
    - String

Properties

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Tag’s TagKey property value.

For example: tagKeyName

Remarks

Note the following:

Only data lake administrators can create LF-tags.

An LF-tag can be assigned to Data Catalog resources (databases, tables, and columns) via AWS::LakeFormation::TagAssociation to implement tag-based access control.

Examples

Creating a tag resource in a template

The following example demonstrates how to define a tag resource in a template.

{
    "SampleTag": {
        "Type": "AWS::LakeFormation::Tag",
        "Properties": {
            "TagKey": "sample_tag_key",
            "TagValues": ["sample_tag_value1", "sample_tag_value2"]
        }
    }
}     
        

SampleTag:
    Type: AWS::LakeFormation::Tag
    Properties:
      TagKey: "sample_tag_key"
      TagValues:
        - "sample_tag_value1"
        - "sample_tag_value2"

See also

Assign an LF-tag to a Data Catalog resource - AWS::LakeFormation::TagAssociation.