identity library

Identity Platform — project Auth config, multi-tenant realms, project and tenant OIDC IdP metadata, leftover default-supported / SAML IdP configs, and Cloud Identity groups / memberships (apply-excluded).

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.
CloudIdentityGroupKey
Typed helper for the group_key block of google_cloud_identity_group (derived from provider schema).
CloudIdentityGroupMembershipExpiryDetail
Typed helper for the roles.expiry_detail block of google_cloud_identity_group_membership (derived from provider schema).
CloudIdentityGroupMembershipPreferredMemberKey
Typed helper for the preferred_member_key block of google_cloud_identity_group_membership (derived from provider schema).
CloudIdentityGroupMembershipRoles
Typed helper for the roles block of google_cloud_identity_group_membership (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.
DataCloudIdentityGroupLookupGroupKey
Typed helper for the group_key block of google_cloud_identity_group_lookup (derived from provider schema).
DataGoogleCloudIdentityGroupLookup
Factory wrapper for google_cloud_identity_group_lookup.
DataGoogleCloudIdentityGroupMemberships
Factory wrapper for google_cloud_identity_group_memberships.
DataGoogleCloudIdentityGroups
Factory wrapper for google_cloud_identity_groups.
DataGoogleCloudIdentityGroupTransitiveMemberships
Factory wrapper for google_cloud_identity_group_transitive_memberships.
DataGoogleCloudIdentityPolicies
Factory wrapper for google_cloud_identity_policies.
DataGoogleCloudIdentityPolicy
Factory wrapper for google_cloud_identity_policy.
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.
GoogleCloudIdentityGroup
Factory wrapper for google_cloud_identity_group.
GoogleCloudIdentityGroupMembership
Factory wrapper for google_cloud_identity_group_membership.
GoogleIdentityPlatformConfig
Factory wrapper for google_identity_platform_config.
GoogleIdentityPlatformDefaultSupportedIdpConfig
Factory wrapper for google_identity_platform_default_supported_idp_config.
GoogleIdentityPlatformInboundSamlConfig
Factory wrapper for google_identity_platform_inbound_saml_config.
GoogleIdentityPlatformOauthIdpConfig
Factory wrapper for google_identity_platform_oauth_idp_config.
GoogleIdentityPlatformTenant
Factory wrapper for google_identity_platform_tenant.
GoogleIdentityPlatformTenantDefaultSupportedIdpConfig
Factory wrapper for google_identity_platform_tenant_default_supported_idp_config.
GoogleIdentityPlatformTenantInboundSamlConfig
Factory wrapper for google_identity_platform_tenant_inbound_saml_config.
GoogleIdentityPlatformTenantOauthIdpConfig
Factory wrapper for google_identity_platform_tenant_oauth_idp_config.
IdentityPlatformConfigAllowByDefault
Typed helper for the sms_region_config.allow_by_default block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigAllowlistOnly
Typed helper for the sms_region_config.allowlist_only block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigAnonymous
Typed helper for the sign_in.anonymous block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigBlockingFunctions
Typed helper for the blocking_functions block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigClient
Typed helper for the client block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigEmail
Typed helper for the sign_in.email block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigForwardInboundCredentials
Typed helper for the blocking_functions.forward_inbound_credentials block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigMfa
Typed helper for the mfa block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigMonitoring
Typed helper for the monitoring block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigMultiTenant
Typed helper for the multi_tenant block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigPermissions
Typed helper for the client.permissions block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigPhoneNumber
Typed helper for the sign_in.phone_number block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigProviderConfigs
Typed helper for the mfa.provider_configs block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigQuota
Typed helper for the quota block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigRequestLogging
Typed helper for the monitoring.request_logging block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigSignIn
Typed helper for the sign_in block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigSignUpQuotaConfig
Typed helper for the quota.sign_up_quota_config block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigSmsRegionConfig
Exactly one of allow_by_default, allowlist_only on the sms_region_config block of google_identity_platform_config: the provider rejects none and more than one, so each variant sets one of them.
IdentityPlatformConfigSmsRegionConfigAllowByDefault
The IdentityPlatformConfigSmsRegionConfig.allowByDefault choice: sets allow_by_default.
IdentityPlatformConfigSmsRegionConfigAllowlistOnly
The IdentityPlatformConfigSmsRegionConfig.allowlistOnly choice: sets allowlist_only.
IdentityPlatformConfigTotpProviderConfig
Typed helper for the mfa.provider_configs.totp_provider_config block of google_identity_platform_config (derived from provider schema).
IdentityPlatformConfigTriggers
Typed helper for the blocking_functions.triggers block of google_identity_platform_config (derived from provider schema).
IdentityPlatformInboundSamlConfigIdpCertificates
Typed helper for the idp_config.idp_certificates block of google_identity_platform_inbound_saml_config (derived from provider schema).
IdentityPlatformInboundSamlConfigIdpConfig
Typed helper for the idp_config block of google_identity_platform_inbound_saml_config (derived from provider schema).
IdentityPlatformInboundSamlConfigSpConfig
Typed helper for the sp_config block of google_identity_platform_inbound_saml_config (derived from provider schema).
IdentityPlatformOauthIdpConfigResponseType
Typed helper for the response_type block of google_identity_platform_oauth_idp_config (derived from provider schema).
IdentityPlatformTenantClient
Typed helper for the client block of google_identity_platform_tenant (derived from provider schema).
IdentityPlatformTenantInboundSamlConfigIdpCertificates
Typed helper for the idp_config.idp_certificates block of google_identity_platform_tenant_inbound_saml_config (derived from provider schema).
IdentityPlatformTenantInboundSamlConfigIdpConfig
Typed helper for the idp_config block of google_identity_platform_tenant_inbound_saml_config (derived from provider schema).
IdentityPlatformTenantInboundSamlConfigSpConfig
Typed helper for the sp_config block of google_identity_platform_tenant_inbound_saml_config (derived from provider schema).
IdentityPlatformTenantPermissions
Typed helper for the client.permissions block of google_identity_platform_tenant (derived from provider schema).
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

CloudIdentityGroupInitialGroupConfig
Cloud Identity Group Initial Group enum for initial_group_config.
CloudIdentityGroupMembershipRolesName
name — derived from the provider schema description.
IdentityPlatformConfigState
state — derived from the provider schema description.
IdentityPlatformTenantDeletionPolicy
Terraform deletion_policy for Identity Platform tenants.
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.