sentinel library

Azure Resource Manager sentinel 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.
AzurermSentinelAlertRuleAnomalyBuiltIn
Factory wrapper for azurerm_sentinel_alert_rule_anomaly_built_in.
AzurermSentinelAlertRuleAnomalyDuplicate
Factory wrapper for azurerm_sentinel_alert_rule_anomaly_duplicate.
AzurermSentinelAlertRuleFusion
Factory wrapper for azurerm_sentinel_alert_rule_fusion.
AzurermSentinelAlertRuleMachineLearningBehaviorAnalytics
Factory wrapper for azurerm_sentinel_alert_rule_machine_learning_behavior_analytics.
AzurermSentinelAlertRuleMsSecurityIncident
Factory wrapper for azurerm_sentinel_alert_rule_ms_security_incident.
AzurermSentinelAlertRuleNrt
Factory wrapper for azurerm_sentinel_alert_rule_nrt.
AzurermSentinelAlertRuleScheduled
Factory wrapper for azurerm_sentinel_alert_rule_scheduled.
AzurermSentinelAlertRuleThreatIntelligence
Factory wrapper for azurerm_sentinel_alert_rule_threat_intelligence.
AzurermSentinelAutomationRule
Factory wrapper for azurerm_sentinel_automation_rule.
AzurermSentinelDataConnectorAwsCloudTrail
Factory wrapper for azurerm_sentinel_data_connector_aws_cloud_trail.
AzurermSentinelDataConnectorAwsS3
Factory wrapper for azurerm_sentinel_data_connector_aws_s3.
AzurermSentinelDataConnectorAzureActiveDirectory
Factory wrapper for azurerm_sentinel_data_connector_azure_active_directory.
AzurermSentinelDataConnectorAzureAdvancedThreatProtection
Factory wrapper for azurerm_sentinel_data_connector_azure_advanced_threat_protection.
AzurermSentinelDataConnectorAzureSecurityCenter
Factory wrapper for azurerm_sentinel_data_connector_azure_security_center.
AzurermSentinelDataConnectorDynamics365
Factory wrapper for azurerm_sentinel_data_connector_dynamics_365.
AzurermSentinelDataConnectorIot
Factory wrapper for azurerm_sentinel_data_connector_iot.
AzurermSentinelDataConnectorMicrosoftCloudAppSecurity
Factory wrapper for azurerm_sentinel_data_connector_microsoft_cloud_app_security.
AzurermSentinelDataConnectorMicrosoftDefenderAdvancedThreatProtection
Factory wrapper for azurerm_sentinel_data_connector_microsoft_defender_advanced_threat_protection.
AzurermSentinelDataConnectorMicrosoftThreatIntelligence
Factory wrapper for azurerm_sentinel_data_connector_microsoft_threat_intelligence.
AzurermSentinelDataConnectorMicrosoftThreatProtection
Factory wrapper for azurerm_sentinel_data_connector_microsoft_threat_protection.
AzurermSentinelDataConnectorOffice365
Factory wrapper for azurerm_sentinel_data_connector_office_365.
AzurermSentinelDataConnectorOffice365Project
Factory wrapper for azurerm_sentinel_data_connector_office_365_project.
AzurermSentinelDataConnectorOfficeAtp
Factory wrapper for azurerm_sentinel_data_connector_office_atp.
AzurermSentinelDataConnectorOfficeIrm
Factory wrapper for azurerm_sentinel_data_connector_office_irm.
AzurermSentinelDataConnectorOfficePowerBi
Factory wrapper for azurerm_sentinel_data_connector_office_power_bi.
AzurermSentinelDataConnectorThreatIntelligence
Factory wrapper for azurerm_sentinel_data_connector_threat_intelligence.
AzurermSentinelDataConnectorThreatIntelligenceTaxii
Factory wrapper for azurerm_sentinel_data_connector_threat_intelligence_taxii.
AzurermSentinelLogAnalyticsWorkspaceOnboarding
Factory wrapper for azurerm_sentinel_log_analytics_workspace_onboarding.
AzurermSentinelMetadata
Factory wrapper for azurerm_sentinel_metadata.
AzurermSentinelThreatIntelligenceIndicator
Factory wrapper for azurerm_sentinel_threat_intelligence_indicator.
AzurermSentinelWatchlist
Factory wrapper for azurerm_sentinel_watchlist.
AzurermSentinelWatchlistItem
Factory wrapper for azurerm_sentinel_watchlist_item.
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.
DataAzurermSentinelAlertRule
Factory wrapper for azurerm_sentinel_alert_rule.
DataAzurermSentinelAlertRuleAnomaly
Factory wrapper for azurerm_sentinel_alert_rule_anomaly.
DataAzurermSentinelAlertRuleTemplate
Factory wrapper for azurerm_sentinel_alert_rule_template.
DataRef<T>
Public for sealed pattern matching, but constructor is private — only TfRef.data() may construct instances.
DataSentinelAlertRuleAnomalyIdentifier
Exactly one of display_name, name on data.azurerm_sentinel_alert_rule_anomaly: the provider rejects none and more than one, so each variant sets one of them.
DataSentinelAlertRuleAnomalyIdentifierDisplayName
The DataSentinelAlertRuleAnomalyIdentifier.displayName choice: sets display_name.
DataSentinelAlertRuleAnomalyIdentifierName
The DataSentinelAlertRuleAnomalyIdentifier.name choice: sets name.
DataSentinelAlertRuleTemplateIdentifier
Exactly one of display_name, name on data.azurerm_sentinel_alert_rule_template: the provider rejects none and more than one, so each variant sets one of them.
DataSentinelAlertRuleTemplateIdentifierDisplayName
The DataSentinelAlertRuleTemplateIdentifier.displayName choice: sets display_name.
DataSentinelAlertRuleTemplateIdentifierName
The DataSentinelAlertRuleTemplateIdentifier.name choice: sets name.
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.
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.
SentinelAlertRuleAnomalyBuiltInIdentifier
Exactly one of display_name, name on azurerm_sentinel_alert_rule_anomaly_built_in: the provider rejects none and more than one, so each variant sets one of them.
SentinelAlertRuleAnomalyBuiltInIdentifierDisplayName
The SentinelAlertRuleAnomalyBuiltInIdentifier.displayName choice: sets display_name.
SentinelAlertRuleAnomalyBuiltInIdentifierName
The SentinelAlertRuleAnomalyBuiltInIdentifier.name choice: sets name.
SentinelAlertRuleAnomalyDuplicateMultiSelectObservation
Typed helper for the multi_select_observation block of azurerm_sentinel_alert_rule_anomaly_duplicate (derived from provider schema).
SentinelAlertRuleAnomalyDuplicatePrioritizedExcludeObservation
Typed helper for the prioritized_exclude_observation block of azurerm_sentinel_alert_rule_anomaly_duplicate (derived from provider schema).
SentinelAlertRuleAnomalyDuplicateSingleSelectObservation
Typed helper for the single_select_observation block of azurerm_sentinel_alert_rule_anomaly_duplicate (derived from provider schema).
SentinelAlertRuleAnomalyDuplicateThresholdObservation
Typed helper for the threshold_observation block of azurerm_sentinel_alert_rule_anomaly_duplicate (derived from provider schema).
SentinelAlertRuleFusionSource
Typed helper for the source block of azurerm_sentinel_alert_rule_fusion (derived from provider schema).
SentinelAlertRuleFusionSubType
Typed helper for the source.sub_type block of azurerm_sentinel_alert_rule_fusion (derived from provider schema).
SentinelAlertRuleNrtAlertDetailsOverride
Typed helper for the alert_details_override block of azurerm_sentinel_alert_rule_nrt (derived from provider schema).
SentinelAlertRuleNrtDynamicProperty
Typed helper for the alert_details_override.dynamic_property block of azurerm_sentinel_alert_rule_nrt (derived from provider schema).
SentinelAlertRuleNrtEntityMapping
Typed helper for the entity_mapping block of azurerm_sentinel_alert_rule_nrt (derived from provider schema).
SentinelAlertRuleNrtEventGrouping
Typed helper for the event_grouping block of azurerm_sentinel_alert_rule_nrt (derived from provider schema).
SentinelAlertRuleNrtFieldMapping
Typed helper for the entity_mapping.field_mapping block of azurerm_sentinel_alert_rule_nrt (derived from provider schema).
SentinelAlertRuleNrtGrouping
Typed helper for the incident.grouping block of azurerm_sentinel_alert_rule_nrt (derived from provider schema).
SentinelAlertRuleNrtIncident
Typed helper for the incident block of azurerm_sentinel_alert_rule_nrt (derived from provider schema).
SentinelAlertRuleNrtSentinelEntityMapping
Typed helper for the sentinel_entity_mapping block of azurerm_sentinel_alert_rule_nrt (derived from provider schema).
SentinelAlertRuleScheduledAlertDetailsOverride
Typed helper for the alert_details_override block of azurerm_sentinel_alert_rule_scheduled (derived from provider schema).
SentinelAlertRuleScheduledDynamicProperty
Typed helper for the alert_details_override.dynamic_property block of azurerm_sentinel_alert_rule_scheduled (derived from provider schema).
SentinelAlertRuleScheduledEntityMapping
Typed helper for the entity_mapping block of azurerm_sentinel_alert_rule_scheduled (derived from provider schema).
SentinelAlertRuleScheduledEventGrouping
Typed helper for the event_grouping block of azurerm_sentinel_alert_rule_scheduled (derived from provider schema).
SentinelAlertRuleScheduledFieldMapping
Typed helper for the entity_mapping.field_mapping block of azurerm_sentinel_alert_rule_scheduled (derived from provider schema).
SentinelAlertRuleScheduledGrouping
Typed helper for the incident.grouping block of azurerm_sentinel_alert_rule_scheduled (derived from provider schema).
SentinelAlertRuleScheduledIncident
Typed helper for the incident block of azurerm_sentinel_alert_rule_scheduled (derived from provider schema).
SentinelAlertRuleScheduledSentinelEntityMapping
Typed helper for the sentinel_entity_mapping block of azurerm_sentinel_alert_rule_scheduled (derived from provider schema).
SentinelAutomationRuleActionIncident
Typed helper for the action_incident block of azurerm_sentinel_automation_rule (derived from provider schema).
SentinelAutomationRuleActionIncidentTask
Typed helper for the action_incident_task block of azurerm_sentinel_automation_rule (derived from provider schema).
SentinelAutomationRuleActionPlaybook
Typed helper for the action_playbook block of azurerm_sentinel_automation_rule (derived from provider schema).
SentinelMetadataAuthor
Typed helper for the author block of azurerm_sentinel_metadata (derived from provider schema).
SentinelMetadataCategory
Typed helper for the category block of azurerm_sentinel_metadata (derived from provider schema).
SentinelMetadataSource
Typed helper for the source block of azurerm_sentinel_metadata (derived from provider schema).
SentinelMetadataSupport
Typed helper for the support block of azurerm_sentinel_metadata (derived from provider schema).
SentinelThreatIntelligenceIndicatorExternalReference
Typed helper for the external_reference block of azurerm_sentinel_threat_intelligence_indicator (derived from provider schema).
SentinelThreatIntelligenceIndicatorGranularMarking
Typed helper for the granular_marking block of azurerm_sentinel_threat_intelligence_indicator (derived from provider schema).
SentinelThreatIntelligenceIndicatorKillChainPhase
Typed helper for the kill_chain_phase block of azurerm_sentinel_threat_intelligence_indicator (derived from provider schema).
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, ...).
SentinelAlertRuleAnomalyBuiltInMode
Sentinel Alert Rule Anomaly Built In enum for mode.
SentinelAlertRuleAnomalyDuplicateMode
Sentinel Alert Rule Anomaly Duplicate enum for mode.
SentinelAlertRuleFusionSeveritiesAllowed
severities_allowed — derived from the provider schema description.
SentinelAlertRuleMsSecurityIncidentProductFilter
Sentinel Alert Rule Ms Security Incident Product enum for product_filter.
SentinelAlertRuleMsSecurityIncidentSeverityFilter
Sentinel Alert Rule Ms Security Incident Severity enum for severity_filter.
SentinelAlertRuleNrtAggregationMethod
aggregation_method — derived from the provider schema description.
SentinelAlertRuleNrtByAlertDetails
by_alert_details — derived from the provider schema description.
SentinelAlertRuleNrtByEntities
by_entities — derived from the provider schema description.
SentinelAlertRuleNrtDynamicPropertyName
name — derived from the provider schema description.
SentinelAlertRuleNrtEntityMatchingMethod
entity_matching_method — derived from the provider schema description.
SentinelAlertRuleNrtEntityType
entity_type — derived from the provider schema description.
SentinelAlertRuleNrtSeverity
Sentinel Alert Rule Nrt enum for severity.
SentinelAlertRuleNrtTactics
Sentinel Alert Rule Nrt enum for tactics.
SentinelAlertRuleScheduledAggregationMethod
aggregation_method — derived from the provider schema description.
SentinelAlertRuleScheduledByAlertDetails
by_alert_details — derived from the provider schema description.
SentinelAlertRuleScheduledByEntities
by_entities — derived from the provider schema description.
SentinelAlertRuleScheduledDynamicPropertyName
name — derived from the provider schema description.
SentinelAlertRuleScheduledEntityMatchingMethod
entity_matching_method — derived from the provider schema description.
SentinelAlertRuleScheduledEntityType
entity_type — derived from the provider schema description.
SentinelAlertRuleScheduledSeverity
Sentinel Alert Rule Scheduled enum for severity.
SentinelAlertRuleScheduledTactics
Sentinel Alert Rule Scheduled enum for tactics.
SentinelAlertRuleScheduledTriggerOperator
Sentinel Alert Rule Scheduled Trigger enum for trigger_operator.
SentinelDataConnectorThreatIntelligenceTaxiiPollingFrequency
Sentinel Data Connector Threat Intelligence Taxii Polling enum for polling_frequency.
SentinelMetadataKind
Sentinel Metadata enum for kind.
SentinelMetadataSourceKind
kind — derived from the provider schema description.
SentinelMetadataThreatAnalysisTactics
Sentinel Metadata Threat Analysis enum for threat_analysis_tactics.
SentinelMetadataTier
tier — derived from the provider schema description.
SentinelThreatIntelligenceIndicatorPatternType
Sentinel Threat Intelligence Indicator Pattern enum for pattern_type.

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.