artifact_registry library

Artifact Registry: container / package repository, per-repository IAM, and repository download rules.

Format is set at creation time and immutable. Pair format: DOCKER with ArtifactRegistryRepositoryArtifactRegistryDockerConfig, format: MAVEN with ArtifactRegistryRepositoryArtifactRegistryMavenConfig. Mode is STANDARD_REPOSITORY (default), VIRTUAL_REPOSITORY (aggregating proxy), or REMOTE_REPOSITORY (caching proxy).

Note: google_artifact_registry_vpcsc_config is beta-only; not curated in v0.8.0-dev. A follow-up PR extends the schema fixture against terraform-provider-google-beta and adds that resource.

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.
ArtifactRegistryProjectConfigPlatformLogsConfig
platform_logs_config block — platform log emission for Artifact Registry operations in this project/location.
ArtifactRegistryRepositoryAptRepository
Typed helper for the remote_repository_config.apt_repository block of google_artifact_registry_repository (derived from provider schema).
ArtifactRegistryRepositoryAptRepositoryPublicRepository
Typed helper for the remote_repository_config.apt_repository.public_repository block of google_artifact_registry_repository (derived from provider schema).
ArtifactRegistryRepositoryCleanupPolicies
Typed helper for the cleanup_policies block of google_artifact_registry_repository (derived from provider schema).
ArtifactRegistryRepositoryCommonRepository
Typed helper for the remote_repository_config.common_repository block of google_artifact_registry_repository (derived from provider schema).
ArtifactRegistryRepositoryCondition
Typed helper for the cleanup_policies.condition block of google_artifact_registry_repository (derived from provider schema).
ArtifactRegistryRepositoryConfig
At most one of virtual_repository_config, remote_repository_config on google_artifact_registry_repository: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ArtifactRegistryRepositoryCustomRepository
Typed helper for the remote_repository_config.docker_repository.custom_repository block of google_artifact_registry_repository (derived from provider schema). Shared by every block of this shape in the resource.
ArtifactRegistryRepositoryDockerConfig
Typed helper for the docker_config block of google_artifact_registry_repository (derived from provider schema).
ArtifactRegistryRepositoryDockerRepository
At most one of public_repository, custom_repository on the remote_repository_config.docker_repository block of google_artifact_registry_repository: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ArtifactRegistryRepositoryDockerRepositoryCustomRepository
The ArtifactRegistryRepositoryDockerRepository.customRepository choice: sets custom_repository.
ArtifactRegistryRepositoryDockerRepositoryPublicRepository
The ArtifactRegistryRepositoryDockerRepository.publicRepository choice: sets public_repository.
ArtifactRegistryRepositoryIamBindingCondition
Typed helper for the condition block of google_artifact_registry_repository_iam_binding (derived from provider schema).
ArtifactRegistryRepositoryIamMemberCondition
Typed helper for the condition block of google_artifact_registry_repository_iam_member (derived from provider schema).
ArtifactRegistryRepositoryMavenConfig
Typed helper for the maven_config block of google_artifact_registry_repository (derived from provider schema).
ArtifactRegistryRepositoryMavenRepository
At most one of public_repository, custom_repository on the remote_repository_config.maven_repository block of google_artifact_registry_repository: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ArtifactRegistryRepositoryMavenRepositoryCustomRepository
The ArtifactRegistryRepositoryMavenRepository.customRepository choice: sets custom_repository.
ArtifactRegistryRepositoryMavenRepositoryPublicRepository
The ArtifactRegistryRepositoryMavenRepository.publicRepository choice: sets public_repository.
ArtifactRegistryRepositoryMostRecentVersions
Typed helper for the cleanup_policies.most_recent_versions block of google_artifact_registry_repository (derived from provider schema).
ArtifactRegistryRepositoryNoCache
Typed helper for the remote_repository_config.no_cache block of google_artifact_registry_repository (derived from provider schema).
ArtifactRegistryRepositoryNpmRepository
At most one of public_repository, custom_repository on the remote_repository_config.npm_repository block of google_artifact_registry_repository: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ArtifactRegistryRepositoryNpmRepositoryCustomRepository
The ArtifactRegistryRepositoryNpmRepository.customRepository choice: sets custom_repository.
ArtifactRegistryRepositoryNpmRepositoryPublicRepository
The ArtifactRegistryRepositoryNpmRepository.publicRepository choice: sets public_repository.
ArtifactRegistryRepositoryPythonRepository
At most one of public_repository, custom_repository on the remote_repository_config.python_repository block of google_artifact_registry_repository: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ArtifactRegistryRepositoryPythonRepositoryCustomRepository
The ArtifactRegistryRepositoryPythonRepository.customRepository choice: sets custom_repository.
ArtifactRegistryRepositoryPythonRepositoryPublicRepository
The ArtifactRegistryRepositoryPythonRepository.publicRepository choice: sets public_repository.
ArtifactRegistryRepositoryRemoteRepositoryConfig
Typed helper for the remote_repository_config block of google_artifact_registry_repository (derived from provider schema).
ArtifactRegistryRepositoryRemoteRepositoryConfigChoice
The ArtifactRegistryRepositoryConfig.remoteRepositoryConfig choice: sets remote_repository_config.
ArtifactRegistryRepositoryRemoteRepositoryConfigFormat
Exactly one of apt_repository, docker_repository, maven_repository, npm_repository, python_repository, yum_repository, common_repository on the remote_repository_config block of google_artifact_registry_repository: the provider rejects none and more than one, so each variant sets one of them.
ArtifactRegistryRepositoryRemoteRepositoryConfigFormatAptRepository
The ArtifactRegistryRepositoryRemoteRepositoryConfigFormat.aptRepository choice: sets apt_repository.
ArtifactRegistryRepositoryRemoteRepositoryConfigFormatCommonRepository
The ArtifactRegistryRepositoryRemoteRepositoryConfigFormat.commonRepository choice: sets common_repository.
ArtifactRegistryRepositoryRemoteRepositoryConfigFormatDockerRepository
The ArtifactRegistryRepositoryRemoteRepositoryConfigFormat.dockerRepository choice: sets docker_repository.
ArtifactRegistryRepositoryRemoteRepositoryConfigFormatMavenRepository
The ArtifactRegistryRepositoryRemoteRepositoryConfigFormat.mavenRepository choice: sets maven_repository.
ArtifactRegistryRepositoryRemoteRepositoryConfigFormatNpmRepository
The ArtifactRegistryRepositoryRemoteRepositoryConfigFormat.npmRepository choice: sets npm_repository.
ArtifactRegistryRepositoryRemoteRepositoryConfigFormatPythonRepository
The ArtifactRegistryRepositoryRemoteRepositoryConfigFormat.pythonRepository choice: sets python_repository.
ArtifactRegistryRepositoryRemoteRepositoryConfigFormatYumRepository
The ArtifactRegistryRepositoryRemoteRepositoryConfigFormat.yumRepository choice: sets yum_repository.
ArtifactRegistryRepositoryUpstreamCredentials
Typed helper for the remote_repository_config.upstream_credentials block of google_artifact_registry_repository (derived from provider schema).
ArtifactRegistryRepositoryUpstreamPolicies
Typed helper for the virtual_repository_config.upstream_policies block of google_artifact_registry_repository (derived from provider schema).
ArtifactRegistryRepositoryUsernamePasswordCredentials
Typed helper for the remote_repository_config.upstream_credentials.username_password_credentials block of google_artifact_registry_repository (derived from provider schema).
ArtifactRegistryRepositoryVirtualRepositoryConfig
Typed helper for the virtual_repository_config block of google_artifact_registry_repository (derived from provider schema).
ArtifactRegistryRepositoryVirtualRepositoryConfigChoice
The ArtifactRegistryRepositoryConfig.virtualRepositoryConfig choice: sets virtual_repository_config.
ArtifactRegistryRepositoryVulnerabilityScanningConfig
Typed helper for the vulnerability_scanning_config block of google_artifact_registry_repository (derived from provider schema).
ArtifactRegistryRepositoryYumRepository
Typed helper for the remote_repository_config.yum_repository block of google_artifact_registry_repository (derived from provider schema).
ArtifactRegistryRepositoryYumRepositoryPublicRepository
Typed helper for the remote_repository_config.yum_repository.public_repository block of google_artifact_registry_repository (derived from provider schema).
ArtifactRegistryRuleCondition
Typed helper for the condition block of google_artifact_registry_rule (derived from provider schema).
AttributeRef<T>
Public for sealed pattern matching, but constructor is private — only TfRef.attribute() may construct instances.
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.
DataGoogleArtifactRegistryDockerImage
Factory wrapper for google_artifact_registry_docker_image.
DataGoogleArtifactRegistryDockerImages
Factory wrapper for google_artifact_registry_docker_images.
DataGoogleArtifactRegistryFile
Factory wrapper for google_artifact_registry_file.
DataGoogleArtifactRegistryLocations
Factory wrapper for google_artifact_registry_locations.
DataGoogleArtifactRegistryMavenArtifact
Factory wrapper for google_artifact_registry_maven_artifact.
DataGoogleArtifactRegistryMavenArtifacts
Factory wrapper for google_artifact_registry_maven_artifacts.
DataGoogleArtifactRegistryNpmPackage
Factory wrapper for google_artifact_registry_npm_package.
DataGoogleArtifactRegistryNpmPackages
Factory wrapper for google_artifact_registry_npm_packages.
DataGoogleArtifactRegistryPackage
Factory wrapper for google_artifact_registry_package.
DataGoogleArtifactRegistryPackages
Factory wrapper for google_artifact_registry_packages.
DataGoogleArtifactRegistryPythonPackage
Factory wrapper for google_artifact_registry_python_package.
DataGoogleArtifactRegistryPythonPackages
Factory wrapper for google_artifact_registry_python_packages.
DataGoogleArtifactRegistryRepositories
Factory wrapper for google_artifact_registry_repositories.
DataGoogleArtifactRegistryRepository
Factory wrapper for google_artifact_registry_repository.
DataGoogleArtifactRegistryRepositoryIamPolicy
Factory wrapper for google_artifact_registry_repository_iam_policy.
DataGoogleArtifactRegistryTag
Factory wrapper for google_artifact_registry_tag.
DataGoogleArtifactRegistryTags
Factory wrapper for google_artifact_registry_tags.
DataGoogleArtifactRegistryVersion
Factory wrapper for google_artifact_registry_version.
DataGoogleArtifactRegistryVersions
Factory wrapper for google_artifact_registry_versions.
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.
GoogleArtifactRegistryProjectConfig
Factory wrapper for google_artifact_registry_project_config.
GoogleArtifactRegistryRepository
Factory wrapper for google_artifact_registry_repository.
GoogleArtifactRegistryRepositoryIamBinding
Factory wrapper for google_artifact_registry_repository_iam_binding.
GoogleArtifactRegistryRepositoryIamMember
Factory wrapper for google_artifact_registry_repository_iam_member.
GoogleArtifactRegistryRepositoryIamPolicy
Factory wrapper for google_artifact_registry_repository_iam_policy.
GoogleArtifactRegistryRule
Factory wrapper for google_artifact_registry_rule.
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

ArtifactRegistryAptRepositoryBase
remote_repository_config.apt_repository.public_repository.repository_base.
ArtifactRegistryCleanupAction
cleanup_policies.action -- what the cleanup policy does to matching versions when its condition fires.
ArtifactRegistryCleanupTagState
cleanup_policies.condition.tag_state -- limits a cleanup condition to tagged / untagged / any versions. Schema default ANY.
ArtifactRegistryDockerPublicRepository
remote_repository_config.docker_repository.public_repository.
ArtifactRegistryMavenPublicRepository
remote_repository_config.maven_repository.public_repository.
ArtifactRegistryMavenVersionPolicy
maven_config.version_policy -- which Maven version classes the repository accepts. Schema default VERSION_POLICY_UNSPECIFIED.
ArtifactRegistryMode
mode for google_artifact_registry_repository. Picks the repository shape: standard (push/pull), virtual (federated view over other repositories), or remote (pull-through cache of an upstream registry). The schema defaults to STANDARD_REPOSITORY.
ArtifactRegistryNpmPublicRepository
remote_repository_config.npm_repository.public_repository.
ArtifactRegistryPlatformLogsLoggingState
platform_logs_config.logging_state — whether platform logs are emitted.
ArtifactRegistryPlatformLogsSeverityLevel
platform_logs_config.severity_level — minimum log severity to record.
ArtifactRegistryRuleAction
Artifact Registry Rule enum for action.
ArtifactRegistryRuleOperation
Artifact Registry Rule enum for operation.
ArtifactRegistryVulnerabilityEnablementConfig
vulnerability_scanning_config.enablement_config -- whether vulnerability scanning is enabled for artifacts pushed to this repo. INHERITED defers to the project-level Artifact Analysis API state.
ArtifactRegistryYumRepositoryBase
remote_repository_config.yum_repository.public_repository.repository_base.
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.