You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::LakeFormation::Types::GrantPermissionsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::LakeFormation::Types::GrantPermissionsRequest
- Defined in:
- (unknown)
Overview
When passing GrantPermissionsRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
catalog_id: "CatalogIdString",
principal: { # required
data_lake_principal_identifier: "DataLakePrincipalString",
},
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
},
},
permissions: ["ALL"], # required, accepts ALL, SELECT, ALTER, DROP, DELETE, INSERT, DESCRIBE, CREATE_DATABASE, CREATE_TABLE, DATA_LOCATION_ACCESS
permissions_with_grant_option: ["ALL"], # accepts ALL, SELECT, ALTER, DROP, DELETE, INSERT, DESCRIBE, CREATE_DATABASE, CREATE_TABLE, DATA_LOCATION_ACCESS
}
Instance Attribute Summary collapse
-
#catalog_id ⇒ String
The identifier for the Data Catalog.
-
#permissions ⇒ Array<String>
The permissions granted to the principal on the resource.
-
#permissions_with_grant_option ⇒ Array<String>
Indicates a list of the granted permissions that the principal may pass to other users.
-
#principal ⇒ Types::DataLakePrincipal
The principal to be granted the permissions on the resource.
-
#resource ⇒ Types::Resource
The resource to which permissions are to be granted.
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 AWS Lake Formation environment.
#permissions ⇒ Array<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.
#permissions_with_grant_option ⇒ Array<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
.
#principal ⇒ Types::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.
#resource ⇒ Types::Resource
The resource to which permissions are to be granted. Resources in AWS Lake Formation are the Data Catalog, databases, and tables.