account library

Cloudflare accounts, members, tokens, and organization settings.

Classes

AccountDnsSettingsInternalDns
Typed helper for the zone_defaults.internal_dns block of cloudflare_account_dns_settings (derived from provider schema).
AccountDnsSettingsNameservers
Typed helper for the zone_defaults.nameservers block of cloudflare_account_dns_settings (derived from provider schema).
AccountDnsSettingsSoa
Typed helper for the zone_defaults.soa block of cloudflare_account_dns_settings (derived from provider schema).
AccountDnsSettingsZoneDefaults
Typed helper for the zone_defaults block of cloudflare_account_dns_settings (derived from provider schema).
AccountManagedBy
Typed helper for the managed_by block of cloudflare_account (derived from provider schema).
AccountMemberAccess
Exactly one of roles, policies on cloudflare_account_member: the provider rejects none and more than one, so each variant sets one of them.
AccountMemberAccessPolicies
The AccountMemberAccess.policies choice: sets policies.
AccountMemberAccessRoles
The AccountMemberAccess.roles choice: sets roles.
AccountMemberPermissionGroups
Typed helper for the policies.permission_groups block of cloudflare_account_member (derived from provider schema).
AccountMemberPolicies
Typed helper for the policies block of cloudflare_account_member (derived from provider schema).
AccountMemberResourceGroups
Typed helper for the policies.resource_groups block of cloudflare_account_member (derived from provider schema).
AccountSettings
Typed helper for the settings block of cloudflare_account (derived from provider schema).
AccountSubscriptionRatePlan
Typed helper for the rate_plan block of cloudflare_account_subscription (derived from provider schema).
AccountTokenCondition
Typed helper for the condition block of cloudflare_account_token (derived from provider schema).
AccountTokenPermissionGroups
Typed helper for the policies.permission_groups block of cloudflare_account_token (derived from provider schema).
AccountTokenPolicies
Typed helper for the policies block of cloudflare_account_token (derived from provider schema).
AccountTokenRequestIp
Typed helper for the condition.request_ip block of cloudflare_account_token (derived from provider schema).
AccountUnit
Typed helper for the unit block of cloudflare_account (derived from provider schema).
ApiTokenCondition
Typed helper for the condition block of cloudflare_api_token (derived from provider schema).
ApiTokenPermissionGroups
Typed helper for the policies.permission_groups block of cloudflare_api_token (derived from provider schema).
ApiTokenPolicies
Typed helper for the policies block of cloudflare_api_token (derived from provider schema).
ApiTokenRequestIp
Typed helper for the condition.request_ip block of cloudflare_api_token (derived from provider schema).
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.
CloudflareAccount
Factory wrapper for cloudflare_account.
CloudflareAccountDnsSettings
Factory wrapper for cloudflare_account_dns_settings.
CloudflareAccountDnsSettingsInternalView
Factory wrapper for cloudflare_account_dns_settings_internal_view.
CloudflareAccountMember
Factory wrapper for cloudflare_account_member.
CloudflareAccountSubscription
Factory wrapper for cloudflare_account_subscription.
CloudflareAccountToken
Factory wrapper for cloudflare_account_token.
CloudflareApiToken
Factory wrapper for cloudflare_api_token.
CloudflareOauthClient
Factory wrapper for cloudflare_oauth_client.
CloudflareOrganization
Factory wrapper for cloudflare_organization.
CloudflareOrganizationProfile
Factory wrapper for cloudflare_organization_profile.
CloudflareSsoConnector
Factory wrapper for cloudflare_sso_connector.
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.
DataAccountDnsSettingsInternalViewFilter
Typed helper for the filter block of cloudflare_account_dns_settings_internal_view (derived from provider schema).
DataAccountDnsSettingsInternalViewFilterName
Typed helper for the filter.name block of cloudflare_account_dns_settings_internal_view (derived from provider schema).
DataAccountDnsSettingsInternalViewsName
Typed helper for the name block of cloudflare_account_dns_settings_internal_views (derived from provider schema).
DataAccountFilter
Typed helper for the filter block of cloudflare_account (derived from provider schema).
DataAccountMemberFilter
Typed helper for the filter block of cloudflare_account_member (derived from provider schema).
DataAccountTokenFilter
Typed helper for the filter block of cloudflare_account_token (derived from provider schema).
DataApiTokenFilter
Typed helper for the filter block of cloudflare_api_token (derived from provider schema).
DataCloudflareAccount
Factory wrapper for cloudflare_account.
DataCloudflareAccountApiTokenPermissionGroups
Factory wrapper for cloudflare_account_api_token_permission_groups.
DataCloudflareAccountApiTokenPermissionGroupsList
Factory wrapper for cloudflare_account_api_token_permission_groups_list.
DataCloudflareAccountDnsSettings
Factory wrapper for cloudflare_account_dns_settings.
DataCloudflareAccountDnsSettingsInternalView
Factory wrapper for cloudflare_account_dns_settings_internal_view.
DataCloudflareAccountDnsSettingsInternalViews
Factory wrapper for cloudflare_account_dns_settings_internal_views.
DataCloudflareAccountMember
Factory wrapper for cloudflare_account_member.
DataCloudflareAccountMembers
Factory wrapper for cloudflare_account_members.
DataCloudflareAccountPermissionGroup
Factory wrapper for cloudflare_account_permission_group.
DataCloudflareAccountPermissionGroups
Factory wrapper for cloudflare_account_permission_groups.
DataCloudflareAccountRole
Factory wrapper for cloudflare_account_role.
DataCloudflareAccountRoles
Factory wrapper for cloudflare_account_roles.
DataCloudflareAccountSubscription
Factory wrapper for cloudflare_account_subscription.
DataCloudflareAccountToken
Factory wrapper for cloudflare_account_token.
DataCloudflareAccountTokens
Factory wrapper for cloudflare_account_tokens.
DataCloudflareApiToken
Factory wrapper for cloudflare_api_token.
DataCloudflareApiTokenPermissionGroupsList
Factory wrapper for cloudflare_api_token_permission_groups_list.
DataCloudflareOauthClient
Factory wrapper for cloudflare_oauth_client.
DataCloudflareOrganization
Factory wrapper for cloudflare_organization.
DataCloudflareOrganizationProfile
Factory wrapper for cloudflare_organization_profile.
DataCloudflareSsoConnector
Factory wrapper for cloudflare_sso_connector.
DataOrganizationContaining
Typed helper for the filter.containing block of cloudflare_organization (derived from provider schema).
DataOrganizationFilter
Typed helper for the filter block of cloudflare_organization (derived from provider schema).
DataOrganizationFilterName
Typed helper for the filter.name block of cloudflare_organization (derived from provider schema).
DataOrganizationParent
Typed helper for the filter.parent block of cloudflare_organization (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.
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.
OrganizationParent
Typed helper for the parent block of cloudflare_organization (derived from provider schema).
OrganizationProfile
Typed helper for the profile block of cloudflare_organization (derived from provider schema).
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

AccountDnsSettingsType
type — derived from the provider schema description.
AccountDnsSettingsZoneMode
zone_mode — derived from the provider schema description.
AccountMemberPoliciesAccess
access — derived from the provider schema description.
AccountMemberStatus
Account Member enum for status.
AccountSubscriptionFrequency
Account Subscription enum for frequency.
AccountSubscriptionRatePlanId
id — derived from the provider schema description.
AccountTokenEffect
effect — derived from the provider schema description.
AccountTokenStatus
Account Token enum for status.
AccountType
Account enum for type.
ApiTokenEffect
effect — derived from the provider schema description.
ApiTokenStatus
Api Token enum for status.
DataAccountDirection
direction — derived from the provider schema description.
DataAccountDnsSettingsInternalViewDirection
direction — derived from the provider schema description.
DataAccountDnsSettingsInternalViewMatch
match — derived from the provider schema description.
DataAccountDnsSettingsInternalViewOrder
order — derived from the provider schema description.
DataAccountMemberDirection
direction — derived from the provider schema description.
DataAccountMemberFilterStatus
status — derived from the provider schema description.
DataAccountMemberOrder
order — derived from the provider schema description.
DataAccountTokenDirection
direction — derived from the provider schema description.
DataApiTokenDirection
direction — derived from the provider schema description.
OauthClientGrantTypes
Oauth Client Grant enum for grant_types.
OauthClientResponseTypes
Oauth Client Response enum for response_types.
OauthClientTokenEndpointAuthMethod
Oauth Client Token Endpoint Auth enum for token_endpoint_auth_method.
OauthClientVisibility
Oauth Client enum for visibility.
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.