lakeformation library
AWS Lake Formation.
Classes
-
AppConstant<
T> -
A value the Stack hands to application code as a
static constin the generated AppExports file — known when synth runs, so the app compiles against it. - AppExports
-
Where synth writes the Dart file application code imports: the Stack's
constants, as the
static constmembers of<name>Constants, and a typed reader of its Terraform outputs,<name>Outputs. -
AttributeRef<
T> -
Public for sealed pattern matching, but constructor is private — only
TfRef.attribute()may construct instances. - AwsLakeformationDataCellsFilter
-
Factory wrapper for
aws_lakeformation_data_cells_filter. - AwsLakeformationDataLakeSettings
-
Factory wrapper for
aws_lakeformation_data_lake_settings. - AwsLakeformationIdentityCenterConfiguration
-
Factory wrapper for
aws_lakeformation_identity_center_configuration. - AwsLakeformationLfTag
-
Factory wrapper for
aws_lakeformation_lf_tag. - AwsLakeformationLfTagExpression
-
Factory wrapper for
aws_lakeformation_lf_tag_expression. - AwsLakeformationOptIn
-
Factory wrapper for
aws_lakeformation_opt_in. - AwsLakeformationPermissions
-
Factory wrapper for
aws_lakeformation_permissions. - AwsLakeformationResource
-
Factory wrapper for
aws_lakeformation_resource. - AwsLakeformationResourceLfTag
-
Factory wrapper for
aws_lakeformation_resource_lf_tag. - AwsLakeformationResourceLfTags
-
Factory wrapper for
aws_lakeformation_resource_lf_tags. - DartDefineOutput
-
An
outputwhose value is the client build's--dart-definefile, registered withStack.addDartDefineOutput. - Data
-
Base of every user-instantiable Terraform
datablock. - DataAwsLakeformationDataLakeSettings
-
Factory wrapper for
aws_lakeformation_data_lake_settings. - DataAwsLakeformationPermissions
-
Factory wrapper for
aws_lakeformation_permissions. - DataAwsLakeformationResource
-
Factory wrapper for
aws_lakeformation_resource. - DataLakeformationPermissionsDatabase
-
Typed helper for the
databaseblock ofaws_lakeformation_permissions(derived from provider schema). - DataLakeformationPermissionsDataCellsFilter
-
Typed helper for the
data_cells_filterblock ofaws_lakeformation_permissions(derived from provider schema). - DataLakeformationPermissionsDataLocation
-
Typed helper for the
data_locationblock ofaws_lakeformation_permissions(derived from provider schema). - DataLakeformationPermissionsExpression
-
Typed helper for the
lf_tag_policy.expressionblock ofaws_lakeformation_permissions(derived from provider schema). - DataLakeformationPermissionsLfTag
-
Typed helper for the
lf_tagblock ofaws_lakeformation_permissions(derived from provider schema). - DataLakeformationPermissionsLfTagPolicy
-
Typed helper for the
lf_tag_policyblock ofaws_lakeformation_permissions(derived from provider schema). - DataLakeformationPermissionsTable
-
Typed helper for the
tableblock ofaws_lakeformation_permissions(derived from provider schema). - DataLakeformationPermissionsTableWithColumns
-
Typed helper for the
table_with_columnsblock ofaws_lakeformation_permissions(derived from provider schema). -
DataRef<
T> -
Public for sealed pattern matching, but constructor is private — only
TfRef.data()may construct instances. - EnvironmentConstant
- The AppConstant.fromEnvironment choice.
- GcsBackend
-
terraform { backend "gcs" { ... } }configuration. - IgnoreAllChanges
- IgnoreChanges.all.
- IgnoreAttributes
- IgnoreChanges.of.
- IgnoreChanges
-
What
ignore_changescovers: every attribute, or the listed ones. - InvalidDartDefineOutput
-
An output of
Stack.addDartDefineOutputthat cannot carry what it names: an output that is not registered, is sensitive or has no environment value, two outputs read from one variable, or no output at all. - InvalidLifecycle
-
A
lifecycleblock Terraform rejects: a data source (or one of its attributes) inreplaceTriggeredBy,allinside IgnoreChanges.of, or a condition with an empty error message. - InvalidMoveTarget
-
A
movedblock whosetonames no resource of the Stack. - InvalidTimeout
-
A negative
timeoutsduration. - LakeformationDataCellsFilterAllRowsWildcard
-
Typed helper for the
table_data.row_filter.all_rows_wildcardblock ofaws_lakeformation_data_cells_filter(derived from provider schema). - LakeformationDataCellsFilterColumn
-
Exactly one of
column_names,column_wildcardon thetable_datablock ofaws_lakeformation_data_cells_filter: the provider rejects none and more than one, so each variant sets one of them. - LakeformationDataCellsFilterColumnNames
-
The LakeformationDataCellsFilterColumn.columnNames choice: sets
column_names. - LakeformationDataCellsFilterColumnWildcard
-
Typed helper for the
table_data.column_wildcardblock ofaws_lakeformation_data_cells_filter(derived from provider schema). - LakeformationDataCellsFilterColumnWildcardChoice
-
The LakeformationDataCellsFilterColumn.columnWildcard choice: sets
column_wildcard. - LakeformationDataCellsFilterRowFilter
-
Exactly one of
all_rows_wildcard,filter_expressionon thetable_data.row_filterblock ofaws_lakeformation_data_cells_filter: the provider rejects none and more than one, so each variant sets one of them. - LakeformationDataCellsFilterRowFilterAllRowsWildcard
-
The LakeformationDataCellsFilterRowFilter.allRowsWildcard choice: sets
all_rows_wildcard. - LakeformationDataCellsFilterRowFilterExpression
-
The LakeformationDataCellsFilterRowFilter.filterExpression choice: sets
filter_expression. - LakeformationDataCellsFilterTableData
-
Typed helper for the
table_datablock ofaws_lakeformation_data_cells_filter(derived from provider schema). - LakeformationDataLakeSettingsCreateDatabaseDefaultPermissions
-
Typed helper for the
create_database_default_permissionsblock ofaws_lakeformation_data_lake_settings(derived from provider schema). - LakeformationDataLakeSettingsCreateTableDefaultPermissions
-
Typed helper for the
create_table_default_permissionsblock ofaws_lakeformation_data_lake_settings(derived from provider schema). - LakeformationLfTagExpression
-
Typed helper for the
expressionblock ofaws_lakeformation_lf_tag_expression(derived from provider schema). - LakeformationOptInCatalog
-
Typed helper for the
resource_data.catalogblock ofaws_lakeformation_opt_in(derived from provider schema). - LakeformationOptInColumnWildcard
-
Typed helper for the
resource_data.table_with_columns.column_wildcardblock ofaws_lakeformation_opt_in(derived from provider schema). - LakeformationOptInCondition
-
Typed helper for the
conditionblock ofaws_lakeformation_opt_in(derived from provider schema). - LakeformationOptInDatabase
-
Typed helper for the
resource_data.databaseblock ofaws_lakeformation_opt_in(derived from provider schema). - LakeformationOptInDataCellsFilter
-
Typed helper for the
resource_data.data_cells_filterblock ofaws_lakeformation_opt_in(derived from provider schema). - LakeformationOptInDataLocation
-
Typed helper for the
resource_data.data_locationblock ofaws_lakeformation_opt_in(derived from provider schema). - LakeformationOptInLfTag
-
Typed helper for the
resource_data.lf_tagblock ofaws_lakeformation_opt_in(derived from provider schema). - LakeformationOptInLfTagExpression
-
Typed helper for the
resource_data.lf_tag_expressionblock ofaws_lakeformation_opt_in(derived from provider schema). - LakeformationOptInLfTagPolicy
-
Typed helper for the
resource_data.lf_tag_policyblock ofaws_lakeformation_opt_in(derived from provider schema). - LakeformationOptInPrincipal
-
Typed helper for the
principalblock ofaws_lakeformation_opt_in(derived from provider schema). - LakeformationOptInResourceData
-
Exactly one of
catalog,data_cells_filter,data_location,database,lf_tag,lf_tag_expression,lf_tag_policy,table,table_with_columnson theresource_datablock ofaws_lakeformation_opt_in: the provider rejects none and more than one, so each variant sets one of them. - LakeformationOptInResourceDataCatalog
-
The LakeformationOptInResourceData.catalog choice: sets
catalog. - LakeformationOptInResourceDataCellsFilter
-
The LakeformationOptInResourceData.dataCellsFilter choice: sets
data_cells_filter. - LakeformationOptInResourceDataDatabase
-
The LakeformationOptInResourceData.database choice: sets
database. - LakeformationOptInResourceDataLfTag
-
The LakeformationOptInResourceData.lfTag choice: sets
lf_tag. - LakeformationOptInResourceDataLfTagExpression
-
The LakeformationOptInResourceData.lfTagExpression choice: sets
lf_tag_expression. - LakeformationOptInResourceDataLfTagPolicy
-
The LakeformationOptInResourceData.lfTagPolicy choice: sets
lf_tag_policy. - LakeformationOptInResourceDataLocation
-
The LakeformationOptInResourceData.dataLocation choice: sets
data_location. - LakeformationOptInResourceDataTable
-
The LakeformationOptInResourceData.table choice: sets
table. - LakeformationOptInResourceDataTableWithColumns
-
The LakeformationOptInResourceData.tableWithColumns choice: sets
table_with_columns. - LakeformationOptInTable
-
Typed helper for the
resource_data.tableblock ofaws_lakeformation_opt_in(derived from provider schema). - LakeformationOptInTableWithColumns
-
Typed helper for the
resource_data.table_with_columnsblock ofaws_lakeformation_opt_in(derived from provider schema). - LakeformationPermissionsCatalogResource
-
The LakeformationPermissionsResource.catalogResource choice: sets
catalog_resource. - LakeformationPermissionsDatabase
-
Typed helper for the
databaseblock ofaws_lakeformation_permissions(derived from provider schema). - LakeformationPermissionsDataCellsFilter
-
Typed helper for the
data_cells_filterblock ofaws_lakeformation_permissions(derived from provider schema). - LakeformationPermissionsDataLocation
-
Typed helper for the
data_locationblock ofaws_lakeformation_permissions(derived from provider schema). - LakeformationPermissionsExpression
-
Typed helper for the
lf_tag_policy.expressionblock ofaws_lakeformation_permissions(derived from provider schema). - LakeformationPermissionsLfTag
-
Typed helper for the
lf_tagblock ofaws_lakeformation_permissions(derived from provider schema). - LakeformationPermissionsLfTagPolicy
-
Typed helper for the
lf_tag_policyblock ofaws_lakeformation_permissions(derived from provider schema). - LakeformationPermissionsResource
-
Exactly one of
catalog_resource,data_cells_filter,data_location,database,lf_tag,lf_tag_policy,table,table_with_columnsonaws_lakeformation_permissions: the provider rejects none and more than one, so each variant sets one of them. - LakeformationPermissionsResourceDatabase
-
The LakeformationPermissionsResource.database choice: sets
database. - LakeformationPermissionsResourceDataCellsFilter
-
The LakeformationPermissionsResource.dataCellsFilter choice: sets
data_cells_filter. - LakeformationPermissionsResourceDataLocation
-
The LakeformationPermissionsResource.dataLocation choice: sets
data_location. - LakeformationPermissionsResourceLfTag
-
The LakeformationPermissionsResource.lfTag choice: sets
lf_tag. - LakeformationPermissionsResourceLfTagPolicy
-
The LakeformationPermissionsResource.lfTagPolicy choice: sets
lf_tag_policy. - LakeformationPermissionsResourceTable
-
The LakeformationPermissionsResource.table choice: sets
table. - LakeformationPermissionsResourceTableWithColumns
-
The LakeformationPermissionsResource.tableWithColumns choice: sets
table_with_columns. - LakeformationPermissionsTable
-
Typed helper for the
tableblock ofaws_lakeformation_permissions(derived from provider schema). - LakeformationPermissionsTableWithColumns
-
Typed helper for the
table_with_columnsblock ofaws_lakeformation_permissions(derived from provider schema). - LakeformationResourceLfTag
-
Typed helper for the
lf_tagblock ofaws_lakeformation_resource_lf_tag(derived from provider schema). - LakeformationResourceLfTagColumnWildcard
-
Typed helper for the
table_with_columns.column_wildcardblock ofaws_lakeformation_resource_lf_tag(derived from provider schema). - LakeformationResourceLfTagDatabase
-
Typed helper for the
databaseblock ofaws_lakeformation_resource_lf_tag(derived from provider schema). - LakeformationResourceLfTagResource
-
Exactly one of
database,table,table_with_columnsonaws_lakeformation_resource_lf_tag: the provider rejects none and more than one, so each variant sets one of them. - LakeformationResourceLfTagResourceDatabase
-
The LakeformationResourceLfTagResource.database choice: sets
database. - LakeformationResourceLfTagResourceTable
-
The LakeformationResourceLfTagResource.table choice: sets
table. - LakeformationResourceLfTagResourceTableWithColumns
-
The LakeformationResourceLfTagResource.tableWithColumns choice: sets
table_with_columns. - LakeformationResourceLfTagsDatabase
-
Typed helper for the
databaseblock ofaws_lakeformation_resource_lf_tags(derived from provider schema). - LakeformationResourceLfTagsLfTag
-
Typed helper for the
lf_tagblock ofaws_lakeformation_resource_lf_tags(derived from provider schema). - LakeformationResourceLfTagsResource
-
Exactly one of
database,table,table_with_columnsonaws_lakeformation_resource_lf_tags: the provider rejects none and more than one, so each variant sets one of them. - LakeformationResourceLfTagsResourceDatabase
-
The LakeformationResourceLfTagsResource.database choice: sets
database. - LakeformationResourceLfTagsResourceTable
-
The LakeformationResourceLfTagsResource.table choice: sets
table. - LakeformationResourceLfTagsResourceTableWithColumns
-
The LakeformationResourceLfTagsResource.tableWithColumns choice: sets
table_with_columns. - LakeformationResourceLfTagsTable
-
Typed helper for the
tableblock ofaws_lakeformation_resource_lf_tags(derived from provider schema). - LakeformationResourceLfTagsTableWithColumns
-
Typed helper for the
table_with_columnsblock ofaws_lakeformation_resource_lf_tags(derived from provider schema). - LakeformationResourceLfTagTable
-
Typed helper for the
tableblock ofaws_lakeformation_resource_lf_tag(derived from provider schema). - LakeformationResourceLfTagTableWithColumns
-
Typed helper for the
table_with_columnsblock ofaws_lakeformation_resource_lf_tag(derived from provider schema). - LifecycleCondition
-
A
preconditionorpostconditionblock: Terraform fails the plan (LifecycleCondition.pre) or the apply (LifecycleCondition.post) with errorMessage when condition is false. - LifecycleOptions
-
lifecycle { ... }block on a resource. - LocalBackend
-
terraform { backend "local" { ... } }configuration. - MissingProvider
-
A block needs a provider configuration the Stack does not register:
the provider its type implies (
googleforgoogle_pubsub_topic), the one itsprovidermeta-argument names, or one a module call passes on. - ModuleCall
-
A
module "<localName>" { ... }call as a Dart value. - NoProviders
- The Stack registers no provider, but declares resources or data sources.
- ProviderConflict
- Two provider registrations Terraform rejects together: two defaults of one name, a repeated alias, an alias that is not an identifier, or configurations of one name with different source / version constraints.
-
RefConstant<
T> - The AppConstant.ref choice.
- ReplaceTrigger
-
What
lifecycle.replaceTriggeredBylists: a resource of the Stack or an attribute getter of one.Resourceand TfRef implement it; synth reports a data source or a data-source attribute as anInvalidLifecycle. - Resource
- Base of every user-instantiable Terraform resource.
- ResourceRef
-
Public for sealed pattern matching, but constructor is private — only
TfRef.resource()may construct instances. - S3Backend
-
terraform { backend "s3" { ... } }configuration. -
Sensitive<
T> -
What an argument Terraform marks sensitive takes: a variable, an
expression or an attribute getter — a value Terraform resolves, never a
Dart literal that would be written into
main.tf.json. - SensitiveLiteral
-
A sensitive field is set to a literal, which would write the secret in
plain text into
main.tf.json. - Stack
- User-extended IaC composition root.
- StackBackend
-
Lightweight backend hook. Core ships
GcsBackend,S3Backend, andLocalBackend; anything else implements this interface in the caller. TheStackonly stores the value and exposes a discriminator for synth'sterraform { backend ... }emitter. - StackProvider
-
Coordination interface between
Stack(in this package) and concrete providers (e.g.GoogleProviderinterradart_google). Concrete providers implement every getter using their baked-in constants from Stage 2 codegen. - SynthIssue
- One reason a Stack cannot be synthesized.
- SynthResult
-
Bundle returned by
StackSynth.synth. - TfAddressed
-
Anything that exposes a Terraform address, e.g.
google_pubsub_topic.orders. -
TfArg<
T> - A Terraform argument: a Dart-side literal, a reference to another block's attribute (TfRef), a variable or a raw expression.
-
TfArgExpression<
T> - A raw Terraform expression — the tf.json template string, verbatim.
-
TfArgLiteral<
T> -
TfArgVariable<
T> - TfCollectionType
-
list(...),set(...)ormap(...). - TfMoved
-
One
moved { from = ... to = ... }block: the state object at from now belongs to the resource at to, so a rename does not become a destroy-and-create. - TfObjectType
-
object({ ... }). - TfOptionalType
-
optional(<type>[, <default>]). -
TfOutput<
T> -
An
output "<name>" { value = ... }block, registered withStack.addOutput. - TfPrimitiveType
-
string,number,boolorany. -
TfRef<
T> - A Terraform-side reference: an attribute of a resource (AttributeRef) or a data source (DataRef), or a whole resource (ResourceRef).
- TfTimeouts
-
timeouts { ... }on a resource or data source: how long Terraform waits for each operation before giving up. - TfTupleType
-
tuple([...]). - TfType
-
A Terraform type constraint:
string,list(number),object({ name = string }). - TfVariable
-
One
variable "<name>" { ... }declaration. - UndeclaredVariable
-
A
TfArg.variableorvar.<name>in an expression names a variable the Stack does not declare. - UnregisteredReference
-
A block references another block that was never registered on the
Stack: built, but not passed to
add(...)/addModule(...). - UnresolvableConstant
-
An
AppConstant.refwhose value is not known at synth: the attribute is not set to a literal, is sensitive, does not match the constant's type, or belongs to a block that is not registered. -
ValueConstant<
T> - The AppConstant.value choice.
Enums
- ResourceKind
-
Whether a Stack entry is a
resourceblock or adatablock in Terraform JSON.
Extension Types
- LakeformationDataLakeSettingsPermissions
-
permissions— derived from the provider schema description. - LakeformationPermissions
-
Lakeformation enum for
permissions. - LakeformationPermissionsResourceType
-
resource_type— derived from the provider schema description. - LakeformationPermissionsWithGrantOption
-
Lakeformation Permissions With Grant enum for
permissions_with_grant_option. - OutputEnvironment
-
The environment
Stack.outputEnvironmentreturns: each variable and its value, in registration order. - RefTo
-
A reference to a resource of type
R, for an argument that names another resource (network,vpc_id,role_arn, ...).
Extensions
-
RefToList
on TfArg<
List< RefTo< >R> > -
A list-valued reference argument (
security_group_ids,subnet_ids): a literal list of RefTos, or one value that is the whole list (TfArg.variable('subnet_ids'),TfArg.expression(...)). - TerraformDurationExt on Duration
- Converts a Dart Duration into a Terraform duration string ("604800s").
Constants
- terradartManifestVariable → const String
-
The environment variable the
terradartcommand sets to the file runStack and runEnvironments describe what they wrote in.
Functions
-
runEnvironments<
E extends Enum> (List< String> args, List<E> environments, Stack build(E env), {String dir(E env)?, String? workspace(E env)?, List<String> backendConfig(E env)?}) → Future<void> -
The entry point of a project with one Stack per environment. The
environments are the members of an enum of the project's own — any
names, each carrying its values — so the Stack takes a typed
envand derives everything per environment from it, its backend included: -
runStack(
List< String> args, Stack build(), {String out = 'tf-out'}) → Future<void> -
The entry point of a project with one Stack: writes it to
out.
Exceptions / Errors
- DuplicateModuleError
-
A
ModuleCallregistered twice under one name. - DuplicateResourceError
-
Thrown by
Stack.addwhen an entry with the same(kind, terraformType, localName)triple is registered twice. - SynthException
-
Thrown by
Stack.synth()andStack.writeTo()when the Stack has one or more SynthIssues. Nothing is written.