key_vault library

Azure Resource Manager key vault 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.
AzurermDedicatedHardwareSecurityModule
Factory wrapper for azurerm_dedicated_hardware_security_module.
AzurermKeyVault
Factory wrapper for azurerm_key_vault.
AzurermKeyVaultAccessPolicy
Factory wrapper for azurerm_key_vault_access_policy.
AzurermKeyVaultCertificate
Factory wrapper for azurerm_key_vault_certificate.
AzurermKeyVaultCertificateContacts
Factory wrapper for azurerm_key_vault_certificate_contacts.
AzurermKeyVaultCertificateIssuer
Factory wrapper for azurerm_key_vault_certificate_issuer.
AzurermKeyVaultKey
Factory wrapper for azurerm_key_vault_key.
AzurermKeyVaultManagedHardwareSecurityModule
Factory wrapper for azurerm_key_vault_managed_hardware_security_module.
AzurermKeyVaultManagedHardwareSecurityModuleKey
Factory wrapper for azurerm_key_vault_managed_hardware_security_module_key.
AzurermKeyVaultManagedHardwareSecurityModuleKeyRotationPolicy
Factory wrapper for azurerm_key_vault_managed_hardware_security_module_key_rotation_policy.
AzurermKeyVaultManagedHardwareSecurityModuleRoleAssignment
Factory wrapper for azurerm_key_vault_managed_hardware_security_module_role_assignment.
AzurermKeyVaultManagedHardwareSecurityModuleRoleDefinition
Factory wrapper for azurerm_key_vault_managed_hardware_security_module_role_definition.
AzurermKeyVaultManagedStorageAccount
Factory wrapper for azurerm_key_vault_managed_storage_account.
AzurermKeyVaultManagedStorageAccountSasTokenDefinition
Factory wrapper for azurerm_key_vault_managed_storage_account_sas_token_definition.
AzurermKeyVaultSecret
Factory wrapper for azurerm_key_vault_secret.
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.
DataAzurermKeyVault
Factory wrapper for azurerm_key_vault.
DataAzurermKeyVaultAccessPolicy
Factory wrapper for azurerm_key_vault_access_policy.
DataAzurermKeyVaultCertificate
Factory wrapper for azurerm_key_vault_certificate.
DataAzurermKeyVaultCertificateData
Factory wrapper for azurerm_key_vault_certificate_data.
DataAzurermKeyVaultCertificateIssuer
Factory wrapper for azurerm_key_vault_certificate_issuer.
DataAzurermKeyVaultCertificates
Factory wrapper for azurerm_key_vault_certificates.
DataAzurermKeyVaultEncryptedValue
Factory wrapper for azurerm_key_vault_encrypted_value.
DataAzurermKeyVaultKey
Factory wrapper for azurerm_key_vault_key.
DataAzurermKeyVaultManagedHardwareSecurityModule
Factory wrapper for azurerm_key_vault_managed_hardware_security_module.
DataAzurermKeyVaultManagedHardwareSecurityModuleKey
Factory wrapper for azurerm_key_vault_managed_hardware_security_module_key.
DataAzurermKeyVaultManagedHardwareSecurityModuleRoleDefinition
Factory wrapper for azurerm_key_vault_managed_hardware_security_module_role_definition.
DataAzurermKeyVaultSecret
Factory wrapper for azurerm_key_vault_secret.
DataAzurermKeyVaultSecrets
Factory wrapper for azurerm_key_vault_secrets.
DataRef<T>
Public for sealed pattern matching, but constructor is private — only TfRef.data() may construct instances.
DedicatedHardwareSecurityModuleManagementNetworkProfile
Typed helper for the management_network_profile block of azurerm_dedicated_hardware_security_module (derived from provider schema).
DedicatedHardwareSecurityModuleNetworkProfile
Typed helper for the network_profile block of azurerm_dedicated_hardware_security_module (derived from provider schema).
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.
KeyVaultCertificate
Typed helper for the certificate block of azurerm_key_vault_certificate (derived from provider schema).
KeyVaultCertificateAction
Typed helper for the certificate_policy.lifetime_action.action block of azurerm_key_vault_certificate (derived from provider schema).
KeyVaultCertificateContactsContact
Typed helper for the contact block of azurerm_key_vault_certificate_contacts (derived from provider schema).
KeyVaultCertificateIssuerAdmin
Typed helper for the admin block of azurerm_key_vault_certificate_issuer (derived from provider schema).
KeyVaultCertificateIssuerParameters
Typed helper for the certificate_policy.issuer_parameters block of azurerm_key_vault_certificate (derived from provider schema).
KeyVaultCertificateKeyProperties
Typed helper for the certificate_policy.key_properties block of azurerm_key_vault_certificate (derived from provider schema).
KeyVaultCertificateLifetimeAction
Typed helper for the certificate_policy.lifetime_action block of azurerm_key_vault_certificate (derived from provider schema).
KeyVaultCertificatePolicy
Typed helper for the certificate_policy block of azurerm_key_vault_certificate (derived from provider schema).
KeyVaultCertificateSecretProperties
Typed helper for the certificate_policy.secret_properties block of azurerm_key_vault_certificate (derived from provider schema).
KeyVaultCertificateSubjectAlternativeNames
Typed helper for the certificate_policy.x509_certificate_properties.subject_alternative_names block of azurerm_key_vault_certificate (derived from provider schema).
KeyVaultCertificateTrigger
Typed helper for the certificate_policy.lifetime_action.trigger block of azurerm_key_vault_certificate (derived from provider schema).
KeyVaultCertificateX509CertificateProperties
Typed helper for the certificate_policy.x509_certificate_properties block of azurerm_key_vault_certificate (derived from provider schema).
KeyVaultKeyAutomatic
Typed helper for the rotation_policy.automatic block of azurerm_key_vault_key (derived from provider schema).
KeyVaultKeyParameter
At most one of curve, key_size on azurerm_key_vault_key: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
KeyVaultKeyParameterCurve
The KeyVaultKeyParameter.curve choice: sets curve.
KeyVaultKeyParameterKeySize
The KeyVaultKeyParameter.keySize choice: sets key_size.
KeyVaultKeyReleasePolicy
Typed helper for the release_policy block of azurerm_key_vault_key (derived from provider schema).
KeyVaultKeyRotationPolicy
Typed helper for the rotation_policy block of azurerm_key_vault_key (derived from provider schema).
KeyVaultManagedHardwareSecurityModuleKeyRotationPolicyTime
Exactly one of time_after_creation, time_before_expiry on azurerm_key_vault_managed_hardware_security_module_key_rotation_policy: the provider rejects none and more than one, so each variant sets one of them.
KeyVaultManagedHardwareSecurityModuleKeyRotationPolicyTimeAfterCreation
The KeyVaultManagedHardwareSecurityModuleKeyRotationPolicyTime.timeAfterCreation choice: sets time_after_creation.
KeyVaultManagedHardwareSecurityModuleKeyRotationPolicyTimeBeforeExpiry
The KeyVaultManagedHardwareSecurityModuleKeyRotationPolicyTime.timeBeforeExpiry choice: sets time_before_expiry.
KeyVaultManagedHardwareSecurityModuleNetworkAcls
Typed helper for the network_acls block of azurerm_key_vault_managed_hardware_security_module (derived from provider schema).
KeyVaultManagedHardwareSecurityModuleRoleDefinitionPermission
Typed helper for the permission block of azurerm_key_vault_managed_hardware_security_module_role_definition (derived from provider schema).
KeyVaultNetworkAcls
Typed helper for the network_acls block of azurerm_key_vault (derived from provider schema).
KeyVaultSecretValue
Exactly one of value, value_wo on azurerm_key_vault_secret: the provider rejects none and more than one, so each variant sets one of them.
KeyVaultSecretValueChoice
The KeyVaultSecretValue.value choice: sets value.
KeyVaultSecretValueWo
The KeyVaultSecretValue.valueWo choice: sets value_wo.
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, 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

DataKeyVaultAccessPolicyName
Data Key Vault Access Policy enum for name.
DataKeyVaultEncryptedValueAlgorithm
Data Key Vault Encrypted Value enum for algorithm.
DedicatedHardwareSecurityModuleSkuName
Dedicated Hardware Security Module Sku enum for sku_name.
DedicatedHardwareSecurityModuleStampId
Dedicated Hardware Security Module Stamp enum for stamp_id.
KeyVaultAccessPolicyCertificatePermissions
Key Vault Access Policy Certificate enum for certificate_permissions.
KeyVaultAccessPolicyKeyPermissions
Key Vault Access Policy Key enum for key_permissions.
KeyVaultAccessPolicySecretPermissions
Key Vault Access Policy Secret enum for secret_permissions.
KeyVaultAccessPolicyStoragePermissions
Key Vault Access Policy Storage enum for storage_permissions.
KeyVaultBypass
bypass — derived from the provider schema description.
KeyVaultCertificateIssuerProviderName
Key Vault Certificate Issuer Provider enum for provider_name.
KeyVaultCertificateKeyType
key_type — derived from the provider schema description.
KeyVaultDefaultAction
default_action — derived from the provider schema description.
KeyVaultKeyCurve
Key Vault Key enum for curve.
KeyVaultKeyOpts
Key Vault Key enum for key_opts.
KeyVaultKeyType
Key Vault Key enum for key_type.
KeyVaultManagedHardwareSecurityModuleBypass
bypass — derived from the provider schema description.
KeyVaultManagedHardwareSecurityModuleDefaultAction
default_action — derived from the provider schema description.
KeyVaultManagedHardwareSecurityModuleKeyCurve
Key Vault Managed Hardware Security Module Key enum for curve.
KeyVaultManagedHardwareSecurityModuleKeyOpts
Key Vault Managed Hardware Security Module Key enum for key_opts.
KeyVaultManagedHardwareSecurityModuleKeyType
Key Vault Managed Hardware Security Module Key enum for key_type.
KeyVaultManagedHardwareSecurityModuleRoleDefinitionDataActions
data_actions — derived from the provider schema description.
KeyVaultManagedHardwareSecurityModuleRoleDefinitionNotDataActions
not_data_actions — derived from the provider schema description.
KeyVaultManagedHardwareSecurityModuleSkuName
Key Vault Managed Hardware Security Module Sku enum for sku_name.
KeyVaultManagedStorageAccountKey
Key Vault Managed Storage Account enum for storage_account_key.
KeyVaultManagedStorageAccountSasTokenDefinitionSasType
Key Vault Managed Storage Account Sas Token Definition Sas enum for sas_type.
KeyVaultSkuName
Key Vault Sku enum for sku_name.
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.

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.