kendra library

AWS Kendra.

Classes

AppConstant<T>
A value the Stack hands to application code as a static const in 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 const members 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.
AwsKendraDataSource
Factory wrapper for aws_kendra_data_source.
AwsKendraExperience
Factory wrapper for aws_kendra_experience.
AwsKendraFaq
Factory wrapper for aws_kendra_faq.
AwsKendraIndex
Factory wrapper for aws_kendra_index.
AwsKendraQuerySuggestionsBlockList
Factory wrapper for aws_kendra_query_suggestions_block_list.
AwsKendraThesaurus
Factory wrapper for aws_kendra_thesaurus.
DartDefineOutput
An output whose value is the client build's --dart-define file, registered with Stack.addDartDefineOutput.
Data
Base of every user-instantiable Terraform data block.
DataAwsKendraExperience
Factory wrapper for aws_kendra_experience.
DataAwsKendraFaq
Factory wrapper for aws_kendra_faq.
DataAwsKendraIndex
Factory wrapper for aws_kendra_index.
DataAwsKendraQuerySuggestionsBlockList
Factory wrapper for aws_kendra_query_suggestions_block_list.
DataAwsKendraThesaurus
Factory wrapper for aws_kendra_thesaurus.
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_changes covers: every attribute, or the listed ones.
InvalidDartDefineOutput
An output of Stack.addDartDefineOutput that 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 lifecycle block Terraform rejects: a data source (or one of its attributes) in replaceTriggeredBy, all inside IgnoreChanges.of, or a condition with an empty error message.
InvalidMoveTarget
A moved block whose to names no resource of the Stack.
InvalidTimeout
A negative timeouts duration.
KendraDataSourceAccessControlListConfiguration
Typed helper for the configuration.s3_configuration.access_control_list_configuration block of aws_kendra_data_source (derived from provider schema).
KendraDataSourceAuthenticationConfiguration
Typed helper for the configuration.web_crawler_configuration.authentication_configuration block of aws_kendra_data_source (derived from provider schema).
KendraDataSourceBasicAuthentication
Typed helper for the configuration.web_crawler_configuration.authentication_configuration.basic_authentication block of aws_kendra_data_source (derived from provider schema).
KendraDataSourceCondition
Typed helper for the custom_document_enrichment_configuration.inline_configurations.condition block of aws_kendra_data_source (derived from provider schema).
KendraDataSourceConditionOnValue
Typed helper for the custom_document_enrichment_configuration.inline_configurations.condition.condition_on_value block of aws_kendra_data_source (derived from provider schema). Shared by every block of this shape in the resource.
KendraDataSourceConfiguration
Typed helper for the configuration block of aws_kendra_data_source (derived from provider schema).
KendraDataSourceCustomDocumentEnrichmentConfiguration
Typed helper for the custom_document_enrichment_configuration block of aws_kendra_data_source (derived from provider schema).
KendraDataSourceDocumentsMetadataConfiguration
Typed helper for the configuration.s3_configuration.documents_metadata_configuration block of aws_kendra_data_source (derived from provider schema).
KendraDataSourceInlineConfigurations
Typed helper for the custom_document_enrichment_configuration.inline_configurations block of aws_kendra_data_source (derived from provider schema).
KendraDataSourceInvocationCondition
Typed helper for the custom_document_enrichment_configuration.post_extraction_hook_configuration.invocation_condition block of aws_kendra_data_source (derived from provider schema). Shared by every block of this shape in the resource.
KendraDataSourcePostExtractionHookConfiguration
Typed helper for the custom_document_enrichment_configuration.post_extraction_hook_configuration block of aws_kendra_data_source (derived from provider schema).
KendraDataSourcePreExtractionHookConfiguration
Typed helper for the custom_document_enrichment_configuration.pre_extraction_hook_configuration block of aws_kendra_data_source (derived from provider schema).
KendraDataSourceProxyConfiguration
Typed helper for the configuration.web_crawler_configuration.proxy_configuration block of aws_kendra_data_source (derived from provider schema).
KendraDataSourceS3Configuration
Typed helper for the configuration.s3_configuration block of aws_kendra_data_source (derived from provider schema).
KendraDataSourceSeedUrlConfiguration
Typed helper for the configuration.web_crawler_configuration.urls.seed_url_configuration block of aws_kendra_data_source (derived from provider schema).
KendraDataSourceSiteMapsConfiguration
Typed helper for the configuration.web_crawler_configuration.urls.site_maps_configuration block of aws_kendra_data_source (derived from provider schema).
KendraDataSourceTarget
Typed helper for the custom_document_enrichment_configuration.inline_configurations.target block of aws_kendra_data_source (derived from provider schema).
KendraDataSourceTargetDocumentAttributeValue
Typed helper for the custom_document_enrichment_configuration.inline_configurations.target.target_document_attribute_value block of aws_kendra_data_source (derived from provider schema).
KendraDataSourceTemplateConfiguration
Typed helper for the configuration.template_configuration block of aws_kendra_data_source (derived from provider schema).
KendraDataSourceUrls
Typed helper for the configuration.web_crawler_configuration.urls block of aws_kendra_data_source (derived from provider schema).
KendraDataSourceWebCrawlerConfiguration
Typed helper for the configuration.web_crawler_configuration block of aws_kendra_data_source (derived from provider schema).
KendraExperienceConfiguration
Typed helper for the configuration block of aws_kendra_experience (derived from provider schema).
KendraExperienceContentSourceConfiguration
Typed helper for the configuration.content_source_configuration block of aws_kendra_experience (derived from provider schema).
KendraExperienceUserIdentityConfiguration
Typed helper for the configuration.user_identity_configuration block of aws_kendra_experience (derived from provider schema).
KendraFaqS3Path
Typed helper for the s3_path block of aws_kendra_faq (derived from provider schema).
KendraIndexCapacityUnits
Typed helper for the capacity_units block of aws_kendra_index (derived from provider schema).
KendraIndexDocumentMetadataConfigurationUpdates
Typed helper for the document_metadata_configuration_updates block of aws_kendra_index (derived from provider schema).
KendraIndexJsonTokenTypeConfiguration
Typed helper for the user_token_configurations.json_token_type_configuration block of aws_kendra_index (derived from provider schema).
KendraIndexJwtTokenTypeConfiguration
Typed helper for the user_token_configurations.jwt_token_type_configuration block of aws_kendra_index (derived from provider schema).
KendraIndexRelevance
Typed helper for the document_metadata_configuration_updates.relevance block of aws_kendra_index (derived from provider schema).
KendraIndexSearch
Typed helper for the document_metadata_configuration_updates.search block of aws_kendra_index (derived from provider schema).
KendraIndexServerSideEncryptionConfiguration
Typed helper for the server_side_encryption_configuration block of aws_kendra_index (derived from provider schema).
KendraIndexUserGroupResolutionConfiguration
Typed helper for the user_group_resolution_configuration block of aws_kendra_index (derived from provider schema).
KendraIndexUserTokenConfigurations
Typed helper for the user_token_configurations block of aws_kendra_index (derived from provider schema).
KendraQuerySuggestionsBlockListSourceS3Path
Typed helper for the source_s3_path block of aws_kendra_query_suggestions_block_list (derived from provider schema).
KendraThesaurusSourceS3Path
Typed helper for the source_s3_path block of aws_kendra_thesaurus (derived from provider schema).
LifecycleCondition
A precondition or postcondition block: 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 (google for google_pubsub_topic), the one its provider meta-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.replaceTriggeredBy lists: a resource of the Stack or an attribute getter of one. Resource and TfRef implement it; synth reports a data source or a data-source attribute as an InvalidLifecycle.
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, and LocalBackend; anything else implements this interface in the caller. The Stack only stores the value and exposes a discriminator for synth's terraform { backend ... } emitter.
StackProvider
Coordination interface between Stack (in this package) and concrete providers (e.g. GoogleProvider in terradart_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(...) or map(...).
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 with Stack.addOutput.
TfPrimitiveType
string, number, bool or any.
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.variable or var.<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.ref whose 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 resource block or a data block in Terraform JSON.

Extension Types

KendraDataSourceType
Kendra Data Source enum for type.
KendraDataSourceWebCrawlerMode
web_crawler_mode — derived from the provider schema description.
KendraFaqFileFormat
Kendra Faq File enum for file_format.
KendraIndexEdition
Kendra Index enum for edition.
KendraIndexKeyLocation
key_location — derived from the provider schema description.
KendraIndexRankOrder
rank_order — derived from the provider schema description.
KendraIndexType
type — derived from the provider schema description.
KendraIndexUserContextPolicy
Kendra Index User Context enum for user_context_policy.
KendraIndexUserGroupResolutionMode
user_group_resolution_mode — derived from the provider schema description.
OutputEnvironment
The environment Stack.outputEnvironment returns: 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").

Exceptions / Errors

DuplicateModuleError
A ModuleCall registered twice under one name.
DuplicateResourceError
Thrown by Stack.add when an entry with the same (kind, terraformType, localName) triple is registered twice.
SynthException
Thrown by Stack.synth() and Stack.writeTo() when the Stack has one or more SynthIssues. Nothing is written.