imagebuilder library
AWS EC2 Image Builder.
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. - 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
outputwhose value is the client build's--dart-definefile, registered withStack.addDartDefineOutput. - Data
-
Base of every user-instantiable Terraform
datablock. - 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
filterblock ofaws_imagebuilder_components(derived from provider schema). - DataImagebuilderContainerRecipesFilter
-
Typed helper for the
filterblock ofaws_imagebuilder_container_recipes(derived from provider schema). - DataImagebuilderDistributionConfigurationsFilter
-
Typed helper for the
filterblock ofaws_imagebuilder_distribution_configurations(derived from provider schema). - DataImagebuilderImagePipelinesFilter
-
Typed helper for the
filterblock ofaws_imagebuilder_image_pipelines(derived from provider schema). - DataImagebuilderImageRecipesFilter
-
Typed helper for the
filterblock ofaws_imagebuilder_image_recipes(derived from provider schema). - DataImagebuilderInfrastructureConfigurationsFilter
-
Typed helper for the
filterblock ofaws_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_changescovers: every attribute, or the listed ones. - ImagebuilderComponentDocument
-
Exactly one of
data,urionaws_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_mappingblock ofaws_imagebuilder_container_recipe(derived from provider schema). - ImagebuilderContainerRecipeComponent
-
Typed helper for the
componentblock ofaws_imagebuilder_container_recipe(derived from provider schema). - ImagebuilderContainerRecipeDockerfileTemplate
-
Exactly one of
dockerfile_template_data,dockerfile_template_urionaws_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.ebsblock ofaws_imagebuilder_container_recipe(derived from provider schema). - ImagebuilderContainerRecipeInstanceConfiguration
-
Typed helper for the
instance_configurationblock ofaws_imagebuilder_container_recipe(derived from provider schema). - ImagebuilderContainerRecipeParameter
-
Typed helper for the
component.parameterblock ofaws_imagebuilder_container_recipe(derived from provider schema). - ImagebuilderContainerRecipeTargetRepository
-
Typed helper for the
target_repositoryblock ofaws_imagebuilder_container_recipe(derived from provider schema). - ImagebuilderDistributionConfigurationAmiDistributionConfiguration
-
Typed helper for the
distribution.ami_distribution_configurationblock ofaws_imagebuilder_distribution_configuration(derived from provider schema). - ImagebuilderDistributionConfigurationContainerDistributionConfiguration
-
Typed helper for the
distribution.container_distribution_configurationblock ofaws_imagebuilder_distribution_configuration(derived from provider schema). - ImagebuilderDistributionConfigurationDistribution
-
Typed helper for the
distributionblock ofaws_imagebuilder_distribution_configuration(derived from provider schema). - ImagebuilderDistributionConfigurationFastLaunchConfiguration
-
Typed helper for the
distribution.fast_launch_configurationblock ofaws_imagebuilder_distribution_configuration(derived from provider schema). - ImagebuilderDistributionConfigurationLaunchPermission
-
Typed helper for the
distribution.ami_distribution_configuration.launch_permissionblock ofaws_imagebuilder_distribution_configuration(derived from provider schema). - ImagebuilderDistributionConfigurationLaunchTemplate
-
Typed helper for the
distribution.fast_launch_configuration.launch_templateblock ofaws_imagebuilder_distribution_configuration(derived from provider schema). - ImagebuilderDistributionConfigurationLaunchTemplateConfiguration
-
Typed helper for the
distribution.launch_template_configurationblock ofaws_imagebuilder_distribution_configuration(derived from provider schema). - ImagebuilderDistributionConfigurationS3ExportConfiguration
-
Typed helper for the
distribution.s3_export_configurationblock ofaws_imagebuilder_distribution_configuration(derived from provider schema). - ImagebuilderDistributionConfigurationSnapshotConfiguration
-
Typed helper for the
distribution.fast_launch_configuration.snapshot_configurationblock ofaws_imagebuilder_distribution_configuration(derived from provider schema). - ImagebuilderDistributionConfigurationSsmParameterConfiguration
-
Typed helper for the
distribution.ssm_parameter_configurationblock ofaws_imagebuilder_distribution_configuration(derived from provider schema). - ImagebuilderDistributionConfigurationTargetRepository
-
Typed helper for the
distribution.container_distribution_configuration.target_repositoryblock ofaws_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_configurationblock ofaws_imagebuilder_image(derived from provider schema). - ImagebuilderImageLoggingConfiguration
-
Typed helper for the
logging_configurationblock ofaws_imagebuilder_image(derived from provider schema). - ImagebuilderImageParameter
-
Typed helper for the
workflow.parameterblock ofaws_imagebuilder_image(derived from provider schema). - ImagebuilderImagePipelineContainerRecipeArn
-
The ImagebuilderImagePipelineRecipeArn.containerRecipeArn choice: sets
container_recipe_arn. - ImagebuilderImagePipelineEcrConfiguration
-
Typed helper for the
image_scanning_configuration.ecr_configurationblock ofaws_imagebuilder_image_pipeline(derived from provider schema). - ImagebuilderImagePipelineImageRecipeArn
-
The ImagebuilderImagePipelineRecipeArn.imageRecipeArn choice: sets
image_recipe_arn. - ImagebuilderImagePipelineImageScanningConfiguration
-
Typed helper for the
image_scanning_configurationblock ofaws_imagebuilder_image_pipeline(derived from provider schema). - ImagebuilderImagePipelineImageTestsConfiguration
-
Typed helper for the
image_tests_configurationblock ofaws_imagebuilder_image_pipeline(derived from provider schema). - ImagebuilderImagePipelineLoggingConfiguration
-
Typed helper for the
logging_configurationblock ofaws_imagebuilder_image_pipeline(derived from provider schema). - ImagebuilderImagePipelineParameter
-
Typed helper for the
workflow.parameterblock ofaws_imagebuilder_image_pipeline(derived from provider schema). - ImagebuilderImagePipelineRecipeArn
-
Exactly one of
container_recipe_arn,image_recipe_arnonaws_imagebuilder_image_pipeline: the provider rejects none and more than one, so each variant sets one of them. - ImagebuilderImagePipelineSchedule
-
Typed helper for the
scheduleblock ofaws_imagebuilder_image_pipeline(derived from provider schema). - ImagebuilderImagePipelineWorkflow
-
Typed helper for the
workflowblock ofaws_imagebuilder_image_pipeline(derived from provider schema). - ImagebuilderImageRecipeArn
-
Exactly one of
container_recipe_arn,image_recipe_arnonaws_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_mappingblock ofaws_imagebuilder_image_recipe(derived from provider schema). - ImagebuilderImageRecipeComponent
-
Typed helper for the
componentblock ofaws_imagebuilder_image_recipe(derived from provider schema). - ImagebuilderImageRecipeEbs
-
Typed helper for the
block_device_mapping.ebsblock ofaws_imagebuilder_image_recipe(derived from provider schema). - ImagebuilderImageRecipeParameter
-
Typed helper for the
component.parameterblock ofaws_imagebuilder_image_recipe(derived from provider schema). - ImagebuilderImageRecipeSystemsManagerAgent
-
Typed helper for the
systems_manager_agentblock ofaws_imagebuilder_image_recipe(derived from provider schema). - ImagebuilderImageScanningConfiguration
-
Typed helper for the
image_scanning_configurationblock ofaws_imagebuilder_image(derived from provider schema). - ImagebuilderImageTestsConfiguration
-
Typed helper for the
image_tests_configurationblock ofaws_imagebuilder_image(derived from provider schema). - ImagebuilderImageWorkflow
-
Typed helper for the
workflowblock ofaws_imagebuilder_image(derived from provider schema). - ImagebuilderInfrastructureConfigurationHost
-
At most one of
host_id,host_resource_group_arnon theplacementblock ofaws_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_optionsblock ofaws_imagebuilder_infrastructure_configuration(derived from provider schema). - ImagebuilderInfrastructureConfigurationLogging
-
Typed helper for the
loggingblock ofaws_imagebuilder_infrastructure_configuration(derived from provider schema). - ImagebuilderInfrastructureConfigurationPlacement
-
Typed helper for the
placementblock ofaws_imagebuilder_infrastructure_configuration(derived from provider schema). - ImagebuilderInfrastructureConfigurationS3Logs
-
Typed helper for the
logging.s3_logsblock ofaws_imagebuilder_infrastructure_configuration(derived from provider schema). - ImagebuilderLifecyclePolicyAction
-
Typed helper for the
policy_detail.actionblock ofaws_imagebuilder_lifecycle_policy(derived from provider schema). - ImagebuilderLifecyclePolicyAmis
-
Typed helper for the
policy_detail.exclusion_rules.amisblock ofaws_imagebuilder_lifecycle_policy(derived from provider schema). - ImagebuilderLifecyclePolicyDetail
-
Typed helper for the
policy_detailblock ofaws_imagebuilder_lifecycle_policy(derived from provider schema). - ImagebuilderLifecyclePolicyExclusionRules
-
Typed helper for the
policy_detail.exclusion_rulesblock ofaws_imagebuilder_lifecycle_policy(derived from provider schema). - ImagebuilderLifecyclePolicyFilter
-
Typed helper for the
policy_detail.filterblock ofaws_imagebuilder_lifecycle_policy(derived from provider schema). - ImagebuilderLifecyclePolicyIncludeResources
-
Typed helper for the
policy_detail.action.include_resourcesblock ofaws_imagebuilder_lifecycle_policy(derived from provider schema). - ImagebuilderLifecyclePolicyLastLaunched
-
Typed helper for the
policy_detail.exclusion_rules.amis.last_launchedblock ofaws_imagebuilder_lifecycle_policy(derived from provider schema). - ImagebuilderLifecyclePolicyRecipe
-
Typed helper for the
resource_selection.recipeblock ofaws_imagebuilder_lifecycle_policy(derived from provider schema). - ImagebuilderLifecyclePolicyResourceSelection
-
Typed helper for the
resource_selectionblock ofaws_imagebuilder_lifecycle_policy(derived from provider schema). - ImagebuilderWorkflowDocument
-
Exactly one of
data,urionaws_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.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. - 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
- 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.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").
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.