role library

Azure Resource Manager role resources.

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.
AzurermBackend
terraform { backend "azurerm" { ... } } configuration.
AzurermRoleAssignment
Factory wrapper for azurerm_role_assignment.
AzurermRoleDefinition
Factory wrapper for azurerm_role_definition.
AzurermRoleManagementPolicy
Factory wrapper for azurerm_role_management_policy.
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.
DataAzurermRoleAssignments
Factory wrapper for azurerm_role_assignments.
DataAzurermRoleDefinition
Factory wrapper for azurerm_role_definition.
DataAzurermRoleManagementPolicy
Factory wrapper for azurerm_role_management_policy.
DataRef<T>
Public for sealed pattern matching, but constructor is private — only TfRef.data() may construct instances.
DataRoleDefinitionLookup
Exactly one of name, role_definition_id on data.azurerm_role_definition: the provider rejects none and more than one, so each variant sets one of them.
DataRoleDefinitionLookupName
The DataRoleDefinitionLookup.name choice: sets name.
DataRoleDefinitionLookupRoleDefinitionId
The DataRoleDefinitionLookup.roleDefinitionId choice: sets role_definition_id.
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.
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.
RoleAssignmentRoleDefinition
Exactly one of role_definition_id, role_definition_name on azurerm_role_assignment: the provider rejects none and more than one, so each variant sets one of them.
RoleAssignmentRoleDefinitionId
The RoleAssignmentRoleDefinition.roleDefinitionId choice: sets role_definition_id.
RoleAssignmentRoleDefinitionName
The RoleAssignmentRoleDefinition.roleDefinitionName choice: sets role_definition_name.
RoleDefinitionPermissions
Typed helper for the permissions block of azurerm_role_definition (derived from provider schema).
RoleManagementPolicyActivationRules
Typed helper for the activation_rules block of azurerm_role_management_policy (derived from provider schema).
RoleManagementPolicyActiveAssignmentRules
Typed helper for the active_assignment_rules block of azurerm_role_management_policy (derived from provider schema).
RoleManagementPolicyActiveAssignments
Typed helper for the notification_rules.active_assignments block of azurerm_role_management_policy (derived from provider schema).
RoleManagementPolicyAdminNotifications
Typed helper for the notification_rules.active_assignments.admin_notifications block of azurerm_role_management_policy (derived from provider schema). Shared by every block of this shape in the resource.
RoleManagementPolicyApprovalStage
Typed helper for the activation_rules.approval_stage block of azurerm_role_management_policy (derived from provider schema).
RoleManagementPolicyApproverNotifications
Typed helper for the notification_rules.active_assignments.approver_notifications block of azurerm_role_management_policy (derived from provider schema). Shared by every block of this shape in the resource.
RoleManagementPolicyAssigneeNotifications
Typed helper for the notification_rules.active_assignments.assignee_notifications block of azurerm_role_management_policy (derived from provider schema). Shared by every block of this shape in the resource.
RoleManagementPolicyAuthentication
At most one of require_multifactor_authentication, required_conditional_access_authentication_context on the activation_rules block of azurerm_role_management_policy: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
RoleManagementPolicyAuthenticationRequiredConditionalAccessAuthenticationContext
The RoleManagementPolicyAuthentication.requiredConditionalAccessAuthenticationContext choice: sets required_conditional_access_authentication_context.
RoleManagementPolicyEligibleActivations
Typed helper for the notification_rules.eligible_activations block of azurerm_role_management_policy (derived from provider schema).
RoleManagementPolicyEligibleAssignmentRules
Typed helper for the eligible_assignment_rules block of azurerm_role_management_policy (derived from provider schema).
RoleManagementPolicyEligibleAssignments
Typed helper for the notification_rules.eligible_assignments block of azurerm_role_management_policy (derived from provider schema).
RoleManagementPolicyNotificationRules
Typed helper for the notification_rules block of azurerm_role_management_policy (derived from provider schema).
RoleManagementPolicyPrimaryApprover
Typed helper for the activation_rules.approval_stage.primary_approver block of azurerm_role_management_policy (derived from provider schema).
RoleManagementPolicyRequireMultifactorAuthentication
The RoleManagementPolicyAuthentication.requireMultifactorAuthentication choice: sets require_multifactor_authentication.
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, AzurermBackend, 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 Stack.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

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, ...).
RoleAssignmentConditionVersion
Role Assignment Condition enum for condition_version.
RoleAssignmentPrincipalType
Role Assignment Principal enum for principal_type.
RoleManagementPolicyExpireAfter
expire_after — derived from the provider schema description.
RoleManagementPolicyMaximumDuration
maximum_duration — derived from the provider schema description.
RoleManagementPolicyNotificationLevel
notification_level — derived from the provider schema description.
RoleManagementPolicyType
type — derived from the provider schema description.

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.

Typedefs

EnumList<E extends TfArg<String>> = TfArg<List<E>>
A list-valued enum argument (allowed_grant_types, retry_conditions): a literal list of members of E, or one value Terraform resolves to the whole list.

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.