Package-level declarations

Types

Link copied to clipboard
class DataCellsFilter : KotlinCustomResource

Resource for managing an AWS Lake Formation Data Cells Filter.

Link copied to clipboard
data class DataCellsFilterArgs(val tableData: Output<DataCellsFilterTableDataArgs>? = null, val timeouts: Output<DataCellsFilterTimeoutsArgs>? = null) : ConvertibleToJava<DataCellsFilterArgs>

Resource for managing an AWS Lake Formation Data Cells Filter.

Link copied to clipboard
object DataCellsFilterMapper : ResourceMapper<DataCellsFilter>
Link copied to clipboard
class DataLakeSettings : KotlinCustomResource

Manages Lake Formation principals designated as data lake administrators and lists of principal permission entries for default create database and default create table permissions.

Link copied to clipboard
data class DataLakeSettingsArgs(val admins: Output<List<String>>? = null, val allowExternalDataFiltering: Output<Boolean>? = null, val allowFullTableExternalDataAccess: Output<Boolean>? = null, val authorizedSessionTagValueLists: Output<List<String>>? = null, val catalogId: Output<String>? = null, val createDatabaseDefaultPermissions: Output<List<DataLakeSettingsCreateDatabaseDefaultPermissionArgs>>? = null, val createTableDefaultPermissions: Output<List<DataLakeSettingsCreateTableDefaultPermissionArgs>>? = null, val externalDataFilteringAllowLists: Output<List<String>>? = null, val parameters: Output<Map<String, String>>? = null, val readOnlyAdmins: Output<List<String>>? = null, val trustedResourceOwners: Output<List<String>>? = null) : ConvertibleToJava<DataLakeSettingsArgs>

Manages Lake Formation principals designated as data lake administrators and lists of principal permission entries for default create database and default create table permissions.

Link copied to clipboard
object DataLakeSettingsMapper : ResourceMapper<DataLakeSettings>
Link copied to clipboard
Link copied to clipboard
class LfTag : KotlinCustomResource

Creates an LF-Tag with the specified name and values. Each key must have at least one value. The maximum number of values permitted is 1000.

Link copied to clipboard
data class LfTagArgs(val catalogId: Output<String>? = null, val key: Output<String>? = null, val values: Output<List<String>>? = null) : ConvertibleToJava<LfTagArgs>

Creates an LF-Tag with the specified name and values. Each key must have at least one value. The maximum number of values permitted is 1000.

Link copied to clipboard

Builder for LfTagArgs.

Link copied to clipboard
object LfTagMapper : ResourceMapper<LfTag>
Link copied to clipboard

Builder for LfTag.

Link copied to clipboard
class OptIn : KotlinCustomResource

Resource for managing an AWS Lake Formation Opt In.

Link copied to clipboard
data class OptInArgs(val conditions: Output<List<OptInConditionArgs>>? = null, val principals: Output<List<OptInPrincipalArgs>>? = null, val resourceDatas: Output<List<OptInResourceDataArgs>>? = null) : ConvertibleToJava<OptInArgs>

Resource for managing an AWS Lake Formation Opt In.

Link copied to clipboard

Builder for OptInArgs.

Link copied to clipboard
object OptInMapper : ResourceMapper<OptIn>
Link copied to clipboard

Builder for OptIn.

Link copied to clipboard
class Permissions : KotlinCustomResource

Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Permissions are granted to a principal, in a Data Catalog, relative to a Lake Formation resource, which includes the Data Catalog, databases, tables, LF-tags, and LF-tag policies. For more information, see Security and Access Control to Metadata and Data in Lake Formation. !>WARNING: Lake Formation permissions are not in effect by default within AWS. Using this resource will not secure your data and will result in errors if you do not change the security settings for existing resources and the default security settings for new resources. See Default Behavior and IAMAllowedPrincipals for additional details.

Link copied to clipboard
data class PermissionsArgs(val catalogId: Output<String>? = null, val catalogResource: Output<Boolean>? = null, val dataCellsFilter: Output<PermissionsDataCellsFilterArgs>? = null, val dataLocation: Output<PermissionsDataLocationArgs>? = null, val database: Output<PermissionsDatabaseArgs>? = null, val lfTag: Output<PermissionsLfTagArgs>? = null, val lfTagPolicy: Output<PermissionsLfTagPolicyArgs>? = null, val permissions: Output<List<String>>? = null, val permissionsWithGrantOptions: Output<List<String>>? = null, val principal: Output<String>? = null, val table: Output<PermissionsTableArgs>? = null, val tableWithColumns: Output<PermissionsTableWithColumnsArgs>? = null) : ConvertibleToJava<PermissionsArgs>

Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. Permissions are granted to a principal, in a Data Catalog, relative to a Lake Formation resource, which includes the Data Catalog, databases, tables, LF-tags, and LF-tag policies. For more information, see Security and Access Control to Metadata and Data in Lake Formation. !>WARNING: Lake Formation permissions are not in effect by default within AWS. Using this resource will not secure your data and will result in errors if you do not change the security settings for existing resources and the default security settings for new resources. See Default Behavior and IAMAllowedPrincipals for additional details.

Link copied to clipboard
Link copied to clipboard
object PermissionsMapper : ResourceMapper<Permissions>
Link copied to clipboard
Link copied to clipboard
class Resource : KotlinCustomResource

Registers a Lake Formation resource (e.g., S3 bucket) as managed by the Data Catalog. In other words, the S3 path is added to the data lake. Choose a role that has read/write access to the chosen Amazon S3 path or use the service-linked role. When you register the S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.

Link copied to clipboard
data class ResourceArgs(val arn: Output<String>? = null, val hybridAccessEnabled: Output<Boolean>? = null, val roleArn: Output<String>? = null, val useServiceLinkedRole: Output<Boolean>? = null, val withFederation: Output<Boolean>? = null) : ConvertibleToJava<ResourceArgs>

Registers a Lake Formation resource (e.g., S3 bucket) as managed by the Data Catalog. In other words, the S3 path is added to the data lake. Choose a role that has read/write access to the chosen Amazon S3 path or use the service-linked role. When you register the S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.

Link copied to clipboard
Link copied to clipboard
class ResourceLfTag : KotlinCustomResource

Resource for managing an AWS Lake Formation Resource LF Tag.

Link copied to clipboard
data class ResourceLfTagArgs(val catalogId: Output<String>? = null, val database: Output<ResourceLfTagDatabaseArgs>? = null, val lfTag: Output<ResourceLfTagLfTagArgs>? = null, val table: Output<ResourceLfTagTableArgs>? = null, val tableWithColumns: Output<ResourceLfTagTableWithColumnsArgs>? = null, val timeouts: Output<ResourceLfTagTimeoutsArgs>? = null) : ConvertibleToJava<ResourceLfTagArgs>

Resource for managing an AWS Lake Formation Resource LF Tag.

Link copied to clipboard
Link copied to clipboard
object ResourceLfTagMapper : ResourceMapper<ResourceLfTag>
Link copied to clipboard
Link copied to clipboard
class ResourceLfTags : KotlinCustomResource

Manages an attachment between one or more existing LF-tags and an existing Lake Formation resource.

Link copied to clipboard
data class ResourceLfTagsArgs(val catalogId: Output<String>? = null, val database: Output<ResourceLfTagsDatabaseArgs>? = null, val lfTags: Output<List<ResourceLfTagsLfTagArgs>>? = null, val table: Output<ResourceLfTagsTableArgs>? = null, val tableWithColumns: Output<ResourceLfTagsTableWithColumnsArgs>? = null) : ConvertibleToJava<ResourceLfTagsArgs>

Manages an attachment between one or more existing LF-tags and an existing Lake Formation resource.

Link copied to clipboard
Link copied to clipboard
object ResourceLfTagsMapper : ResourceMapper<ResourceLfTags>
Link copied to clipboard
object ResourceMapper : ResourceMapper<Resource>
Link copied to clipboard

Functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun lfTag(name: String): LfTag
suspend fun lfTag(name: String, block: suspend LfTagResourceBuilder.() -> Unit): LfTag
Link copied to clipboard
fun optIn(name: String): OptIn
suspend fun optIn(name: String, block: suspend OptInResourceBuilder.() -> Unit): OptIn
Link copied to clipboard
suspend fun permissions(name: String, block: suspend PermissionsResourceBuilder.() -> Unit): Permissions
Link copied to clipboard
suspend fun resource(name: String, block: suspend ResourceResourceBuilder.() -> Unit): Resource
Link copied to clipboard
Link copied to clipboard