Class: Aws::LakeFormation::Types::BatchGrantPermissionsRequest

Inherits:

Struct

Object
Struct
Aws::LakeFormation::Types::BatchGrantPermissionsRequest

show all

Defined in:: gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb

Overview

Note:

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

{
  catalog_id: "CatalogIdString",
  entries: [ # required
    {
      id: "Identifier", # required
      principal: {
        data_lake_principal_identifier: "DataLakePrincipalString",
      },
      resource: {
        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
            },
          ],
        },
      },
      permissions: ["ALL"], # accepts ALL, SELECT, ALTER, DROP, DELETE, INSERT, DESCRIBE, CREATE_DATABASE, CREATE_TABLE, DATA_LOCATION_ACCESS, CREATE_TAG, ASSOCIATE
      permissions_with_grant_option: ["ALL"], # accepts ALL, SELECT, ALTER, DROP, DELETE, INSERT, DESCRIBE, CREATE_DATABASE, CREATE_TABLE, DATA_LOCATION_ACCESS, CREATE_TAG, ASSOCIATE
    },
  ],
}

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#catalog_id ⇒ String
The identifier for the Data Catalog.
#entries ⇒ Array<Types::BatchPermissionsRequestEntry>
A list of up to 20 entries for resource permissions to be granted by batch operation to the principal.

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)

# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 299

class BatchGrantPermissionsRequest < Struct.new(
  :catalog_id,
  :entries)
  SENSITIVE = []
  include Aws::Structure
end

#entries ⇒ `Array<Types::BatchPermissionsRequestEntry>`

A list of up to 20 entries for resource permissions to be granted by batch operation to the principal.