dataflowJob.typescript.md

dataflowJob Submodule

Constructs

DataflowJob

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job google_dataflow_job}.

Initializers

import { dataflowJob } from '@cdktf/provider-google'

new dataflowJob.DataflowJob(scope: Construct, id: string, config: DataflowJobConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	DataflowJobConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: DataflowJobConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
putTimeouts	No description.
resetAdditionalExperiments	No description.
resetEnableStreamingEngine	No description.
resetId	No description.
resetIpConfiguration	No description.
resetKmsKeyName	No description.
resetLabels	No description.
resetMachineType	No description.
resetMaxWorkers	No description.
resetNetwork	No description.
resetOnDelete	No description.
resetParameters	No description.
resetProject	No description.
resetRegion	No description.
resetServiceAccountEmail	No description.
resetSkipWaitOnJobTermination	No description.
resetSubnetwork	No description.
resetTimeouts	No description.
resetTransformNameMapping	No description.
resetZone	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

putTimeouts

public putTimeouts(value: DataflowJobTimeouts): void

value^Required

• Type: DataflowJobTimeouts

---

resetAdditionalExperiments

public resetAdditionalExperiments(): void

resetEnableStreamingEngine

public resetEnableStreamingEngine(): void

resetId

public resetId(): void

resetIpConfiguration

public resetIpConfiguration(): void

resetKmsKeyName

public resetKmsKeyName(): void

resetLabels

public resetLabels(): void

resetMachineType

public resetMachineType(): void

resetMaxWorkers

public resetMaxWorkers(): void

resetNetwork

public resetNetwork(): void

resetOnDelete

public resetOnDelete(): void

resetParameters

public resetParameters(): void

resetProject

public resetProject(): void

resetRegion

public resetRegion(): void

resetServiceAccountEmail

public resetServiceAccountEmail(): void

resetSkipWaitOnJobTermination

public resetSkipWaitOnJobTermination(): void

resetSubnetwork

public resetSubnetwork(): void

resetTimeouts

public resetTimeouts(): void

resetTransformNameMapping

public resetTransformNameMapping(): void

resetZone

public resetZone(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a DataflowJob resource upon running "cdktf plan ".

---

isConstruct

import { dataflowJob } from '@cdktf/provider-google'

dataflowJob.DataflowJob.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { dataflowJob } from '@cdktf/provider-google'

dataflowJob.DataflowJob.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { dataflowJob } from '@cdktf/provider-google'

dataflowJob.DataflowJob.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { dataflowJob } from '@cdktf/provider-google'

dataflowJob.DataflowJob.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a DataflowJob resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the DataflowJob to import.

---

importFromId^Required

• Type: string

The id of the existing DataflowJob that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the DataflowJob to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
effectiveLabels	cdktf.StringMap	No description.
jobId	string	No description.
state	string	No description.
terraformLabels	cdktf.StringMap	No description.
timeouts	DataflowJobTimeoutsOutputReference	No description.
type	string	No description.
additionalExperimentsInput	string[]	No description.
enableStreamingEngineInput	boolean | cdktf.IResolvable	No description.
idInput	string	No description.
ipConfigurationInput	string	No description.
kmsKeyNameInput	string	No description.
labelsInput	{[ key: string ]: string}	No description.
machineTypeInput	string	No description.
maxWorkersInput	number	No description.
nameInput	string	No description.
networkInput	string	No description.
onDeleteInput	string	No description.
parametersInput	{[ key: string ]: string}	No description.
projectInput	string	No description.
regionInput	string	No description.
serviceAccountEmailInput	string	No description.
skipWaitOnJobTerminationInput	boolean | cdktf.IResolvable	No description.
subnetworkInput	string	No description.
tempGcsLocationInput	string	No description.
templateGcsPathInput	string	No description.
timeoutsInput	cdktf.IResolvable | DataflowJobTimeouts	No description.
transformNameMappingInput	{[ key: string ]: string}	No description.
zoneInput	string	No description.
additionalExperiments	string[]	No description.
enableStreamingEngine	boolean | cdktf.IResolvable	No description.
id	string	No description.
ipConfiguration	string	No description.
kmsKeyName	string	No description.
labels	{[ key: string ]: string}	No description.
machineType	string	No description.
maxWorkers	number	No description.
name	string	No description.
network	string	No description.
onDelete	string	No description.
parameters	{[ key: string ]: string}	No description.
project	string	No description.
region	string	No description.
serviceAccountEmail	string	No description.
skipWaitOnJobTermination	boolean | cdktf.IResolvable	No description.
subnetwork	string	No description.
tempGcsLocation	string	No description.
templateGcsPath	string	No description.
transformNameMapping	{[ key: string ]: string}	No description.
zone	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

effectiveLabels^Required

public readonly effectiveLabels: StringMap;

• Type: cdktf.StringMap

---

jobId^Required

public readonly jobId: string;

• Type: string

---

state^Required

public readonly state: string;

• Type: string

---

terraformLabels^Required

public readonly terraformLabels: StringMap;

• Type: cdktf.StringMap

---

timeouts^Required

public readonly timeouts: DataflowJobTimeoutsOutputReference;

• Type: DataflowJobTimeoutsOutputReference

---

type^Required

public readonly type: string;

• Type: string

---

additionalExperimentsInput^Optional

public readonly additionalExperimentsInput: string[];

• Type: string[]

---

enableStreamingEngineInput^Optional

public readonly enableStreamingEngineInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

ipConfigurationInput^Optional

public readonly ipConfigurationInput: string;

• Type: string

---

kmsKeyNameInput^Optional

public readonly kmsKeyNameInput: string;

• Type: string

---

labelsInput^Optional

public readonly labelsInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

machineTypeInput^Optional

public readonly machineTypeInput: string;

• Type: string

---

maxWorkersInput^Optional

public readonly maxWorkersInput: number;

• Type: number

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

networkInput^Optional

public readonly networkInput: string;

• Type: string

---

onDeleteInput^Optional

public readonly onDeleteInput: string;

• Type: string

---

parametersInput^Optional

public readonly parametersInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

projectInput^Optional

public readonly projectInput: string;

• Type: string

---

regionInput^Optional

public readonly regionInput: string;

• Type: string

---

serviceAccountEmailInput^Optional

public readonly serviceAccountEmailInput: string;

• Type: string

---

skipWaitOnJobTerminationInput^Optional

public readonly skipWaitOnJobTerminationInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

subnetworkInput^Optional

public readonly subnetworkInput: string;

• Type: string

---

tempGcsLocationInput^Optional

public readonly tempGcsLocationInput: string;

• Type: string

---

templateGcsPathInput^Optional

public readonly templateGcsPathInput: string;

• Type: string

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | DataflowJobTimeouts;

• Type: cdktf.IResolvable | DataflowJobTimeouts

---

transformNameMappingInput^Optional

public readonly transformNameMappingInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

zoneInput^Optional

public readonly zoneInput: string;

• Type: string

---

additionalExperiments^Required

public readonly additionalExperiments: string[];

• Type: string[]

---

enableStreamingEngine^Required

public readonly enableStreamingEngine: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

id^Required

public readonly id: string;

• Type: string

---

ipConfiguration^Required

public readonly ipConfiguration: string;

• Type: string

---

kmsKeyName^Required

public readonly kmsKeyName: string;

• Type: string

---

labels^Required

public readonly labels: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

machineType^Required

public readonly machineType: string;

• Type: string

---

maxWorkers^Required

public readonly maxWorkers: number;

• Type: number

---

name^Required

public readonly name: string;

• Type: string

---

network^Required

public readonly network: string;

• Type: string

---

onDelete^Required

public readonly onDelete: string;

• Type: string

---

parameters^Required

public readonly parameters: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

project^Required

public readonly project: string;

• Type: string

---

region^Required

public readonly region: string;

• Type: string

---

serviceAccountEmail^Required

public readonly serviceAccountEmail: string;

• Type: string

---

skipWaitOnJobTermination^Required

public readonly skipWaitOnJobTermination: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

subnetwork^Required

public readonly subnetwork: string;

• Type: string

---

tempGcsLocation^Required

public readonly tempGcsLocation: string;

• Type: string

---

templateGcsPath^Required

public readonly templateGcsPath: string;

• Type: string

---

transformNameMapping^Required

public readonly transformNameMapping: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

zone^Required

public readonly zone: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DataflowJobConfig

Initializer

import { dataflowJob } from '@cdktf/provider-google'

const dataflowJobConfig: dataflowJob.DataflowJobConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
name	string	A unique name for the resource, required by Dataflow.
tempGcsLocation	string	A writeable location on Google Cloud Storage for the Dataflow job to dump its temporary data.
templateGcsPath	string	The Google Cloud Storage path to the Dataflow job template.
additionalExperiments	string[]	List of experiments that should be used by the job. An example value is ["enable_stackdriver_agent_metrics"].
enableStreamingEngine	boolean | cdktf.IResolvable	Indicates if the job should use the streaming engine feature.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#id DataflowJob#id}.
ipConfiguration	string	The configuration for VM IPs. Options are "WORKER_IP_PUBLIC" or "WORKER_IP_PRIVATE".
kmsKeyName	string	The name for the Cloud KMS key for the job. Key format is: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY.
labels	{[ key: string ]: string}	User labels to be specified for the job.
machineType	string	The machine type to use for the job.
maxWorkers	number	The number of workers permitted to work on the job. More workers may improve processing speed at additional cost.
network	string	The network to which VMs will be assigned. If it is not provided, "default" will be used.
onDelete	string	One of "drain" or "cancel". Specifies behavior of deletion during terraform destroy.
parameters	{[ key: string ]: string}	Key/Value pairs to be passed to the Dataflow job (as used in the template).
project	string	The project in which the resource belongs.
region	string	The region in which the created job should run.
serviceAccountEmail	string	The Service Account email used to create the job.
skipWaitOnJobTermination	boolean | cdktf.IResolvable	If true, treat DRAINING and CANCELLING as terminal job states and do not wait for further changes before removing from terraform state and moving on.
subnetwork	string	The subnetwork to which VMs will be assigned. Should be of the form "regions/REGION/subnetworks/SUBNETWORK".
timeouts	DataflowJobTimeouts	timeouts block.
transformNameMapping	{[ key: string ]: string}	Only applicable when updating a pipeline.
zone	string	The zone in which the created job should run. If it is not provided, the provider zone is used.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

name^Required

public readonly name: string;

• Type: string

A unique name for the resource, required by Dataflow.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#name DataflowJob#name}

---

tempGcsLocation^Required

public readonly tempGcsLocation: string;

• Type: string

A writeable location on Google Cloud Storage for the Dataflow job to dump its temporary data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#temp_gcs_location DataflowJob#temp_gcs_location}

---

templateGcsPath^Required

public readonly templateGcsPath: string;

• Type: string

The Google Cloud Storage path to the Dataflow job template.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#template_gcs_path DataflowJob#template_gcs_path}

---

additionalExperiments^Optional

public readonly additionalExperiments: string[];

• Type: string[]

List of experiments that should be used by the job. An example value is ["enable_stackdriver_agent_metrics"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#additional_experiments DataflowJob#additional_experiments}

---

enableStreamingEngine^Optional

public readonly enableStreamingEngine: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Indicates if the job should use the streaming engine feature.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#enable_streaming_engine DataflowJob#enable_streaming_engine}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#id DataflowJob#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

ipConfiguration^Optional

public readonly ipConfiguration: string;

• Type: string

The configuration for VM IPs. Options are "WORKER_IP_PUBLIC" or "WORKER_IP_PRIVATE".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#ip_configuration DataflowJob#ip_configuration}

---

kmsKeyName^Optional

public readonly kmsKeyName: string;

• Type: string

The name for the Cloud KMS key for the job. Key format is: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#kms_key_name DataflowJob#kms_key_name}

---

labels^Optional

public readonly labels: {[ key: string ]: string};

• Type: {[ key: string ]: string}

User labels to be specified for the job.

Keys and values should follow the restrictions specified in the labeling restrictions page. NOTE: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#labels DataflowJob#labels}

---

machineType^Optional

public readonly machineType: string;

• Type: string

The machine type to use for the job.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#machine_type DataflowJob#machine_type}

---

maxWorkers^Optional

public readonly maxWorkers: number;

• Type: number

The number of workers permitted to work on the job. More workers may improve processing speed at additional cost.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#max_workers DataflowJob#max_workers}

---

network^Optional

public readonly network: string;

• Type: string

The network to which VMs will be assigned. If it is not provided, "default" will be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#network DataflowJob#network}

---

onDelete^Optional

public readonly onDelete: string;

• Type: string

One of "drain" or "cancel". Specifies behavior of deletion during terraform destroy.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#on_delete DataflowJob#on_delete}

---

parameters^Optional

public readonly parameters: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Key/Value pairs to be passed to the Dataflow job (as used in the template).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#parameters DataflowJob#parameters}

---

project^Optional

public readonly project: string;

• Type: string

The project in which the resource belongs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#project DataflowJob#project}

---

region^Optional

public readonly region: string;

• Type: string

The region in which the created job should run.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#region DataflowJob#region}

---

serviceAccountEmail^Optional

public readonly serviceAccountEmail: string;

• Type: string

The Service Account email used to create the job.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#service_account_email DataflowJob#service_account_email}

---

skipWaitOnJobTermination^Optional

public readonly skipWaitOnJobTermination: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

If true, treat DRAINING and CANCELLING as terminal job states and do not wait for further changes before removing from terraform state and moving on.

WARNING: this will lead to job name conflicts if you do not ensure that the job names are different, e.g. by embedding a release ID or by using a random_id.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#skip_wait_on_job_termination DataflowJob#skip_wait_on_job_termination}

---

subnetwork^Optional

public readonly subnetwork: string;

• Type: string

The subnetwork to which VMs will be assigned. Should be of the form "regions/REGION/subnetworks/SUBNETWORK".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#subnetwork DataflowJob#subnetwork}

---

timeouts^Optional

public readonly timeouts: DataflowJobTimeouts;

• Type: DataflowJobTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#timeouts DataflowJob#timeouts}

---

transformNameMapping^Optional

public readonly transformNameMapping: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Only applicable when updating a pipeline.

Map of transform name prefixes of the job to be replaced with the corresponding name prefixes of the new job.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#transform_name_mapping DataflowJob#transform_name_mapping}

---

zone^Optional

public readonly zone: string;

• Type: string

The zone in which the created job should run. If it is not provided, the provider zone is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#zone DataflowJob#zone}

---

DataflowJobTimeouts

Initializer

import { dataflowJob } from '@cdktf/provider-google'

const dataflowJobTimeouts: dataflowJob.DataflowJobTimeouts = { ... }

Properties

Name	Type	Description
update	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#update DataflowJob#update}.

---

update^Optional

public readonly update: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.22.0/docs/resources/dataflow_job#update DataflowJob#update}.

---

Classes

DataflowJobTimeoutsOutputReference

Initializers

import { dataflowJob } from '@cdktf/provider-google'

new dataflowJob.DataflowJobTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetUpdate	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetUpdate

public resetUpdate(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
updateInput	string	No description.
update	string	No description.
internalValue	cdktf.IResolvable | DataflowJobTimeouts	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

updateInput^Optional

public readonly updateInput: string;

• Type: string

---

update^Required

public readonly update: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | DataflowJobTimeouts;

• Type: cdktf.IResolvable | DataflowJobTimeouts

---