bedrock library

AWS Bedrock.

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.
AwsBedrockCustomModel
Factory wrapper for aws_bedrock_custom_model.
AwsBedrockEvaluationJob
Factory wrapper for aws_bedrock_evaluation_job.
AwsBedrockFoundationModelAgreement
Factory wrapper for aws_bedrock_foundation_model_agreement.
AwsBedrockGuardrail
Factory wrapper for aws_bedrock_guardrail.
AwsBedrockGuardrailVersion
Factory wrapper for aws_bedrock_guardrail_version.
AwsBedrockInferenceProfile
Factory wrapper for aws_bedrock_inference_profile.
AwsBedrockModelInvocationJob
Factory wrapper for aws_bedrock_model_invocation_job.
AwsBedrockModelInvocationLoggingConfiguration
Factory wrapper for aws_bedrock_model_invocation_logging_configuration.
AwsBedrockProvisionedModelThroughput
Factory wrapper for aws_bedrock_provisioned_model_throughput.
AwsBedrockUseCaseForModelAccess
Factory wrapper for aws_bedrock_use_case_for_model_access.
BedrockCustomModelOutputDataConfig
Typed helper for the output_data_config block of aws_bedrock_custom_model (derived from provider schema).
BedrockCustomModelTrainingDataConfig
Typed helper for the training_data_config block of aws_bedrock_custom_model (derived from provider schema).
BedrockCustomModelValidationDataConfig
Typed helper for the validation_data_config block of aws_bedrock_custom_model (derived from provider schema).
BedrockCustomModelValidator
Typed helper for the validation_data_config.validator block of aws_bedrock_custom_model (derived from provider schema).
BedrockCustomModelVpcConfig
Typed helper for the vpc_config block of aws_bedrock_custom_model (derived from provider schema).
BedrockEvaluationJobAutomated
Typed helper for the evaluation_config.automated block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobBedrockEvaluatorModel
Typed helper for the evaluation_config.automated.evaluator_model_config.bedrock_evaluator_model block of aws_bedrock_evaluation_job (derived from provider schema). Shared by every block of this shape in the resource.
BedrockEvaluationJobBedrockModel
Typed helper for the inference_config.model.bedrock_model block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobBedrockModelChoice
The BedrockEvaluationJobModel.bedrockModel choice: sets bedrock_model.
BedrockEvaluationJobCustomMetric
Typed helper for the evaluation_config.human.custom_metric block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobCustomMetricConfig
Typed helper for the evaluation_config.automated.custom_metric_config block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobCustomMetricConfigCustomMetric
Typed helper for the evaluation_config.automated.custom_metric_config.custom_metric block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobCustomMetricDefinition
Typed helper for the evaluation_config.automated.custom_metric_config.custom_metric.custom_metric_definition block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobDataset
Typed helper for the evaluation_config.automated.dataset_metric_config.dataset block of aws_bedrock_evaluation_job (derived from provider schema). Shared by every block of this shape in the resource.
BedrockEvaluationJobDatasetLocation
Typed helper for the evaluation_config.automated.dataset_metric_config.dataset.dataset_location block of aws_bedrock_evaluation_job (derived from provider schema). Shared by every block of this shape in the resource.
BedrockEvaluationJobDatasetMetricConfig
Typed helper for the evaluation_config.automated.dataset_metric_config block of aws_bedrock_evaluation_job (derived from provider schema). Shared by every block of this shape in the resource.
BedrockEvaluationJobEvaluationConfig
Exactly one of automated, human on the evaluation_config block of aws_bedrock_evaluation_job: the provider rejects none and more than one, so each variant sets one of them.
BedrockEvaluationJobEvaluationConfigAutomated
The BedrockEvaluationJobEvaluationConfig.automated choice: sets automated.
BedrockEvaluationJobEvaluationConfigHuman
The BedrockEvaluationJobEvaluationConfig.human choice: sets human.
BedrockEvaluationJobEvaluatorModelConfig
Typed helper for the evaluation_config.automated.evaluator_model_config block of aws_bedrock_evaluation_job (derived from provider schema). Shared by every block of this shape in the resource.
BedrockEvaluationJobFloatValue
The BedrockEvaluationJobValue.floatValue choice: sets float_value.
BedrockEvaluationJobHuman
Typed helper for the evaluation_config.human block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobHumanWorkflowConfig
Typed helper for the evaluation_config.human.human_workflow_config block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobInferenceConfig
Exactly one of model, rag_config on the inference_config block of aws_bedrock_evaluation_job: the provider rejects none and more than one, so each variant sets one of them.
BedrockEvaluationJobInferenceConfigModel
The BedrockEvaluationJobInferenceConfig.model choice: sets model.
BedrockEvaluationJobInferenceConfigRagConfig
The BedrockEvaluationJobInferenceConfig.ragConfig choice: sets rag_config.
BedrockEvaluationJobKnowledgeBaseConfig
Exactly one of retrieve_and_generate_config, retrieve_config on the inference_config.rag_config.knowledge_base_config block of aws_bedrock_evaluation_job: the provider rejects none and more than one, so each variant sets one of them.
BedrockEvaluationJobKnowledgeBaseConfigRetrieveAndGenerateConfig
The BedrockEvaluationJobKnowledgeBaseConfig.retrieveAndGenerateConfig choice: sets retrieve_and_generate_config.
BedrockEvaluationJobKnowledgeBaseConfigRetrieveConfig
The BedrockEvaluationJobKnowledgeBaseConfig.retrieveConfig choice: sets retrieve_config.
BedrockEvaluationJobKnowledgeBaseRetrievalConfiguration
Typed helper for the inference_config.rag_config.knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobModel
Exactly one of bedrock_model, precomputed_inference_source on the inference_config.model block of aws_bedrock_evaluation_job: the provider rejects none and more than one, so each variant sets one of them.
BedrockEvaluationJobModelPrecomputedInferenceSource
The BedrockEvaluationJobModel.precomputedInferenceSource choice: sets precomputed_inference_source.
BedrockEvaluationJobOutputDataConfig
Typed helper for the output_data_config block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobPerformanceConfig
Typed helper for the inference_config.model.bedrock_model.performance_config block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobPrecomputedInferenceSource
Typed helper for the inference_config.model.precomputed_inference_source block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobPrecomputedRagSourceConfig
Exactly one of retrieve_and_generate_source_config, retrieve_source_config on the inference_config.rag_config.precomputed_rag_source_config block of aws_bedrock_evaluation_job: the provider rejects none and more than one, so each variant sets one of them.
BedrockEvaluationJobPrecomputedRagSourceConfigRetrieveAndGenerateSourceConfig
The BedrockEvaluationJobPrecomputedRagSourceConfig.retrieveAndGenerateSourceConfig choice: sets retrieve_and_generate_source_config.
BedrockEvaluationJobPrecomputedRagSourceConfigRetrieveSourceConfig
The BedrockEvaluationJobPrecomputedRagSourceConfig.retrieveSourceConfig choice: sets retrieve_source_config.
BedrockEvaluationJobRagConfig
Exactly one of knowledge_base_config, precomputed_rag_source_config on the inference_config.rag_config block of aws_bedrock_evaluation_job: the provider rejects none and more than one, so each variant sets one of them.
BedrockEvaluationJobRagConfigKnowledgeBaseConfig
The BedrockEvaluationJobRagConfig.knowledgeBaseConfig choice: sets knowledge_base_config.
BedrockEvaluationJobRagConfigPrecomputedRagSourceConfig
The BedrockEvaluationJobRagConfig.precomputedRagSourceConfig choice: sets precomputed_rag_source_config.
BedrockEvaluationJobRatingScale
Typed helper for the evaluation_config.automated.custom_metric_config.custom_metric.custom_metric_definition.rating_scale block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobRetrievalConfiguration
Typed helper for the inference_config.rag_config.knowledge_base_config.retrieve_and_generate_config.retrieval_configuration block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobRetrieveAndGenerateConfig
Typed helper for the inference_config.rag_config.knowledge_base_config.retrieve_and_generate_config block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobRetrieveAndGenerateSourceConfig
Typed helper for the inference_config.rag_config.precomputed_rag_source_config.retrieve_and_generate_source_config block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobRetrieveConfig
Typed helper for the inference_config.rag_config.knowledge_base_config.retrieve_config block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobRetrieveSourceConfig
Typed helper for the inference_config.rag_config.precomputed_rag_source_config.retrieve_source_config block of aws_bedrock_evaluation_job (derived from provider schema).
BedrockEvaluationJobStringValue
The BedrockEvaluationJobValue.stringValue choice: sets string_value.
BedrockEvaluationJobValue
Exactly one of float_value, string_value on the evaluation_config.automated.custom_metric_config.custom_metric.custom_metric_definition.rating_scale.value block of aws_bedrock_evaluation_job: the provider rejects none and more than one, so each variant sets one of them.
BedrockEvaluationJobVectorSearchConfiguration
Typed helper for the inference_config.rag_config.knowledge_base_config.retrieve_and_generate_config.retrieval_configuration.vector_search_configuration block of aws_bedrock_evaluation_job (derived from provider schema). Shared by every block of this shape in the resource.
BedrockGuardrailContentPolicyConfig
Typed helper for the content_policy_config block of aws_bedrock_guardrail (derived from provider schema).
BedrockGuardrailContentPolicyConfigFiltersConfig
Typed helper for the content_policy_config.filters_config block of aws_bedrock_guardrail (derived from provider schema).
BedrockGuardrailContextualGroundingPolicyConfig
Typed helper for the contextual_grounding_policy_config block of aws_bedrock_guardrail (derived from provider schema).
BedrockGuardrailContextualGroundingPolicyConfigFiltersConfig
Typed helper for the contextual_grounding_policy_config.filters_config block of aws_bedrock_guardrail (derived from provider schema).
BedrockGuardrailCrossRegionConfig
Typed helper for the cross_region_config block of aws_bedrock_guardrail (derived from provider schema).
BedrockGuardrailManagedWordListsConfig
Typed helper for the word_policy_config.managed_word_lists_config block of aws_bedrock_guardrail (derived from provider schema).
BedrockGuardrailPiiEntitiesConfig
Typed helper for the sensitive_information_policy_config.pii_entities_config block of aws_bedrock_guardrail (derived from provider schema).
BedrockGuardrailRegexesConfig
Typed helper for the sensitive_information_policy_config.regexes_config block of aws_bedrock_guardrail (derived from provider schema).
BedrockGuardrailSensitiveInformationPolicyConfig
Typed helper for the sensitive_information_policy_config block of aws_bedrock_guardrail (derived from provider schema).
BedrockGuardrailTopicPolicyConfig
Typed helper for the topic_policy_config block of aws_bedrock_guardrail (derived from provider schema).
BedrockGuardrailTopicsConfig
Typed helper for the topic_policy_config.topics_config block of aws_bedrock_guardrail (derived from provider schema).
BedrockGuardrailWordPolicyConfig
Typed helper for the word_policy_config block of aws_bedrock_guardrail (derived from provider schema).
BedrockGuardrailWordsConfig
Typed helper for the word_policy_config.words_config block of aws_bedrock_guardrail (derived from provider schema).
BedrockInferenceProfileModelSource
Typed helper for the model_source block of aws_bedrock_inference_profile (derived from provider schema).
BedrockModelInvocationJobInputDataConfig
Typed helper for the input_data_config block of aws_bedrock_model_invocation_job (derived from provider schema).
BedrockModelInvocationJobOutputDataConfig
Typed helper for the output_data_config block of aws_bedrock_model_invocation_job (derived from provider schema).
BedrockModelInvocationJobS3InputDataConfig
Typed helper for the input_data_config.s3_input_data_config block of aws_bedrock_model_invocation_job (derived from provider schema).
BedrockModelInvocationJobS3OutputDataConfig
Typed helper for the output_data_config.s3_output_data_config block of aws_bedrock_model_invocation_job (derived from provider schema).
BedrockModelInvocationJobVpcConfig
Typed helper for the vpc_config block of aws_bedrock_model_invocation_job (derived from provider schema).
BedrockModelInvocationLoggingConfigurationCloudwatchConfig
Typed helper for the logging_config.cloudwatch_config block of aws_bedrock_model_invocation_logging_configuration (derived from provider schema).
BedrockModelInvocationLoggingConfigurationLargeDataDeliveryS3Config
Typed helper for the logging_config.cloudwatch_config.large_data_delivery_s3_config block of aws_bedrock_model_invocation_logging_configuration (derived from provider schema).
BedrockModelInvocationLoggingConfigurationLoggingConfig
Typed helper for the logging_config block of aws_bedrock_model_invocation_logging_configuration (derived from provider schema).
BedrockModelInvocationLoggingConfigurationS3Config
Typed helper for the logging_config.s3_config block of aws_bedrock_model_invocation_logging_configuration (derived from provider schema).
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.
DataAwsBedrockCustomModel
Factory wrapper for aws_bedrock_custom_model.
DataAwsBedrockCustomModels
Factory wrapper for aws_bedrock_custom_models.
DataAwsBedrockFoundationModel
Factory wrapper for aws_bedrock_foundation_model.
DataAwsBedrockFoundationModelAgreementOffers
Factory wrapper for aws_bedrock_foundation_model_agreement_offers.
DataAwsBedrockFoundationModels
Factory wrapper for aws_bedrock_foundation_models.
DataAwsBedrockInferenceProfile
Factory wrapper for aws_bedrock_inference_profile.
DataAwsBedrockInferenceProfiles
Factory wrapper for aws_bedrock_inference_profiles.
DataAwsBedrockUseCaseForModelAccess
Factory wrapper for aws_bedrock_use_case_for_model_access.
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.
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

BedrockCustomModelCustomizationType
Bedrock Custom Model Customization enum for customization_type.
BedrockEvaluationJobApplicationType
Bedrock Evaluation Job Application enum for application_type.
BedrockEvaluationJobLatency
latency — derived from the provider schema description.
BedrockEvaluationJobRatingMethod
rating_method — derived from the provider schema description.
BedrockEvaluationJobTaskType
task_type — derived from the provider schema description.
BedrockGuardrailAction
action — derived from the provider schema description.
BedrockGuardrailContentPolicyConfigType
type — derived from the provider schema description.
BedrockGuardrailContextualGroundingPolicyConfigType
type — derived from the provider schema description.
BedrockGuardrailFiltersConfigInputAction
input_action — derived from the provider schema description.
BedrockGuardrailFiltersConfigOutputAction
output_action — derived from the provider schema description.
BedrockGuardrailInputModalities
input_modalities — derived from the provider schema description.
BedrockGuardrailInputStrength
input_strength — derived from the provider schema description.
BedrockGuardrailManagedWordListsConfigType
type — derived from the provider schema description.
BedrockGuardrailOutputModalities
output_modalities — derived from the provider schema description.
BedrockGuardrailOutputStrength
output_strength — derived from the provider schema description.
BedrockGuardrailPiiEntitiesConfigInputAction
input_action — derived from the provider schema description.
BedrockGuardrailPiiEntitiesConfigOutputAction
output_action — derived from the provider schema description.
BedrockGuardrailPiiEntitiesConfigType
type — derived from the provider schema description.
BedrockGuardrailTopicsConfigType
type — derived from the provider schema description.
BedrockModelInvocationJobS3InputFormat
s3_input_format — derived from the provider schema description.
BedrockProvisionedModelThroughputCommitmentDuration
Bedrock Provisioned Model Throughput Commitment enum for commitment_duration.
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").

Constants

terradartManifestVariable → const String
The environment variable the terradart command 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)?, E? defaultEnv}) → 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 env and 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 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.