Class: Aws::LakeFormation::Types::GetResourceLFTagsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb

Overview

Note:

When making an API call, you may pass GetResourceLFTagsRequest data as a hash:

{
  catalog_id: "CatalogIdString",
  resource: { # required
    catalog: {
    },
    database: {
      catalog_id: "CatalogIdString",
      name: "NameString", # required
    },
    table: {
      catalog_id: "CatalogIdString",
      database_name: "NameString", # required
      name: "NameString",
      table_wildcard: {
      },
    },
    table_with_columns: {
      catalog_id: "CatalogIdString",
      database_name: "NameString", # required
      name: "NameString", # required
      column_names: ["NameString"],
      column_wildcard: {
        excluded_column_names: ["NameString"],
      },
    },
    data_location: {
      catalog_id: "CatalogIdString",
      resource_arn: "ResourceArnString", # required
    },
    data_cells_filter: {
      table_catalog_id: "CatalogIdString",
      database_name: "NameString",
      table_name: "NameString",
      name: "NameString",
    },
    lf_tag: {
      catalog_id: "CatalogIdString",
      tag_key: "NameString", # required
      tag_values: ["LFTagValue"], # required
    },
    lf_tag_policy: {
      catalog_id: "CatalogIdString",
      resource_type: "DATABASE", # required, accepts DATABASE, TABLE
      expression: [ # required
        {
          tag_key: "LFTagKey", # required
          tag_values: ["LFTagValue"], # required
        },
      ],
    },
  },
  show_assigned_lf_tags: false,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_idString

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

Returns:

  • (String)


1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1771

class GetResourceLFTagsRequest < Struct.new(
  :catalog_id,
  :resource,
  :show_assigned_lf_tags)
  SENSITIVE = []
  include Aws::Structure
end

#resourceTypes::Resource

The database, table, or column resource for which you want to return LF-tags.

Returns:



1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1771

class GetResourceLFTagsRequest < Struct.new(
  :catalog_id,
  :resource,
  :show_assigned_lf_tags)
  SENSITIVE = []
  include Aws::Structure
end

#show_assigned_lf_tagsBoolean

Indicates whether to show the assigned LF-tags.

Returns:

  • (Boolean)


1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 1771

class GetResourceLFTagsRequest < Struct.new(
  :catalog_id,
  :resource,
  :show_assigned_lf_tags)
  SENSITIVE = []
  include Aws::Structure
end