Class: Aws::LakeFormation::Types::AddLFTagsToResourceRequest

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 AddLFTagsToResourceRequest 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
        },
      ],
    },
  },
  lf_tags: [ # required
    {
      catalog_id: "CatalogIdString",
      tag_key: "LFTagKey", # required
      tag_values: ["LFTagValue"], # required
    },
  ],
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_id ⇒ String

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) 


108
109
110
111
112
113
114
 
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 108

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

#lf_tags ⇒ Array<Types::LFTagPair>

The LF-tags to attach to the resource.

Returns:



108
109
110
111
112
113
114
 
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 108

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

#resource ⇒ Types::Resource

The database, table, or column resource to which to attach an LF-tag.

Returns:



108
109
110
111
112
113
114
 
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 108

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