Package software.amazon.awscdk.services.lakeformation

Interface CfnTagAssociation.LFTagPairProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTagAssociation.LFTagPairProperty.Jsii$Proxy

Enclosing class:

CfnTagAssociation

@Stability(Stable)
public static interface CfnTagAssociation.LFTagPairProperty
extends software.amazon.jsii.JsiiSerializable

A structure containing the catalog ID, tag key, and tag values of an LF-tag key-value pair.

Example:

 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.glue.alpha.S3Table;
 import software.amazon.awscdk.services.glue.alpha.Database;
 import software.amazon.awscdk.services.glue.alpha.DataFormat;
 import software.amazon.awscdk.services.glue.alpha.Schema;
 import software.amazon.awscdk.services.lakeformation.CfnDataLakeSettings;
 import software.amazon.awscdk.services.lakeformation.CfnTag;
 import software.amazon.awscdk.services.lakeformation.CfnTagAssociation;
 Stack stack;
 String accountId;
 String tagKey = "aws";
 String[] tagValues = List.of("dev");
 Database database = new Database(this, "Database");
 S3Table table = S3Table.Builder.create(this, "Table")
         .database(database)
         .columns(List.of(Column.builder()
                 .name("col1")
                 .type(Schema.STRING)
                 .build(), Column.builder()
                 .name("col2")
                 .type(Schema.STRING)
                 .build()))
         .dataFormat(DataFormat.CSV)
         .build();
 DefaultStackSynthesizer synthesizer = (DefaultStackSynthesizer)stack.getSynthesizer();
 CfnDataLakeSettings.Builder.create(this, "DataLakeSettings")
         .admins(List.of(DataLakePrincipalProperty.builder()
                 .dataLakePrincipalIdentifier(stack.formatArn(ArnComponents.builder()
                         .service("iam")
                         .resource("role")
                         .region("")
                         .account(accountId)
                         .resourceName("Admin")
                         .build()))
                 .build(), DataLakePrincipalProperty.builder()
                 // The CDK cloudformation execution role.
                 .dataLakePrincipalIdentifier(synthesizer.cloudFormationExecutionRoleArn.replace("${AWS::Partition}", "aws"))
                 .build()))
         .build();
 CfnTag tag = CfnTag.Builder.create(this, "Tag")
         .catalogId(accountId)
         .tagKey(tagKey)
         .tagValues(tagValues)
         .build();
 LFTagPairProperty lfTagPairProperty = LFTagPairProperty.builder()
         .catalogId(accountId)
         .tagKey(tagKey)
         .tagValues(tagValues)
         .build();
 CfnTagAssociation tagAssociation = CfnTagAssociation.Builder.create(this, "TagAssociation")
         .lfTags(List.of(lfTagPairProperty))
         .resource(ResourceProperty.builder()
                 .tableWithColumns(TableWithColumnsResourceProperty.builder()
                         .databaseName(database.getDatabaseName())
                         .columnNames(List.of("col1", "col2"))
                         .catalogId(accountId)
                         .name(table.getTableName())
                         .build())
                 .build())
         .build();
 tagAssociation.node.addDependency(tag);
 tagAssociation.node.addDependency(table);
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-lftagpair.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTagAssociation.LFTagPairProperty.Builder	A builder for CfnTagAssociation.LFTagPairProperty
static final class	CfnTagAssociation.LFTagPairProperty.Jsii$Proxy	An implementation for CfnTagAssociation.LFTagPairProperty

Method Summary

Modifier and Type	Method	Description
static CfnTagAssociation.LFTagPairProperty.Builder	builder()
String	getCatalogId()	The identifier for the Data Catalog .
String	getTagKey()	The key-name for the LF-tag.
List<String>	getTagValues()	A list of possible values of the corresponding TagKey of an LF-tag key-value pair.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCatalogId

@Stability(Stable)
@NotNull
String getCatalogId()

The identifier for the Data Catalog .

By default, it is the account ID of the caller.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-lftagpair.html#cfn-lakeformation-tagassociation-lftagpair-catalogid

getTagKey

@Stability(Stable)
@NotNull
String getTagKey()

The key-name for the LF-tag.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-lftagpair.html#cfn-lakeformation-tagassociation-lftagpair-tagkey

getTagValues

@Stability(Stable)
@NotNull
List<String> getTagValues()

A list of possible values of the corresponding TagKey of an LF-tag key-value pair.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lakeformation-tagassociation-lftagpair.html#cfn-lakeformation-tagassociation-lftagpair-tagvalues

builder

@Stability(Stable)
static CfnTagAssociation.LFTagPairProperty.Builder builder()

Returns:

a CfnTagAssociation.LFTagPairProperty.Builder of CfnTagAssociation.LFTagPairProperty