Class: Aws::LakeFormation::Types::GrantPermissionsRequest

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 GrantPermissionsRequest data as a hash:

{
  catalog_id: "CatalogIdString",
  principal: { # required
    data_lake_principal_identifier: "DataLakePrincipalString",
  },
  resource: { # required
    catalog: {
    },
    database: {
      name: "NameString", # required
    },
    table: {
      database_name: "NameString", # required
      name: "NameString", # required
    },
    table_with_columns: {
      database_name: "NameString",
      name: "NameString",
      column_names: ["NameString"],
      column_wildcard: {
        excluded_column_names: ["NameString"],
      },
    },
    data_location: {
      resource_arn: "ResourceArnString", # required
    },
  },
  permissions: ["ALL"], # required, accepts ALL, SELECT, ALTER, DROP, DELETE, INSERT, CREATE_DATABASE, CREATE_TABLE, DATA_LOCATION_ACCESS
  permissions_with_grant_option: ["ALL"], # accepts ALL, SELECT, ALTER, DROP, DELETE, INSERT, CREATE_DATABASE, CREATE_TABLE, DATA_LOCATION_ACCESS
}

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)


688
689
690
691
692
693
694
695
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 688

class GrantPermissionsRequest < Struct.new(
  :catalog_id,
  :principal,
  :resource,
  :permissions,
  :permissions_with_grant_option)
  include Aws::Structure
end

#permissionsArray<String>

The permissions granted to the principal on the resource. AWS Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. AWS Lake Formation requires that each principal be authorized to perform a specific task on AWS Lake Formation resources.

Returns:

  • (Array<String>)


688
689
690
691
692
693
694
695
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 688

class GrantPermissionsRequest < Struct.new(
  :catalog_id,
  :principal,
  :resource,
  :permissions,
  :permissions_with_grant_option)
  include Aws::Structure
end

#permissions_with_grant_optionArray<String>

Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.

Returns:

  • (Array<String>)


688
689
690
691
692
693
694
695
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 688

class GrantPermissionsRequest < Struct.new(
  :catalog_id,
  :principal,
  :resource,
  :permissions,
  :permissions_with_grant_option)
  include Aws::Structure
end

#principalTypes::DataLakePrincipal

The principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles, and they are defined by their principal type and their ARN.

Note that if you define a resource with a particular ARN, then later delete, and recreate a resource with that same ARN, the resource maintains the permissions already granted.



688
689
690
691
692
693
694
695
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 688

class GrantPermissionsRequest < Struct.new(
  :catalog_id,
  :principal,
  :resource,
  :permissions,
  :permissions_with_grant_option)
  include Aws::Structure
end

#resourceTypes::Resource

The resource to which permissions are to be granted. Resources in AWS Lake Formation are the Data Catalog, databases, and tables.

Returns:



688
689
690
691
692
693
694
695
# File 'gems/aws-sdk-lakeformation/lib/aws-sdk-lakeformation/types.rb', line 688

class GrantPermissionsRequest < Struct.new(
  :catalog_id,
  :principal,
  :resource,
  :permissions,
  :permissions_with_grant_option)
  include Aws::Structure
end