LfTag class

Creates an LF-Tag with the specified name and values. Each key must have at least one value. The maximum number of values permitted is 1000.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.lakeformation.LfTag("example", {
    key: "module",
    values: [
        "Orders",
        "Sales",
        "Customers",
    ],
});
import pulumi
import pulumi_aws as aws

example = aws.lakeformation.LfTag("example",
    key="module",
    values=[
        "Orders",
        "Sales",
        "Customers",
    ])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.LakeFormation.LfTag("example", new()
    {
        Key = "module",
        Values = new[]
        {
            "Orders",
            "Sales",
            "Customers",
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/lakeformation"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := lakeformation.NewLfTag(ctx, "example", &lakeformation.LfTagArgs{
			Key: pulumi.String("module"),
			Values: pulumi.StringArray{
				pulumi.String("Orders"),
				pulumi.String("Sales"),
				pulumi.String("Customers"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_lakeformation_lftag" "example" {
  key    = "module"
  values = ["Orders", "Sales", "Customers"]
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lakeformation.LfTag;
import com.pulumi.aws.lakeformation.LfTagArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new LfTag("example", LfTagArgs.builder()
            .key("module")
            .values(
                "Orders",
                "Sales",
                "Customers")
            .build());

    }
}
resources:
  example:
    type: aws:lakeformation:LfTag
    properties:
      key: module
      values:
        - Orders
        - Sales
        - Customers

Import

Using pulumi import, import Lake Formation LF-Tags using the catalog_id:key. If you have not set a Catalog ID specify the AWS Account ID that the database is in. For example:

$ pulumi import aws:lakeformation/lfTag:LfTag example 123456789012:some_key

Constructors

LfTag(String name, {LfTagArgs? args, CustomResourceOptions? options})
Creates a new LfTag. name The Pulumi resource name. args Arguments used to configure this LfTag. The set of arguments for LfTag. options Resource options controlling this resource's behavior.
LfTag.reference(String urn)
Creates a typed reference to an existing LfTag resource.

Properties

catalogId ↔ Output<String>
ID of the Data Catalog to create the tag in. If omitted, this defaults to the AWS Account ID.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
key ↔ Output<String>
Key-name for the tag.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
values ↔ Output<List<String>>
List of possible values an attribute can take.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {LfTagState? state, CustomResourceOptions? options}) → LfTag
Gets an existing LfTag resource's state with the given name and id.