Skip to content

Latest commit

 

History

History
2063 lines (1294 loc) · 102 KB

File metadata and controls

2063 lines (1294 loc) · 102 KB

googleDataflowFlexTemplateJob Submodule

Constructs

GoogleDataflowFlexTemplateJob

Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job google_dataflow_flex_template_job}.

Initializers

import { googleDataflowFlexTemplateJob } from '@cdktn/provider-google-beta'

new googleDataflowFlexTemplateJob.GoogleDataflowFlexTemplateJob(scope: Construct, id: string, config: GoogleDataflowFlexTemplateJobConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config GoogleDataflowFlexTemplateJobConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

Methods

Name Description
toString Returns a string representation of this construct.
with Applies one or more mixins to 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".
resetAdditionalExperiments No description.
resetAdditionalPipelineOptions No description.
resetAutoscalingAlgorithm No description.
resetCreateIgnoreAlreadyExists No description.
resetDeletionPolicy No description.
resetEnableStreamingEngine No description.
resetId No description.
resetIpConfiguration No description.
resetKmsKeyName No description.
resetLabels No description.
resetLauncherMachineType No description.
resetMachineType No description.
resetMaxWorkers No description.
resetNetwork No description.
resetNumWorkers No description.
resetOnDelete No description.
resetParameters No description.
resetProject No description.
resetRegion No description.
resetSdkContainerImage No description.
resetServiceAccountEmail No description.
resetSkipWaitOnJobTermination No description.
resetStagingLocation No description.
resetSubnetwork No description.
resetTempLocation No description.
resetTransformNameMapping No description.

toString
public toString(): string

Returns a string representation of this construct.

with
public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

mixinsRequired
  • Type: ...constructs.IMixin[]

The mixins to apply.


addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • 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.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


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

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktn.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • 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.

idRequired
  • 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.

moveTargetRequired
  • Type: string

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


indexOptional
  • 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".

idRequired
  • Type: string

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


resetAdditionalExperiments
public resetAdditionalExperiments(): void
resetAdditionalPipelineOptions
public resetAdditionalPipelineOptions(): void
resetAutoscalingAlgorithm
public resetAutoscalingAlgorithm(): void
resetCreateIgnoreAlreadyExists
public resetCreateIgnoreAlreadyExists(): void
resetDeletionPolicy
public resetDeletionPolicy(): void
resetEnableStreamingEngine
public resetEnableStreamingEngine(): void
resetId
public resetId(): void
resetIpConfiguration
public resetIpConfiguration(): void
resetKmsKeyName
public resetKmsKeyName(): void
resetLabels
public resetLabels(): void
resetLauncherMachineType
public resetLauncherMachineType(): void
resetMachineType
public resetMachineType(): void
resetMaxWorkers
public resetMaxWorkers(): void
resetNetwork
public resetNetwork(): void
resetNumWorkers
public resetNumWorkers(): void
resetOnDelete
public resetOnDelete(): void
resetParameters
public resetParameters(): void
resetProject
public resetProject(): void
resetRegion
public resetRegion(): void
resetSdkContainerImage
public resetSdkContainerImage(): void
resetServiceAccountEmail
public resetServiceAccountEmail(): void
resetSkipWaitOnJobTermination
public resetSkipWaitOnJobTermination(): void
resetStagingLocation
public resetStagingLocation(): void
resetSubnetwork
public resetSubnetwork(): void
resetTempLocation
public resetTempLocation(): void
resetTransformNameMapping
public resetTransformNameMapping(): void

Static Functions

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

isConstruct
import { googleDataflowFlexTemplateJob } from '@cdktn/provider-google-beta'

googleDataflowFlexTemplateJob.GoogleDataflowFlexTemplateJob.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.

xRequired
  • Type: any

Any object.


isTerraformElement
import { googleDataflowFlexTemplateJob } from '@cdktn/provider-google-beta'

googleDataflowFlexTemplateJob.GoogleDataflowFlexTemplateJob.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { googleDataflowFlexTemplateJob } from '@cdktn/provider-google-beta'

googleDataflowFlexTemplateJob.GoogleDataflowFlexTemplateJob.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { googleDataflowFlexTemplateJob } from '@cdktn/provider-google-beta'

googleDataflowFlexTemplateJob.GoogleDataflowFlexTemplateJob.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTN code for importing a GoogleDataflowFlexTemplateJob resource upon running "cdktn plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

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


importFromIdRequired
  • Type: string

The id of the existing GoogleDataflowFlexTemplateJob that should be imported.

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


providerOptional
  • Type: cdktn.TerraformProvider

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


Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktn.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktn.TerraformProviderGeneratorMetadata No description.
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count number | cdktn.TerraformCount No description.
dependsOn string[] No description.
forEach cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[] No description.
effectiveLabels cdktn.StringMap No description.
jobId string No description.
state string No description.
terraformLabels cdktn.StringMap No description.
type string No description.
additionalExperimentsInput string[] No description.
additionalPipelineOptionsInput string[] No description.
autoscalingAlgorithmInput string No description.
containerSpecGcsPathInput string No description.
createIgnoreAlreadyExistsInput boolean | cdktn.IResolvable No description.
deletionPolicyInput string No description.
enableStreamingEngineInput boolean | cdktn.IResolvable No description.
idInput string No description.
ipConfigurationInput string No description.
kmsKeyNameInput string No description.
labelsInput {[ key: string ]: string} No description.
launcherMachineTypeInput string No description.
machineTypeInput string No description.
maxWorkersInput number No description.
nameInput string No description.
networkInput string No description.
numWorkersInput number No description.
onDeleteInput string No description.
parametersInput {[ key: string ]: string} No description.
projectInput string No description.
regionInput string No description.
sdkContainerImageInput string No description.
serviceAccountEmailInput string No description.
skipWaitOnJobTerminationInput boolean | cdktn.IResolvable No description.
stagingLocationInput string No description.
subnetworkInput string No description.
tempLocationInput string No description.
transformNameMappingInput {[ key: string ]: string} No description.
additionalExperiments string[] No description.
additionalPipelineOptions string[] No description.
autoscalingAlgorithm string No description.
containerSpecGcsPath string No description.
createIgnoreAlreadyExists boolean | cdktn.IResolvable No description.
deletionPolicy string No description.
enableStreamingEngine boolean | cdktn.IResolvable No description.
id string No description.
ipConfiguration string No description.
kmsKeyName string No description.
labels {[ key: string ]: string} No description.
launcherMachineType string No description.
machineType string No description.
maxWorkers number No description.
name string No description.
network string No description.
numWorkers number No description.
onDelete string No description.
parameters {[ key: string ]: string} No description.
project string No description.
region string No description.
sdkContainerImage string No description.
serviceAccountEmail string No description.
skipWaitOnJobTermination boolean | cdktn.IResolvable No description.
stagingLocation string No description.
subnetwork string No description.
tempLocation string No description.
transformNameMapping {[ key: string ]: string} No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktn.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

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

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktn.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktn.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktn.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktn.TerraformProvider

provisionersOptional
public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];
  • Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

effectiveLabelsRequired
public readonly effectiveLabels: StringMap;
  • Type: cdktn.StringMap

jobIdRequired
public readonly jobId: string;
  • Type: string

stateRequired
public readonly state: string;
  • Type: string

terraformLabelsRequired
public readonly terraformLabels: StringMap;
  • Type: cdktn.StringMap

typeRequired
public readonly type: string;
  • Type: string

additionalExperimentsInputOptional
public readonly additionalExperimentsInput: string[];
  • Type: string[]

additionalPipelineOptionsInputOptional
public readonly additionalPipelineOptionsInput: string[];
  • Type: string[]

autoscalingAlgorithmInputOptional
public readonly autoscalingAlgorithmInput: string;
  • Type: string

containerSpecGcsPathInputOptional
public readonly containerSpecGcsPathInput: string;
  • Type: string

createIgnoreAlreadyExistsInputOptional
public readonly createIgnoreAlreadyExistsInput: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

deletionPolicyInputOptional
public readonly deletionPolicyInput: string;
  • Type: string

enableStreamingEngineInputOptional
public readonly enableStreamingEngineInput: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

idInputOptional
public readonly idInput: string;
  • Type: string

ipConfigurationInputOptional
public readonly ipConfigurationInput: string;
  • Type: string

kmsKeyNameInputOptional
public readonly kmsKeyNameInput: string;
  • Type: string

labelsInputOptional
public readonly labelsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

launcherMachineTypeInputOptional
public readonly launcherMachineTypeInput: string;
  • Type: string

machineTypeInputOptional
public readonly machineTypeInput: string;
  • Type: string

maxWorkersInputOptional
public readonly maxWorkersInput: number;
  • Type: number

nameInputOptional
public readonly nameInput: string;
  • Type: string

networkInputOptional
public readonly networkInput: string;
  • Type: string

numWorkersInputOptional
public readonly numWorkersInput: number;
  • Type: number

onDeleteInputOptional
public readonly onDeleteInput: string;
  • Type: string

parametersInputOptional
public readonly parametersInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

projectInputOptional
public readonly projectInput: string;
  • Type: string

regionInputOptional
public readonly regionInput: string;
  • Type: string

sdkContainerImageInputOptional
public readonly sdkContainerImageInput: string;
  • Type: string

serviceAccountEmailInputOptional
public readonly serviceAccountEmailInput: string;
  • Type: string

skipWaitOnJobTerminationInputOptional
public readonly skipWaitOnJobTerminationInput: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

stagingLocationInputOptional
public readonly stagingLocationInput: string;
  • Type: string

subnetworkInputOptional
public readonly subnetworkInput: string;
  • Type: string

tempLocationInputOptional
public readonly tempLocationInput: string;
  • Type: string

transformNameMappingInputOptional
public readonly transformNameMappingInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

additionalExperimentsRequired
public readonly additionalExperiments: string[];
  • Type: string[]

additionalPipelineOptionsRequired
public readonly additionalPipelineOptions: string[];
  • Type: string[]

autoscalingAlgorithmRequired
public readonly autoscalingAlgorithm: string;
  • Type: string

containerSpecGcsPathRequired
public readonly containerSpecGcsPath: string;
  • Type: string

createIgnoreAlreadyExistsRequired
public readonly createIgnoreAlreadyExists: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

deletionPolicyRequired
public readonly deletionPolicy: string;
  • Type: string

enableStreamingEngineRequired
public readonly enableStreamingEngine: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

idRequired
public readonly id: string;
  • Type: string

ipConfigurationRequired
public readonly ipConfiguration: string;
  • Type: string

kmsKeyNameRequired
public readonly kmsKeyName: string;
  • Type: string

labelsRequired
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

launcherMachineTypeRequired
public readonly launcherMachineType: string;
  • Type: string

machineTypeRequired
public readonly machineType: string;
  • Type: string

maxWorkersRequired
public readonly maxWorkers: number;
  • Type: number

nameRequired
public readonly name: string;
  • Type: string

networkRequired
public readonly network: string;
  • Type: string

numWorkersRequired
public readonly numWorkers: number;
  • Type: number

onDeleteRequired
public readonly onDelete: string;
  • Type: string

parametersRequired
public readonly parameters: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

projectRequired
public readonly project: string;
  • Type: string

regionRequired
public readonly region: string;
  • Type: string

sdkContainerImageRequired
public readonly sdkContainerImage: string;
  • Type: string

serviceAccountEmailRequired
public readonly serviceAccountEmail: string;
  • Type: string

skipWaitOnJobTerminationRequired
public readonly skipWaitOnJobTermination: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

stagingLocationRequired
public readonly stagingLocation: string;
  • Type: string

subnetworkRequired
public readonly subnetwork: string;
  • Type: string

tempLocationRequired
public readonly tempLocation: string;
  • Type: string

transformNameMappingRequired
public readonly transformNameMapping: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

GoogleDataflowFlexTemplateJobConfig

Initializer

import { googleDataflowFlexTemplateJob } from '@cdktn/provider-google-beta'

const googleDataflowFlexTemplateJobConfig: googleDataflowFlexTemplateJob.GoogleDataflowFlexTemplateJobConfig = { ... }

Properties

Name Type Description
connection cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection No description.
count number | cdktn.TerraformCount No description.
dependsOn cdktn.ITerraformDependable[] No description.
forEach cdktn.ITerraformIterator No description.
lifecycle cdktn.TerraformResourceLifecycle No description.
provider cdktn.TerraformProvider No description.
provisioners cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[] No description.
containerSpecGcsPath string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#container_spec_gcs_path GoogleDataflowFlexTemplateJob#container_spec_gcs_path}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#name GoogleDataflowFlexTemplateJob#name}.
additionalExperiments string[] List of experiments that should be used by the job. An example value is ["enable_stackdriver_agent_metrics"].
additionalPipelineOptions string[] List of pipeline options that should be used by the job. An example value is ["numberOfWorkerHarnessThreads=20"].
autoscalingAlgorithm string The algorithm to use for autoscaling.
createIgnoreAlreadyExists boolean | cdktn.IResolvable If true, if a 409 AlreadyExists error is returned on create, the provider will ignore it and adopt the existing resource.
deletionPolicy string Whether Terraform will be prevented from destroying the instance.
enableStreamingEngine boolean | cdktn.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-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#id GoogleDataflowFlexTemplateJob#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.
launcherMachineType string The machine type to use for launching the job. The default is n1-standard-1.
machineType string The machine type to use for the job.
maxWorkers number The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.
network string The network to which VMs will be assigned. If it is not provided, "default" will be used.
numWorkers number The initial number of Google Compute Engine instances for the job.
onDelete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#on_delete GoogleDataflowFlexTemplateJob#on_delete}.
parameters {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#parameters GoogleDataflowFlexTemplateJob#parameters}.
project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#project GoogleDataflowFlexTemplateJob#project}.
region string The region in which the created job should run.
sdkContainerImage string Docker registry location of container image to use for the 'worker harness.
serviceAccountEmail string The Service Account email used to create the job.
skipWaitOnJobTermination boolean | cdktn.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.
stagingLocation string The Cloud Storage path to use for staging files. Must be a valid Cloud Storage URL, beginning with gs://.
subnetwork string The subnetwork to which VMs will be assigned. Should be of the form "regions/REGION/subnetworks/SUBNETWORK".
tempLocation string The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.
transformNameMapping {[ key: string ]: string} Only applicable when updating a pipeline.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktn.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktn.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktn.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktn.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktn.TerraformProvider

provisionersOptional
public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];
  • Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

containerSpecGcsPathRequired
public readonly containerSpecGcsPath: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#container_spec_gcs_path GoogleDataflowFlexTemplateJob#container_spec_gcs_path}.


nameRequired
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#name GoogleDataflowFlexTemplateJob#name}.


additionalExperimentsOptional
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-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#additional_experiments GoogleDataflowFlexTemplateJob#additional_experiments}


additionalPipelineOptionsOptional
public readonly additionalPipelineOptions: string[];
  • Type: string[]

List of pipeline options that should be used by the job. An example value is ["numberOfWorkerHarnessThreads=20"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#additional_pipeline_options GoogleDataflowFlexTemplateJob#additional_pipeline_options}


autoscalingAlgorithmOptional
public readonly autoscalingAlgorithm: string;
  • Type: string

The algorithm to use for autoscaling.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#autoscaling_algorithm GoogleDataflowFlexTemplateJob#autoscaling_algorithm}


createIgnoreAlreadyExistsOptional
public readonly createIgnoreAlreadyExists: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

If true, if a 409 AlreadyExists error is returned on create, the provider will ignore it and adopt the existing resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#create_ignore_already_exists GoogleDataflowFlexTemplateJob#create_ignore_already_exists}


deletionPolicyOptional
public readonly deletionPolicy: string;
  • Type: string

Whether Terraform will be prevented from destroying the instance.

Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#deletion_policy GoogleDataflowFlexTemplateJob#deletion_policy}


enableStreamingEngineOptional
public readonly enableStreamingEngine: boolean | IResolvable;
  • Type: boolean | cdktn.IResolvable

Indicates if the job should use the streaming engine feature.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#enable_streaming_engine GoogleDataflowFlexTemplateJob#enable_streaming_engine}


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#id GoogleDataflowFlexTemplateJob#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.


ipConfigurationOptional
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-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#ip_configuration GoogleDataflowFlexTemplateJob#ip_configuration}


kmsKeyNameOptional
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-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#kms_key_name GoogleDataflowFlexTemplateJob#kms_key_name}


labelsOptional
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-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#labels GoogleDataflowFlexTemplateJob#labels}


launcherMachineTypeOptional
public readonly launcherMachineType: string;
  • Type: string

The machine type to use for launching the job. The default is n1-standard-1.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#launcher_machine_type GoogleDataflowFlexTemplateJob#launcher_machine_type}


machineTypeOptional
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-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#machine_type GoogleDataflowFlexTemplateJob#machine_type}


maxWorkersOptional
public readonly maxWorkers: number;
  • Type: number

The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#max_workers GoogleDataflowFlexTemplateJob#max_workers}


networkOptional
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-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#network GoogleDataflowFlexTemplateJob#network}


numWorkersOptional
public readonly numWorkers: number;
  • Type: number

The initial number of Google Compute Engine instances for the job.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#num_workers GoogleDataflowFlexTemplateJob#num_workers}


onDeleteOptional
public readonly onDelete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#on_delete GoogleDataflowFlexTemplateJob#on_delete}.


parametersOptional
public readonly parameters: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#parameters GoogleDataflowFlexTemplateJob#parameters}.


projectOptional
public readonly project: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#project GoogleDataflowFlexTemplateJob#project}.


regionOptional
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-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#region GoogleDataflowFlexTemplateJob#region}


sdkContainerImageOptional
public readonly sdkContainerImage: string;
  • Type: string

Docker registry location of container image to use for the 'worker harness.

Default is the container for the version of the SDK. Note this field is only valid for portable pipelines.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#sdk_container_image GoogleDataflowFlexTemplateJob#sdk_container_image}


serviceAccountEmailOptional
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-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#service_account_email GoogleDataflowFlexTemplateJob#service_account_email}


skipWaitOnJobTerminationOptional
public readonly skipWaitOnJobTermination: boolean | IResolvable;
  • Type: boolean | cdktn.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-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#skip_wait_on_job_termination GoogleDataflowFlexTemplateJob#skip_wait_on_job_termination}


stagingLocationOptional
public readonly stagingLocation: string;
  • Type: string

The Cloud Storage path to use for staging files. Must be a valid Cloud Storage URL, beginning with gs://.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#staging_location GoogleDataflowFlexTemplateJob#staging_location}


subnetworkOptional
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-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#subnetwork GoogleDataflowFlexTemplateJob#subnetwork}


tempLocationOptional
public readonly tempLocation: string;
  • Type: string

The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with gs://.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#temp_location GoogleDataflowFlexTemplateJob#temp_location}


transformNameMappingOptional
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-beta/7.40.0/docs/resources/google_dataflow_flex_template_job#transform_name_mapping GoogleDataflowFlexTemplateJob#transform_name_mapping}