monitoring library
Cloud Monitoring: alert policies, notification channels, uptime probes, dashboards, custom metric descriptors, and SLO service objects.
Classes
-
AppConstant<
T> -
A value the Stack hands to application code as a
static constin 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 constmembers 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. - DartDefineOutput
-
An
outputwhose value is the client build's--dart-definefile, registered withStack.addDartDefineOutput. - Data
-
Base of every user-instantiable Terraform
datablock. - DataGoogleMonitoringAppEngineService
-
Factory wrapper for
google_monitoring_app_engine_service. - DataGoogleMonitoringClusterIstioService
-
Factory wrapper for
google_monitoring_cluster_istio_service. - DataGoogleMonitoringIstioCanonicalService
-
Factory wrapper for
google_monitoring_istio_canonical_service. - DataGoogleMonitoringMeshIstioService
-
Factory wrapper for
google_monitoring_mesh_istio_service. - DataGoogleMonitoringNotificationChannel
-
Factory wrapper for
google_monitoring_notification_channel. - DataGoogleMonitoringUptimeCheckIps
-
Factory wrapper for
google_monitoring_uptime_check_ips. -
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. - GoogleMonitoringAlertPolicy
-
Factory wrapper for
google_monitoring_alert_policy. - GoogleMonitoringCustomService
-
Factory wrapper for
google_monitoring_custom_service. - GoogleMonitoringDashboard
-
Factory wrapper for
google_monitoring_dashboard. - GoogleMonitoringGroup
-
Factory wrapper for
google_monitoring_group. - GoogleMonitoringMetricDescriptor
-
Factory wrapper for
google_monitoring_metric_descriptor. - GoogleMonitoringMonitoredProject
-
Factory wrapper for
google_monitoring_monitored_project. - GoogleMonitoringNotificationChannel
-
Factory wrapper for
google_monitoring_notification_channel. - GoogleMonitoringService
-
Factory wrapper for
google_monitoring_service. - GoogleMonitoringSlo
-
Factory wrapper for
google_monitoring_slo. - GoogleMonitoringSnooze
-
Factory wrapper for
google_monitoring_snooze. - GoogleMonitoringUptimeCheckConfig
-
Factory wrapper for
google_monitoring_uptime_check_config. - IgnoreAllChanges
- IgnoreChanges.all.
- IgnoreAttributes
- IgnoreChanges.of.
- IgnoreChanges
-
What
ignore_changescovers: every attribute, or the listed ones. - InvalidDartDefineOutput
-
An output of
Stack.addDartDefineOutputthat 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
lifecycleblock Terraform rejects: a data source (or one of its attributes) inreplaceTriggeredBy,allinside IgnoreChanges.of, or a condition with an empty error message. - InvalidMoveTarget
-
A
movedblock whosetonames no resource of the Stack. - InvalidTimeout
-
A negative
timeoutsduration. - LifecycleCondition
-
A
preconditionorpostconditionblock: 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 (
googleforgoogle_pubsub_topic), the one itsprovidermeta-argument names, or one a module call passes on. - ModuleCall
-
A
module "<localName>" { ... }call as a Dart value. - MonitoringAlertPolicyAggregations
-
Typed helper for the
conditions.condition_absent.aggregationsblock ofgoogle_monitoring_alert_policy(derived from provider schema). Shared by every block of this shape in the resource. - MonitoringAlertPolicyAlertStrategy
-
Typed helper for the
alert_strategyblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyBooleanTest
-
Typed helper for the
conditions.condition_sql.boolean_testblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyBooleanTestChoice
-
The MonitoringAlertPolicyTest.booleanTest choice: sets
boolean_test. - MonitoringAlertPolicyConditionAbsent
-
Typed helper for the
conditions.condition_absentblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyConditionMatchedLog
-
Typed helper for the
conditions.condition_matched_logblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyConditionMonitoringQueryLanguage
-
Typed helper for the
conditions.condition_monitoring_query_languageblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyConditionPrometheusQueryLanguage
-
Typed helper for the
conditions.condition_prometheus_query_languageblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyConditions
-
Typed helper for the
conditionsblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyConditionSql
-
Typed helper for the
conditions.condition_sqlblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyConditionThreshold
-
Typed helper for the
conditions.condition_thresholdblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyDaily
-
Typed helper for the
conditions.condition_sql.dailyblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyDenominatorAggregations
-
Typed helper for the
conditions.condition_threshold.denominator_aggregationsblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyDocumentation
-
Typed helper for the
documentationblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyExecutionTime
-
Typed helper for the
conditions.condition_sql.daily.execution_timeblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyForecastOptions
-
Typed helper for the
conditions.condition_threshold.forecast_optionsblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyHourly
-
Typed helper for the
conditions.condition_sql.hourlyblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyLinks
-
Typed helper for the
documentation.linksblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyMinutes
-
Typed helper for the
conditions.condition_sql.minutesblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyNotificationChannelStrategy
-
Typed helper for the
alert_strategy.notification_channel_strategyblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyNotificationRateLimit
-
Typed helper for the
alert_strategy.notification_rate_limitblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyRowCountTest
-
Typed helper for the
conditions.condition_sql.row_count_testblock ofgoogle_monitoring_alert_policy(derived from provider schema). - MonitoringAlertPolicyRowCountTestChoice
-
The MonitoringAlertPolicyTest.rowCountTest choice: sets
row_count_test. - MonitoringAlertPolicySchedule
-
Exactly one of
minutes,hourly,dailyon theconditions.condition_sqlblock ofgoogle_monitoring_alert_policy: the provider rejects none and more than one, so each variant sets one of them. - MonitoringAlertPolicyScheduleDaily
-
The MonitoringAlertPolicySchedule.daily choice: sets
daily. - MonitoringAlertPolicyScheduleHourly
-
The MonitoringAlertPolicySchedule.hourly choice: sets
hourly. - MonitoringAlertPolicyScheduleMinutes
-
The MonitoringAlertPolicySchedule.minutes choice: sets
minutes. - MonitoringAlertPolicyTest
-
Exactly one of
row_count_test,boolean_teston theconditions.condition_sqlblock ofgoogle_monitoring_alert_policy: the provider rejects none and more than one, so each variant sets one of them. - MonitoringAlertPolicyTrigger
-
Typed helper for the
conditions.condition_absent.triggerblock ofgoogle_monitoring_alert_policy(derived from provider schema). Shared by every block of this shape in the resource. - MonitoringCustomServiceTelemetry
-
Typed helper for the
telemetryblock ofgoogle_monitoring_custom_service(derived from provider schema). - MonitoringMetricDescriptorLabel
-
One entry in
labels— describes a label key that values of this metric carry. The label-level valueType is narrower than the descriptor's top-level MonitoringValueType (noDOUBLE/DISTRIBUTION). - MonitoringMetricDescriptorMetadata
-
metadatablock (max=1) — sampling / ingest-delay hints for the metric. Both fields are Duration-format strings (e.g.'60s','300s'). - MonitoringNotificationChannelCredential
-
Exactly one of
auth_token,auth_token_wo,password,password_wo,service_key,service_key_woon thesensitive_labelsblock ofgoogle_monitoring_notification_channel: the provider rejects none and more than one, so each variant sets one of them. - MonitoringNotificationChannelCredentialAuthToken
-
The MonitoringNotificationChannelCredential.authToken choice: sets
auth_token. - MonitoringNotificationChannelCredentialAuthTokenWo
-
The MonitoringNotificationChannelCredential.authTokenWo choice: sets
auth_token_wo. - MonitoringNotificationChannelCredentialPassword
-
The MonitoringNotificationChannelCredential.password choice: sets
password. - MonitoringNotificationChannelCredentialPasswordWo
-
The MonitoringNotificationChannelCredential.passwordWo choice: sets
password_wo. - MonitoringNotificationChannelCredentialServiceKey
-
The MonitoringNotificationChannelCredential.serviceKey choice: sets
service_key. - MonitoringNotificationChannelCredentialServiceKeyWo
-
The MonitoringNotificationChannelCredential.serviceKeyWo choice: sets
service_key_wo. - MonitoringNotificationChannelSensitiveLabels
-
Typed helper for the
sensitive_labelsblock ofgoogle_monitoring_notification_channel(derived from provider schema). - MonitoringServiceBasicService
-
basic_serviceblock (max=1) — a well-known service type defined by its serviceType (e.g.'APP_ENGINE','CLOUD_ENDPOINTS','CLUSTER_ISTIO','MESH_ISTIO') and a set of serviceLabels that pin the variant to a specific service instance. See the SLO monitoring docs for the valid(serviceType, serviceLabels)combinations. - MonitoringServiceTelemetry
-
Read-only view of the server-populated
telemetryblock. Cloud Monitoring derives resourceName from the chosen service-type variant; consumers may read it via GoogleMonitoringService.telemetry. - MonitoringSloAvailability
-
Typed helper for the
basic_sli.availabilityblock ofgoogle_monitoring_slo(derived from provider schema). Shared by every block of this shape in the resource. - MonitoringSloBasicSli
-
Typed helper for the
basic_sliblock ofgoogle_monitoring_slo(derived from provider schema). - MonitoringSloBasicSliChoice
-
The MonitoringSloSli.basicSli choice: sets
basic_sli. - MonitoringSloBasicSliPerformance
-
Typed helper for the
windows_based_sli.good_total_ratio_threshold.basic_sli_performanceblock ofgoogle_monitoring_slo(derived from provider schema). - MonitoringSloBasicSliPerformanceObjective
-
Exactly one of
latency,availabilityon thewindows_based_sli.good_total_ratio_threshold.basic_sli_performanceblock ofgoogle_monitoring_slo: the provider rejects none and more than one, so each variant sets one of them. - MonitoringSloBasicSliPerformanceObjectiveAvailability
-
The MonitoringSloBasicSliPerformanceObjective.availability choice: sets
availability. - MonitoringSloBasicSliPerformanceObjectiveLatency
-
The MonitoringSloBasicSliPerformanceObjective.latency choice: sets
latency. - MonitoringSloCalendarPeriodChoice
-
The MonitoringSloPeriod.calendarPeriod choice: sets
calendar_period. - MonitoringSloCriterion
-
Exactly one of
good_bad_metric_filter,good_total_ratio_threshold,metric_mean_in_range,metric_sum_in_rangeon thewindows_based_sliblock ofgoogle_monitoring_slo: the provider rejects none and more than one, so each variant sets one of them. - MonitoringSloCriterionGoodBadMetricFilter
-
The MonitoringSloCriterion.goodBadMetricFilter choice: sets
good_bad_metric_filter. - MonitoringSloCriterionGoodTotalRatioThreshold
-
The MonitoringSloCriterion.goodTotalRatioThreshold choice: sets
good_total_ratio_threshold. - MonitoringSloCriterionMetricMeanInRange
-
The MonitoringSloCriterion.metricMeanInRange choice: sets
metric_mean_in_range. - MonitoringSloCriterionMetricSumInRange
-
The MonitoringSloCriterion.metricSumInRange choice: sets
metric_sum_in_range. - MonitoringSloDistributionCut
-
Typed helper for the
request_based_sli.distribution_cutblock ofgoogle_monitoring_slo(derived from provider schema). Shared by every block of this shape in the resource. - MonitoringSloGoodTotalRatio
-
Typed helper for the
request_based_sli.good_total_ratioblock ofgoogle_monitoring_slo(derived from provider schema). Shared by every block of this shape in the resource. - MonitoringSloGoodTotalRatioThreshold
-
Typed helper for the
windows_based_sli.good_total_ratio_thresholdblock ofgoogle_monitoring_slo(derived from provider schema). - MonitoringSloLatency
-
Typed helper for the
basic_sli.latencyblock ofgoogle_monitoring_slo(derived from provider schema). Shared by every block of this shape in the resource. - MonitoringSloMeasure
-
Exactly one of
performance,basic_sli_performanceon thewindows_based_sli.good_total_ratio_thresholdblock ofgoogle_monitoring_slo: the provider rejects none and more than one, so each variant sets one of them. - MonitoringSloMeasureBasicSliPerformance
-
The MonitoringSloMeasure.basicSliPerformance choice: sets
basic_sli_performance. - MonitoringSloMeasurePerformance
-
The MonitoringSloMeasure.performance choice: sets
performance. - MonitoringSloMetricMeanInRange
-
Typed helper for the
windows_based_sli.metric_mean_in_rangeblock ofgoogle_monitoring_slo(derived from provider schema). - MonitoringSloMetricSumInRange
-
Typed helper for the
windows_based_sli.metric_sum_in_rangeblock ofgoogle_monitoring_slo(derived from provider schema). - MonitoringSloObjective
-
Exactly one of
latency,availabilityon thebasic_sliblock ofgoogle_monitoring_slo: the provider rejects none and more than one, so each variant sets one of them. - MonitoringSloObjectiveAvailability
-
The MonitoringSloObjective.availability choice: sets
availability. - MonitoringSloObjectiveLatency
-
The MonitoringSloObjective.latency choice: sets
latency. - MonitoringSloPerformance
-
Exactly one of
good_total_ratio,distribution_cuton thewindows_based_sli.good_total_ratio_threshold.performanceblock ofgoogle_monitoring_slo: the provider rejects none and more than one, so each variant sets one of them. - MonitoringSloPerformanceDistributionCut
-
The MonitoringSloPerformance.distributionCut choice: sets
distribution_cut. - MonitoringSloPerformanceGoodTotalRatio
-
The MonitoringSloPerformance.goodTotalRatio choice: sets
good_total_ratio. - MonitoringSloPeriod
-
Exactly one of
rolling_period_days,calendar_periodongoogle_monitoring_slo: the provider rejects none and more than one, so each variant sets one of them. - MonitoringSloPeriodRollingPeriodDays
-
The MonitoringSloPeriod.rollingPeriodDays choice: sets
rolling_period_days. - MonitoringSloRange
-
Typed helper for the
request_based_sli.distribution_cut.rangeblock ofgoogle_monitoring_slo(derived from provider schema). Shared by every block of this shape in the resource. - MonitoringSloRequestBasedSli
-
Exactly one of
good_total_ratio,distribution_cuton therequest_based_sliblock ofgoogle_monitoring_slo: the provider rejects none and more than one, so each variant sets one of them. - MonitoringSloRequestBasedSliChoice
-
The MonitoringSloSli.requestBasedSli choice: sets
request_based_sli. - MonitoringSloRequestBasedSliDistributionCut
-
The MonitoringSloRequestBasedSli.distributionCut choice: sets
distribution_cut. - MonitoringSloRequestBasedSliGoodTotalRatio
-
The MonitoringSloRequestBasedSli.goodTotalRatio choice: sets
good_total_ratio. - MonitoringSloSli
-
Exactly one of
basic_sli,request_based_sli,windows_based_sliongoogle_monitoring_slo: the provider rejects none and more than one, so each variant sets one of them. - MonitoringSloWindowsBasedSli
-
Typed helper for the
windows_based_sliblock ofgoogle_monitoring_slo(derived from provider schema). - MonitoringSloWindowsBasedSliChoice
-
The MonitoringSloSli.windowsBasedSli choice: sets
windows_based_sli. - MonitoringSnoozeCriteria
-
Typed helper for the
criteriablock ofgoogle_monitoring_snooze(derived from provider schema). - MonitoringSnoozeInterval
-
Typed helper for the
intervalblock ofgoogle_monitoring_snooze(derived from provider schema). - MonitoringUptimeCheckConfigAcceptedResponseStatusCodes
-
Typed helper for the
http_check.accepted_response_status_codesblock ofgoogle_monitoring_uptime_check_config(derived from provider schema). - MonitoringUptimeCheckConfigAuthInfo
-
Typed helper for the
http_check.auth_infoblock ofgoogle_monitoring_uptime_check_config(derived from provider schema). - MonitoringUptimeCheckConfigCloudFunctionV2
-
Typed helper for the
synthetic_monitor.cloud_function_v2block ofgoogle_monitoring_uptime_check_config(derived from provider schema). - MonitoringUptimeCheckConfigContentMatchers
-
Typed helper for the
content_matchersblock ofgoogle_monitoring_uptime_check_config(derived from provider schema). - MonitoringUptimeCheckConfigHttpCheck
-
Typed helper for the
http_checkblock ofgoogle_monitoring_uptime_check_config(derived from provider schema). - MonitoringUptimeCheckConfigJsonPathMatcher
-
Typed helper for the
content_matchers.json_path_matcherblock ofgoogle_monitoring_uptime_check_config(derived from provider schema). - MonitoringUptimeCheckConfigMonitoredResource
-
Typed helper for the
monitored_resourceblock ofgoogle_monitoring_uptime_check_config(derived from provider schema). - MonitoringUptimeCheckConfigPassword
-
Exactly one of
password,password_woon thehttp_check.auth_infoblock ofgoogle_monitoring_uptime_check_config: the provider rejects none and more than one, so each variant sets one of them. - MonitoringUptimeCheckConfigPasswordChoice
-
The MonitoringUptimeCheckConfigPassword.password choice: sets
password. - MonitoringUptimeCheckConfigPasswordWo
-
The MonitoringUptimeCheckConfigPassword.passwordWo choice: sets
password_wo. - MonitoringUptimeCheckConfigPingConfig
-
Typed helper for the
http_check.ping_configblock ofgoogle_monitoring_uptime_check_config(derived from provider schema). Shared by every block of this shape in the resource. - MonitoringUptimeCheckConfigResourceGroup
-
Typed helper for the
resource_groupblock ofgoogle_monitoring_uptime_check_config(derived from provider schema). - MonitoringUptimeCheckConfigServiceAgentAuthentication
-
Typed helper for the
http_check.service_agent_authenticationblock ofgoogle_monitoring_uptime_check_config(derived from provider schema). - MonitoringUptimeCheckConfigSyntheticMonitor
-
Typed helper for the
synthetic_monitorblock ofgoogle_monitoring_uptime_check_config(derived from provider schema). - MonitoringUptimeCheckConfigTarget
-
Exactly one of
monitored_resource,resource_group,synthetic_monitorongoogle_monitoring_uptime_check_config: the provider rejects none and more than one, so each variant sets one of them. - MonitoringUptimeCheckConfigTargetMonitoredResource
-
The MonitoringUptimeCheckConfigTarget.monitoredResource choice: sets
monitored_resource. - MonitoringUptimeCheckConfigTargetResourceGroup
-
The MonitoringUptimeCheckConfigTarget.resourceGroup choice: sets
resource_group. - MonitoringUptimeCheckConfigTargetSyntheticMonitor
-
The MonitoringUptimeCheckConfigTarget.syntheticMonitor choice: sets
synthetic_monitor. - MonitoringUptimeCheckConfigTcpCheck
-
Typed helper for the
tcp_checkblock ofgoogle_monitoring_uptime_check_config(derived from provider schema). - 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.replaceTriggeredBylists: a resource of the Stack or an attribute getter of one.Resourceand TfRef implement it; synth reports a data source or a data-source attribute as anInvalidLifecycle. - 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, andLocalBackend; anything else implements this interface in the caller. TheStackonly stores the value and exposes a discriminator for synth'sterraform { backend ... }emitter. - StackProvider
-
Coordination interface between
Stack(in this package) and concrete providers (e.g.GoogleProviderinterradart_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(...)ormap(...). - 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 withStack.addOutput. - TfPrimitiveType
-
string,number,boolorany. -
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.variableorvar.<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.refwhose 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
resourceblock or adatablock in Terraform JSON.
Extension Types
- AlertCombiner
-
Combiner for
google_monitoring_alert_policy.combiner— how the conditions list reduces to a single incident-open decision. - AlertSeverity
-
Severity for
google_monitoring_alert_policy.severity. Surfaces on the Incident detail page and in notifications. - Aligner
-
Per-series alignment function for
aggregations.per_series_aligner. - Comparison
-
Comparison operator for
condition_threshold.comparisonandcondition_sql.row_count_test.comparison. - EvaluationMissingData
- Behavior when a threshold / MQL condition stops receiving data.
- MonitoringAlertPolicyNotificationPrompts
-
notification_prompts— derived from the provider schema description. - MonitoringMetricKind
-
metric_kind— whether the metric records instantaneous values, deltas, or running totals. Not every(metricKind, valueType)combination is supported by the Cloud Monitoring API. - MonitoringMetricLabelValueType
-
labels[].value_type— the data type of a label attached to this metric. The label-level value space is narrower than the descriptor's (noDOUBLE/DISTRIBUTION). Defaults to MonitoringMetricLabelValueType.string when omitted. - MonitoringMetricLaunchStage
-
launch_stage— release-management stage of this metric definition. Defaults to MonitoringMetricLaunchStage.ga / unset for stable metrics. - MonitoringSloCalendarPeriod
- MonitoringUptimeCheckCheckerType
-
Checker pool selector for
google_monitoring_uptime_check_config.checker_type. - MonitoringUptimeCheckContentType
-
Content-type for
http_check.content_type(the standardContent-Typeheader sent on probe requests). - MonitoringUptimeCheckHttpMethod
-
HTTP method for
http_check.request_method. - MonitoringUptimeCheckJsonMatcher
-
JSONPath match mode for
content_matchers[].json_path_matcher.json_matcher. Defaults to exactMatch on the GCP API. - MonitoringUptimeCheckMatcher
-
Match mode for
content_matchers[].matcher. Defaults to containsString on the GCP API. - MonitoringUptimeCheckRegion
-
Region selector for
google_monitoring_uptime_check_config.selected_regions. - MonitoringUptimeCheckResourceType
-
Member-resource type for
resource_group.resource_type. - MonitoringUptimeCheckServiceAgentAuthType
-
Service Agent authentication mode for
http_check.service_agent_authentication.type. - MonitoringUptimeCheckStatusClass
-
HTTP status class for
http_check.accepted_response_status_codes[].status_class. - MonitoringValueType
-
value_type— the value kind recorded per data point. Use MonitoringValueType.distribution together with the histogram-bucket configuration on the metric's time series; the schema does not includeMONEYor aVALUE_TYPE_UNSPECIFIEDsentinel. - NotificationPrompt
-
Notification prompt for
alert_strategy.notification_prompts— controls when notifications fire across the incident lifecycle. - OutputEnvironment
-
The environment
Stack.outputEnvironmentreturns: each variable and its value, in registration order. - Reducer
-
Cross-series reducer for
aggregations.cross_series_reducer. - 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
terradartcommand 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
envand 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
ModuleCallregistered twice under one name. - DuplicateResourceError
-
Thrown by
Stack.addwhen an entry with the same(kind, terraformType, localName)triple is registered twice. - SynthException
-
Thrown by
Stack.synth()andStack.writeTo()when the Stack has one or more SynthIssues. Nothing is written.