GoogleDataprocWorkflowTemplate class final

Factory wrapper for google_dataproc_workflow_template.

Dataproc workflow template — reusable DAG metadata (placement + job steps). Creating a template does not instantiate a cluster or start jobs; instantiate later via gcloud dataproc workflow-templates instantiate (or the API).

Prefer a thin smoke stack: location us-central1, placement.managedCluster with clusterName + GCE zone only (no live cluster), one jobs Spark step, and deletionPolicy DELETE. Do not pair this factory with GoogleDataprocCluster, GoogleDataprocJob, or GoogleDataprocBatch.

Enable dataproc.googleapis.com via GoogleProjectService before apply.

Example:

GoogleDataprocWorkflowTemplate(
  'sparkpi',
  name: TfArg.literal('terradart-wf'),
  location: TfArg.literal('us-central1'),
  placement: DataprocWorkflowTemplatePlacement(
    managedCluster: .new(
      clusterName: TfArg.literal('terradart-wf-cluster'),
      config: .new(
        gceClusterConfig: .new(
          zone: TfArg.literal('us-central1-a'),
        ),
      ),
    ),
  ),
  jobs: [
    DataprocWorkflowTemplateJobs(
      stepId: TfArg.literal('sparkpi'),
      sparkJob: .new(
        mainClass: TfArg.literal('org.apache.spark.examples.SparkPi'),
      ),
    ),
  ],
  deletionPolicy: TfArg.literal('DELETE'),
);

Inheritance

Object
Resource
GoogleDataprocWorkflowTemplate

Constructors

GoogleDataprocWorkflowTemplate(String localName, {required TfArg<String> name, required TfArg<String> location, required DataprocWorkflowTemplatePlacement placement, required List<DataprocWorkflowTemplateJobs> jobs, List<DataprocWorkflowTemplateParameters>? parameters, TfArg<String>? dagTimeout, DataprocWorkflowTemplateEncryptionConfig? encryptionConfig, TfArg<Map<String, String>>? labels, TfArg<num>? version, TfArg<String>? deletionPolicy, TfArg<String>? project, LifecycleOptions? lifecycle, List<TfAddressed>? dependsOn, StackProvider? provider, TfTimeouts? timeouts})

Properties

argMap → Map<String, TfArg?>: Argument-name → TfArg map. Keys are snake_case (Terraform JSON name). Synth emits these keys directly; the factory is responsible for the camelCase → snake_case translation at construction time.
finalinherited
createTime → TfRef<String>: Reference to create_time attribute.
no setter
dagTimeout → TfRef<String>: Reference to dag_timeout attribute.
no setter
defaultProvider → String: The provider name a block without provider uses: by default the prefix of terraformType (google for google_pubsub_topic).
no setterinherited
deletionPolicy → TfRef<String>: Reference to deletion_policy attribute.
no setter
dependsOn → List<TfAddressed>?: Optional depends_on = [...]: the resources, data sources and module calls this block waits for, e.g. dependsOn: [api, ...apiDeps]. Terraform takes whole blocks only, so an entry is never an attribute.
finalinherited
effectiveLabels → TfRef<Map<String, String>>: Reference to effective_labels attribute.
no setter
hashCode → int: The hash code for this object.
no setterinherited
id → TfRef<String>: Reference to id attribute.
no setter
kind → ResourceKind: Always ResourceKind.resource. Overridden by Data.
no setterinherited
labels → TfRef<Map<String, String>>: Reference to labels attribute.
no setter
lifecycle → LifecycleOptions?: Optional lifecycle { ... } block.
finalinherited
localName → String: User-supplied local name within a Stack.
finalinherited
location → TfRef<String>: Reference to location attribute.
no setter
name → TfRef<String>: Reference to name attribute.
no setter
project → TfRef<String>: Reference to project attribute.
no setter
provider → StackProvider?: Optional Terraform provider meta-argument: the provider configuration this block uses, e.g. the aliased GoogleProvider(alias: 'eu') the Stack registered with addProvider.
finalinherited
ref → RefTo<GoogleDataprocWorkflowTemplate>: A reference to this resource, for arguments typed RefTo<GoogleDataprocWorkflowTemplate>.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
sensitiveFields → Set<String>: Field names that are @Sensitive per the IR-derived per-resource constant. Curated factories override with a baked-in static const Set<String> (file-private in v0.5+).
no setteroverride
supportsDeletionProtection → bool: Capability flag: true when this resource's underlying Terraform schema has a deletion_protection boolean attribute that the synth-time devMode flow can flip to false. Defaults to false; the codegen emitter overrides this to true for wrappers whose schema includes the attribute.
no setterinherited
terraformLabels → TfRef<Map<String, String>>: Reference to terraform_labels attribute.
no setter
terraformType → String: Terraform resource type, e.g. google_pubsub_topic.
finalinherited
tfAddress → String: Terraform address <terraformType>.<localName>, e.g. google_pubsub_topic.orders.
no setterinherited
timeouts → TfTimeouts?: Optional timeouts { ... } block: how long Terraform waits for each operation. Provider-neutral like lifecycle — synth copies the duration strings verbatim, and terraform validate decides whether this resource's schema declares the operations set here.
finalinherited
updateTime → TfRef<String>: Reference to update_time attribute.
no setter
version → TfRef<num>: Reference to version attribute.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Constants

tfType → const String