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
    },
    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
    },
  ],
}

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

Returns:

  • (String)


101
102
103
104
105
106
107
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 101

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

#lf_tagsArray<Types::LFTagPair>

The tags to attach to the resource.

Returns:



101
102
103
104
105
106
107
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 101

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

#resourceTypes::Resource

The resource to which to attach a tag.

Returns:



101
102
103
104
105
106
107
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 101

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