workflowsWorkflow.typescript.md

workflowsWorkflow Submodule

Constructs

WorkflowsWorkflow

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow google_workflows_workflow}.

Initializers

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

new workflowsWorkflow.WorkflowsWorkflow(scope: Construct, id: string, config?: WorkflowsWorkflowConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	WorkflowsWorkflowConfig	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^Optional

• Type: WorkflowsWorkflowConfig

---

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.
resetCallLogLevel	No description.
resetCryptoKeyName	No description.
resetDeletionProtection	No description.
resetDescription	No description.
resetExecutionHistoryLevel	No description.
resetId	No description.
resetLabels	No description.
resetName	No description.
resetNamePrefix	No description.
resetProject	No description.
resetRegion	No description.
resetServiceAccount	No description.
resetSourceContents	No description.
resetTags	No description.
resetTimeouts	No description.
resetUserEnvVars	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: WorkflowsWorkflowTimeouts): void

value^Required

• Type: WorkflowsWorkflowTimeouts

---

resetCallLogLevel

public resetCallLogLevel(): void

resetCryptoKeyName

public resetCryptoKeyName(): void

resetDeletionProtection

public resetDeletionProtection(): void

resetDescription

public resetDescription(): void

resetExecutionHistoryLevel

public resetExecutionHistoryLevel(): void

resetId

public resetId(): void

resetLabels

public resetLabels(): void

resetName

public resetName(): void

resetNamePrefix

public resetNamePrefix(): void

resetProject

public resetProject(): void

resetRegion

public resetRegion(): void

resetServiceAccount

public resetServiceAccount(): void

resetSourceContents

public resetSourceContents(): void

resetTags

public resetTags(): void

resetTimeouts

public resetTimeouts(): void

resetUserEnvVars

public resetUserEnvVars(): 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 WorkflowsWorkflow resource upon running "cdktf plan ".

---

isConstruct

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

workflowsWorkflow.WorkflowsWorkflow.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 { workflowsWorkflow } from '@cdktf/provider-google'

workflowsWorkflow.WorkflowsWorkflow.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

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

workflowsWorkflow.WorkflowsWorkflow.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

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

workflowsWorkflow.WorkflowsWorkflow.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a WorkflowsWorkflow 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 WorkflowsWorkflow to import.

---

importFromId^Required

• Type: string

The id of the existing WorkflowsWorkflow that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#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 WorkflowsWorkflow 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.
createTime	string	No description.
effectiveLabels	cdktf.StringMap	No description.
revisionId	string	No description.
state	string	No description.
terraformLabels	cdktf.StringMap	No description.
timeouts	WorkflowsWorkflowTimeoutsOutputReference	No description.
updateTime	string	No description.
callLogLevelInput	string	No description.
cryptoKeyNameInput	string	No description.
deletionProtectionInput	boolean | cdktf.IResolvable	No description.
descriptionInput	string	No description.
executionHistoryLevelInput	string	No description.
idInput	string	No description.
labelsInput	{[ key: string ]: string}	No description.
nameInput	string	No description.
namePrefixInput	string	No description.
projectInput	string	No description.
regionInput	string	No description.
serviceAccountInput	string	No description.
sourceContentsInput	string	No description.
tagsInput	{[ key: string ]: string}	No description.
timeoutsInput	cdktf.IResolvable | WorkflowsWorkflowTimeouts	No description.
userEnvVarsInput	{[ key: string ]: string}	No description.
callLogLevel	string	No description.
cryptoKeyName	string	No description.
deletionProtection	boolean | cdktf.IResolvable	No description.
description	string	No description.
executionHistoryLevel	string	No description.
id	string	No description.
labels	{[ key: string ]: string}	No description.
name	string	No description.
namePrefix	string	No description.
project	string	No description.
region	string	No description.
serviceAccount	string	No description.
sourceContents	string	No description.
tags	{[ key: string ]: string}	No description.
userEnvVars	{[ key: string ]: 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[]

---

createTime^Required

public readonly createTime: string;

• Type: string

---

effectiveLabels^Required

public readonly effectiveLabels: StringMap;

• Type: cdktf.StringMap

---

revisionId^Required

public readonly revisionId: 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: WorkflowsWorkflowTimeoutsOutputReference;

• Type: WorkflowsWorkflowTimeoutsOutputReference

---

updateTime^Required

public readonly updateTime: string;

• Type: string

---

callLogLevelInput^Optional

public readonly callLogLevelInput: string;

• Type: string

---

cryptoKeyNameInput^Optional

public readonly cryptoKeyNameInput: string;

• Type: string

---

deletionProtectionInput^Optional

public readonly deletionProtectionInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

descriptionInput^Optional

public readonly descriptionInput: string;

• Type: string

---

executionHistoryLevelInput^Optional

public readonly executionHistoryLevelInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

labelsInput^Optional

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

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

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

namePrefixInput^Optional

public readonly namePrefixInput: string;

• Type: string

---

projectInput^Optional

public readonly projectInput: string;

• Type: string

---

regionInput^Optional

public readonly regionInput: string;

• Type: string

---

serviceAccountInput^Optional

public readonly serviceAccountInput: string;

• Type: string

---

sourceContentsInput^Optional

public readonly sourceContentsInput: string;

• Type: string

---

tagsInput^Optional

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

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

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | WorkflowsWorkflowTimeouts;

• Type: cdktf.IResolvable | WorkflowsWorkflowTimeouts

---

userEnvVarsInput^Optional

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

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

---

callLogLevel^Required

public readonly callLogLevel: string;

• Type: string

---

cryptoKeyName^Required

public readonly cryptoKeyName: string;

• Type: string

---

deletionProtection^Required

public readonly deletionProtection: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

description^Required

public readonly description: string;

• Type: string

---

executionHistoryLevel^Required

public readonly executionHistoryLevel: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

labels^Required

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

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

---

name^Required

public readonly name: string;

• Type: string

---

namePrefix^Required

public readonly namePrefix: string;

• Type: string

---

project^Required

public readonly project: string;

• Type: string

---

region^Required

public readonly region: string;

• Type: string

---

serviceAccount^Required

public readonly serviceAccount: string;

• Type: string

---

sourceContents^Required

public readonly sourceContents: string;

• Type: string

---

tags^Required

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

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

---

userEnvVars^Required

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

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

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

WorkflowsWorkflowConfig

Initializer

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

const workflowsWorkflowConfig: workflowsWorkflow.WorkflowsWorkflowConfig = { ... }

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.
callLogLevel	string	Describes the level of platform logging to apply to calls and call responses during executions of this workflow.
cryptoKeyName	string	The KMS key used to encrypt workflow and execution data.
deletionProtection	boolean | cdktf.IResolvable	Whether Terraform will be prevented from destroying the workflow.
description	string	Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
executionHistoryLevel	string	Describes the level of execution history to be stored for this workflow.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#id WorkflowsWorkflow#id}.
labels	{[ key: string ]: string}	A set of key/value label pairs to assign to this Workflow.
name	string	Name of the Workflow.
namePrefix	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#name_prefix WorkflowsWorkflow#name_prefix}.
project	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#project WorkflowsWorkflow#project}.
region	string	The region of the workflow.
serviceAccount	string	Name of the service account associated with the latest workflow version.
sourceContents	string	Workflow code to be executed. The size limit is 128KB.
tags	{[ key: string ]: string}	A map of resource manager tags.
timeouts	WorkflowsWorkflowTimeouts	timeouts block.
userEnvVars	{[ key: string ]: string}	User-defined environment variables associated with this workflow revision.

---

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[]

---

callLogLevel^Optional

public readonly callLogLevel: string;

• Type: string

Describes the level of platform logging to apply to calls and call responses during executions of this workflow.

If both the workflow and the execution specify a logging level, the execution level takes precedence. Possible values: ["CALL_LOG_LEVEL_UNSPECIFIED", "LOG_ALL_CALLS", "LOG_ERRORS_ONLY", "LOG_NONE"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#call_log_level WorkflowsWorkflow#call_log_level}

---

cryptoKeyName^Optional

public readonly cryptoKeyName: string;

• Type: string

The KMS key used to encrypt workflow and execution data.

Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#crypto_key_name WorkflowsWorkflow#crypto_key_name}

---

deletionProtection^Optional

public readonly deletionProtection: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Whether Terraform will be prevented from destroying the workflow.

Defaults to true. When a'terraform destroy' or 'terraform apply' would delete the workflow, the command will fail if this field is not set to false in Terraform state. When the field is set to true or unset in Terraform state, a 'terraform apply' or 'terraform destroy' that would delete the workflow will fail. When the field is set to false, deleting the workflow is allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#deletion_protection WorkflowsWorkflow#deletion_protection}

---

description^Optional

public readonly description: string;

• Type: string

Description of the workflow provided by the user. Must be at most 1000 unicode characters long.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#description WorkflowsWorkflow#description}

---

executionHistoryLevel^Optional

public readonly executionHistoryLevel: string;

• Type: string

Describes the level of execution history to be stored for this workflow.

This configuration determines how much information about workflow executions is preserved. If not specified, defaults to EXECUTION_HISTORY_LEVEL_UNSPECIFIED. Possible values: ["EXECUTION_HISTORY_LEVEL_UNSPECIFIED", "EXECUTION_HISTORY_BASIC", "EXECUTION_HISTORY_DETAILED"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#execution_history_level WorkflowsWorkflow#execution_history_level}

---

id^Optional

public readonly id: string;

• Type: string

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

---

labels^Optional

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

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

A set of key/value label pairs to assign to this Workflow.

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.35.0/docs/resources/workflows_workflow#labels WorkflowsWorkflow#labels}

---

name^Optional

public readonly name: string;

• Type: string

Name of the Workflow.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#name WorkflowsWorkflow#name}

---

namePrefix^Optional

public readonly namePrefix: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#name_prefix WorkflowsWorkflow#name_prefix}.

---

project^Optional

public readonly project: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#project WorkflowsWorkflow#project}.

---

region^Optional

public readonly region: string;

• Type: string

The region of the workflow.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#region WorkflowsWorkflow#region}

---

serviceAccount^Optional

public readonly serviceAccount: string;

• Type: string

Name of the service account associated with the latest workflow version.

This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account}. Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. The {account} value can be the email address or the unique_id of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#service_account WorkflowsWorkflow#service_account}

---

sourceContents^Optional

public readonly sourceContents: string;

• Type: string

Workflow code to be executed. The size limit is 128KB.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#source_contents WorkflowsWorkflow#source_contents}

---

tags^Optional

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

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

A map of resource manager tags.

Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#tags WorkflowsWorkflow#tags}

---

timeouts^Optional

public readonly timeouts: WorkflowsWorkflowTimeouts;

• Type: WorkflowsWorkflowTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#timeouts WorkflowsWorkflow#timeouts}

---

userEnvVars^Optional

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

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

User-defined environment variables associated with this workflow revision.

This map has a maximum length of 20. Each string can take up to 4KiB. Keys cannot be empty strings and cannot start with "GOOGLE" or "WORKFLOWS".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#user_env_vars WorkflowsWorkflow#user_env_vars}

---

WorkflowsWorkflowTimeouts

Initializer

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

const workflowsWorkflowTimeouts: workflowsWorkflow.WorkflowsWorkflowTimeouts = { ... }

Properties

Name	Type	Description
create	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#create WorkflowsWorkflow#create}.
delete	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#delete WorkflowsWorkflow#delete}.
update	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#update WorkflowsWorkflow#update}.

---

create^Optional

public readonly create: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#create WorkflowsWorkflow#create}.

---

delete^Optional

public readonly delete: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#delete WorkflowsWorkflow#delete}.

---

update^Optional

public readonly update: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.35.0/docs/resources/workflows_workflow#update WorkflowsWorkflow#update}.

---

Classes

WorkflowsWorkflowTimeoutsOutputReference

Initializers

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

new workflowsWorkflow.WorkflowsWorkflowTimeoutsOutputReference(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.
resetCreate	No description.
resetDelete	No description.
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.

resetCreate

public resetCreate(): void

resetDelete

public resetDelete(): void

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.
createInput	string	No description.
deleteInput	string	No description.
updateInput	string	No description.
create	string	No description.
delete	string	No description.
update	string	No description.
internalValue	cdktf.IResolvable | WorkflowsWorkflowTimeouts	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

---

createInput^Optional

public readonly createInput: string;

• Type: string

---

deleteInput^Optional

public readonly deleteInput: string;

• Type: string

---

updateInput^Optional

public readonly updateInput: string;

• Type: string

---

create^Required

public readonly create: string;

• Type: string

---

delete^Required

public readonly delete: string;

• Type: string

---

update^Required

public readonly update: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | WorkflowsWorkflowTimeouts;

• Type: cdktf.IResolvable | WorkflowsWorkflowTimeouts

---