Package software.amazon.awscdk.services.lakeformation

Class CfnTag

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.lakeformation.CfnTag
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:58.433Z") @Stability(Stable) public class CfnTag extends CfnResource implements IInspectable
A CloudFormation 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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lakeformation.*;
 CfnTag cfnTag = CfnTag.Builder.create(this, "MyCfnTag")
         .tagKey("tagKey")
         .tagValues(List.of("tagValues"))
         // the properties below are optional
         .catalogId("catalogId")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTag

      protected CfnTag(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTag

      protected CfnTag(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTag

      @Stability(Stable) public CfnTag(@NotNull Construct scope, @NotNull String id, @NotNull CfnTagProps props)
      Create a new AWS::LakeFormation::Tag.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTagKey

      @Stability(Stable) @NotNull public String getTagKey()
      UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .

      The key-name for the LF-tag.

    • setTagKey

      @Stability(Stable) public void setTagKey(@NotNull String value)
      UTF-8 string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .

      The key-name for the LF-tag.

    • getTagValues

      @Stability(Stable) @NotNull public List<String> getTagValues()
      An array of UTF-8 strings, not less than 1 or more than 50 strings.

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

    • setTagValues

      @Stability(Stable) public void setTagValues(@NotNull List<String> value)
      An array of UTF-8 strings, not less than 1 or more than 50 strings.

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

    • getCatalogId

      @Stability(Stable) @Nullable public String getCatalogId()
      Catalog id string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .

      The 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 AWS Lake Formation environment.

    • setCatalogId

      @Stability(Stable) public void setCatalogId(@Nullable String value)
      Catalog id string, not less than 1 or more than 255 bytes long, matching the single-line string pattern .

      The 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 AWS Lake Formation environment.