imagebuilder library

AWS EC2 Image Builder.

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.
AwsImagebuilderComponent: Factory wrapper for aws_imagebuilder_component.
AwsImagebuilderContainerRecipe: Factory wrapper for aws_imagebuilder_container_recipe.
AwsImagebuilderDistributionConfiguration: Factory wrapper for aws_imagebuilder_distribution_configuration.
AwsImagebuilderImage: Factory wrapper for aws_imagebuilder_image.
AwsImagebuilderImagePipeline: Factory wrapper for aws_imagebuilder_image_pipeline.
AwsImagebuilderImageRecipe: Factory wrapper for aws_imagebuilder_image_recipe.
AwsImagebuilderInfrastructureConfiguration: Factory wrapper for aws_imagebuilder_infrastructure_configuration.
AwsImagebuilderLifecyclePolicy: Factory wrapper for aws_imagebuilder_lifecycle_policy.
AwsImagebuilderWorkflow: Factory wrapper for aws_imagebuilder_workflow.
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.
DataAwsImagebuilderComponent: Factory wrapper for aws_imagebuilder_component.
DataAwsImagebuilderComponents: Factory wrapper for aws_imagebuilder_components.
DataAwsImagebuilderContainerRecipe: Factory wrapper for aws_imagebuilder_container_recipe.
DataAwsImagebuilderContainerRecipes: Factory wrapper for aws_imagebuilder_container_recipes.
DataAwsImagebuilderDistributionConfiguration: Factory wrapper for aws_imagebuilder_distribution_configuration.
DataAwsImagebuilderDistributionConfigurations: Factory wrapper for aws_imagebuilder_distribution_configurations.
DataAwsImagebuilderImage: Factory wrapper for aws_imagebuilder_image.
DataAwsImagebuilderImagePipeline: Factory wrapper for aws_imagebuilder_image_pipeline.
DataAwsImagebuilderImagePipelines: Factory wrapper for aws_imagebuilder_image_pipelines.
DataAwsImagebuilderImageRecipe: Factory wrapper for aws_imagebuilder_image_recipe.
DataAwsImagebuilderImageRecipes: Factory wrapper for aws_imagebuilder_image_recipes.
DataAwsImagebuilderInfrastructureConfiguration: Factory wrapper for aws_imagebuilder_infrastructure_configuration.
DataAwsImagebuilderInfrastructureConfigurations: Factory wrapper for aws_imagebuilder_infrastructure_configurations.
DataImagebuilderComponentsFilter: Typed helper for the filter block of aws_imagebuilder_components (derived from provider schema).
DataImagebuilderContainerRecipesFilter: Typed helper for the filter block of aws_imagebuilder_container_recipes (derived from provider schema).
DataImagebuilderDistributionConfigurationsFilter: Typed helper for the filter block of aws_imagebuilder_distribution_configurations (derived from provider schema).
DataImagebuilderImagePipelinesFilter: Typed helper for the filter block of aws_imagebuilder_image_pipelines (derived from provider schema).
DataImagebuilderImageRecipesFilter: Typed helper for the filter block of aws_imagebuilder_image_recipes (derived from provider schema).
DataImagebuilderInfrastructureConfigurationsFilter: Typed helper for the filter block of aws_imagebuilder_infrastructure_configurations (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_changes covers: every attribute, or the listed ones.
ImagebuilderComponentDocument: Exactly one of data, uri on aws_imagebuilder_component: the provider rejects none and more than one, so each variant sets one of them.
ImagebuilderComponentDocumentData: The ImagebuilderComponentDocument.data choice: sets data.
ImagebuilderComponentDocumentUri: The ImagebuilderComponentDocument.uri choice: sets uri.
ImagebuilderContainerRecipeBlockDeviceMapping: Typed helper for the instance_configuration.block_device_mapping block of aws_imagebuilder_container_recipe (derived from provider schema).
ImagebuilderContainerRecipeComponent: Typed helper for the component block of aws_imagebuilder_container_recipe (derived from provider schema).
ImagebuilderContainerRecipeDockerfileTemplate: Exactly one of dockerfile_template_data, dockerfile_template_uri on aws_imagebuilder_container_recipe: the provider rejects none and more than one, so each variant sets one of them.
ImagebuilderContainerRecipeDockerfileTemplateData: The ImagebuilderContainerRecipeDockerfileTemplate.dockerfileTemplateData choice: sets dockerfile_template_data.
ImagebuilderContainerRecipeDockerfileTemplateUri: The ImagebuilderContainerRecipeDockerfileTemplate.dockerfileTemplateUri choice: sets dockerfile_template_uri.
ImagebuilderContainerRecipeEbs: Typed helper for the instance_configuration.block_device_mapping.ebs block of aws_imagebuilder_container_recipe (derived from provider schema).
ImagebuilderContainerRecipeInstanceConfiguration: Typed helper for the instance_configuration block of aws_imagebuilder_container_recipe (derived from provider schema).
ImagebuilderContainerRecipeParameter: Typed helper for the component.parameter block of aws_imagebuilder_container_recipe (derived from provider schema).
ImagebuilderContainerRecipeTargetRepository: Typed helper for the target_repository block of aws_imagebuilder_container_recipe (derived from provider schema).
ImagebuilderDistributionConfigurationAmiDistributionConfiguration: Typed helper for the distribution.ami_distribution_configuration block of aws_imagebuilder_distribution_configuration (derived from provider schema).
ImagebuilderDistributionConfigurationContainerDistributionConfiguration: Typed helper for the distribution.container_distribution_configuration block of aws_imagebuilder_distribution_configuration (derived from provider schema).
ImagebuilderDistributionConfigurationDistribution: Typed helper for the distribution block of aws_imagebuilder_distribution_configuration (derived from provider schema).
ImagebuilderDistributionConfigurationFastLaunchConfiguration: Typed helper for the distribution.fast_launch_configuration block of aws_imagebuilder_distribution_configuration (derived from provider schema).
ImagebuilderDistributionConfigurationLaunchPermission: Typed helper for the distribution.ami_distribution_configuration.launch_permission block of aws_imagebuilder_distribution_configuration (derived from provider schema).
ImagebuilderDistributionConfigurationLaunchTemplate: Typed helper for the distribution.fast_launch_configuration.launch_template block of aws_imagebuilder_distribution_configuration (derived from provider schema).
ImagebuilderDistributionConfigurationLaunchTemplateConfiguration: Typed helper for the distribution.launch_template_configuration block of aws_imagebuilder_distribution_configuration (derived from provider schema).
ImagebuilderDistributionConfigurationS3ExportConfiguration: Typed helper for the distribution.s3_export_configuration block of aws_imagebuilder_distribution_configuration (derived from provider schema).
ImagebuilderDistributionConfigurationSnapshotConfiguration: Typed helper for the distribution.fast_launch_configuration.snapshot_configuration block of aws_imagebuilder_distribution_configuration (derived from provider schema).
ImagebuilderDistributionConfigurationSsmParameterConfiguration: Typed helper for the distribution.ssm_parameter_configuration block of aws_imagebuilder_distribution_configuration (derived from provider schema).
ImagebuilderDistributionConfigurationTargetRepository: Typed helper for the distribution.container_distribution_configuration.target_repository block of aws_imagebuilder_distribution_configuration (derived from provider schema).
ImagebuilderImageContainerRecipeArn: The ImagebuilderImageRecipeArn.containerRecipeArn choice: sets container_recipe_arn.
ImagebuilderImageEcrConfiguration: Typed helper for the image_scanning_configuration.ecr_configuration block of aws_imagebuilder_image (derived from provider schema).
ImagebuilderImageLoggingConfiguration: Typed helper for the logging_configuration block of aws_imagebuilder_image (derived from provider schema).
ImagebuilderImageParameter: Typed helper for the workflow.parameter block of aws_imagebuilder_image (derived from provider schema).
ImagebuilderImagePipelineContainerRecipeArn: The ImagebuilderImagePipelineRecipeArn.containerRecipeArn choice: sets container_recipe_arn.
ImagebuilderImagePipelineEcrConfiguration: Typed helper for the image_scanning_configuration.ecr_configuration block of aws_imagebuilder_image_pipeline (derived from provider schema).
ImagebuilderImagePipelineImageRecipeArn: The ImagebuilderImagePipelineRecipeArn.imageRecipeArn choice: sets image_recipe_arn.
ImagebuilderImagePipelineImageScanningConfiguration: Typed helper for the image_scanning_configuration block of aws_imagebuilder_image_pipeline (derived from provider schema).
ImagebuilderImagePipelineImageTestsConfiguration: Typed helper for the image_tests_configuration block of aws_imagebuilder_image_pipeline (derived from provider schema).
ImagebuilderImagePipelineLoggingConfiguration: Typed helper for the logging_configuration block of aws_imagebuilder_image_pipeline (derived from provider schema).
ImagebuilderImagePipelineParameter: Typed helper for the workflow.parameter block of aws_imagebuilder_image_pipeline (derived from provider schema).
ImagebuilderImagePipelineRecipeArn: Exactly one of container_recipe_arn, image_recipe_arn on aws_imagebuilder_image_pipeline: the provider rejects none and more than one, so each variant sets one of them.
ImagebuilderImagePipelineSchedule: Typed helper for the schedule block of aws_imagebuilder_image_pipeline (derived from provider schema).
ImagebuilderImagePipelineWorkflow: Typed helper for the workflow block of aws_imagebuilder_image_pipeline (derived from provider schema).
ImagebuilderImageRecipeArn: Exactly one of container_recipe_arn, image_recipe_arn on aws_imagebuilder_image: the provider rejects none and more than one, so each variant sets one of them.
ImagebuilderImageRecipeArnChoice: The ImagebuilderImageRecipeArn.imageRecipeArn choice: sets image_recipe_arn.
ImagebuilderImageRecipeBlockDeviceMapping: Typed helper for the block_device_mapping block of aws_imagebuilder_image_recipe (derived from provider schema).
ImagebuilderImageRecipeComponent: Typed helper for the component block of aws_imagebuilder_image_recipe (derived from provider schema).
ImagebuilderImageRecipeEbs: Typed helper for the block_device_mapping.ebs block of aws_imagebuilder_image_recipe (derived from provider schema).
ImagebuilderImageRecipeParameter: Typed helper for the component.parameter block of aws_imagebuilder_image_recipe (derived from provider schema).
ImagebuilderImageRecipeSystemsManagerAgent: Typed helper for the systems_manager_agent block of aws_imagebuilder_image_recipe (derived from provider schema).
ImagebuilderImageScanningConfiguration: Typed helper for the image_scanning_configuration block of aws_imagebuilder_image (derived from provider schema).
ImagebuilderImageTestsConfiguration: Typed helper for the image_tests_configuration block of aws_imagebuilder_image (derived from provider schema).
ImagebuilderImageWorkflow: Typed helper for the workflow block of aws_imagebuilder_image (derived from provider schema).
ImagebuilderInfrastructureConfigurationHost: At most one of host_id, host_resource_group_arn on the placement block of aws_imagebuilder_infrastructure_configuration: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ImagebuilderInfrastructureConfigurationHostId: The ImagebuilderInfrastructureConfigurationHost.hostId choice: sets host_id.
ImagebuilderInfrastructureConfigurationHostResourceGroupArn: The ImagebuilderInfrastructureConfigurationHost.hostResourceGroupArn choice: sets host_resource_group_arn.
ImagebuilderInfrastructureConfigurationInstanceMetadataOptions: Typed helper for the instance_metadata_options block of aws_imagebuilder_infrastructure_configuration (derived from provider schema).
ImagebuilderInfrastructureConfigurationLogging: Typed helper for the logging block of aws_imagebuilder_infrastructure_configuration (derived from provider schema).
ImagebuilderInfrastructureConfigurationPlacement: Typed helper for the placement block of aws_imagebuilder_infrastructure_configuration (derived from provider schema).
ImagebuilderInfrastructureConfigurationS3Logs: Typed helper for the logging.s3_logs block of aws_imagebuilder_infrastructure_configuration (derived from provider schema).
ImagebuilderLifecyclePolicyAction: Typed helper for the policy_detail.action block of aws_imagebuilder_lifecycle_policy (derived from provider schema).
ImagebuilderLifecyclePolicyAmis: Typed helper for the policy_detail.exclusion_rules.amis block of aws_imagebuilder_lifecycle_policy (derived from provider schema).
ImagebuilderLifecyclePolicyDetail: Typed helper for the policy_detail block of aws_imagebuilder_lifecycle_policy (derived from provider schema).
ImagebuilderLifecyclePolicyExclusionRules: Typed helper for the policy_detail.exclusion_rules block of aws_imagebuilder_lifecycle_policy (derived from provider schema).
ImagebuilderLifecyclePolicyFilter: Typed helper for the policy_detail.filter block of aws_imagebuilder_lifecycle_policy (derived from provider schema).
ImagebuilderLifecyclePolicyIncludeResources: Typed helper for the policy_detail.action.include_resources block of aws_imagebuilder_lifecycle_policy (derived from provider schema).
ImagebuilderLifecyclePolicyLastLaunched: Typed helper for the policy_detail.exclusion_rules.amis.last_launched block of aws_imagebuilder_lifecycle_policy (derived from provider schema).
ImagebuilderLifecyclePolicyRecipe: Typed helper for the resource_selection.recipe block of aws_imagebuilder_lifecycle_policy (derived from provider schema).
ImagebuilderLifecyclePolicyResourceSelection: Typed helper for the resource_selection block of aws_imagebuilder_lifecycle_policy (derived from provider schema).
ImagebuilderWorkflowDocument: Exactly one of data, uri on aws_imagebuilder_workflow: the provider rejects none and more than one, so each variant sets one of them.
ImagebuilderWorkflowDocumentData: The ImagebuilderWorkflowDocument.data choice: sets data.
ImagebuilderWorkflowDocumentUri: The ImagebuilderWorkflowDocument.uri choice: sets uri.
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

ImagebuilderComponentPlatform: Imagebuilder Component enum for platform.
ImagebuilderContainerRecipeContainerType: Imagebuilder Container Recipe Container enum for container_type.
ImagebuilderContainerRecipePlatformOverride: Imagebuilder Container Recipe Platform enum for platform_override.
ImagebuilderContainerRecipeService: service — derived from the provider schema description.
ImagebuilderContainerRecipeVolumeType: volume_type — derived from the provider schema description.
ImagebuilderDistributionConfigurationDataType: data_type — derived from the provider schema description.
ImagebuilderDistributionConfigurationDiskImageFormat: disk_image_format — derived from the provider schema description.
ImagebuilderDistributionConfigurationService: service — derived from the provider schema description.
ImagebuilderImageOnFailure: on_failure — derived from the provider schema description.
ImagebuilderImagePipelineExecutionStartCondition: pipeline_execution_start_condition — derived from the provider schema description.
ImagebuilderImagePipelineOnFailure: on_failure — derived from the provider schema description.
ImagebuilderImagePipelineStatus: Imagebuilder Image Pipeline enum for status.
ImagebuilderImageRecipeVolumeType: volume_type — derived from the provider schema description.
ImagebuilderInfrastructureConfigurationHttpTokens: http_tokens — derived from the provider schema description.
ImagebuilderInfrastructureConfigurationTenancy: tenancy — derived from the provider schema description.
ImagebuilderLifecyclePolicyActionType: type — derived from the provider schema description.
ImagebuilderLifecyclePolicyFilterType: type — derived from the provider schema description.
ImagebuilderLifecyclePolicyResourceType: Imagebuilder Lifecycle Policy Resource enum for resource_type.
ImagebuilderLifecyclePolicyUnit: unit — derived from the provider schema description.
ImagebuilderWorkflowType: Imagebuilder Workflow enum for type.
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)?}) → 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.

imagebuilder library

Classes

Enums

Extension Types

Extensions

Constants

Functions

Exceptions / Errors

terradart_aws package

imagebuilder library