Skip to content

Latest commit

 

History

History
2068 lines (1306 loc) · 95.6 KB

File metadata and controls

2068 lines (1306 loc) · 95.6 KB

googleWorkflowsWorkflow Submodule

Constructs

GoogleWorkflowsWorkflow

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

Initializers

using Io.Cdktn.Providers.GoogleBeta;

new GoogleWorkflowsWorkflow(Construct Scope, string Id, GoogleWorkflowsWorkflowConfig Config = null);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config GoogleWorkflowsWorkflowConfig 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


ConfigOptional

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".
PutTimeouts No description.
ResetCallLogLevel No description.
ResetCryptoKeyName No description.
ResetDeletionPolicy 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
private string ToString()

Returns a string representation of this construct.

With
private IConstruct With(params IMixin[] Mixins)

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: params Constructs.IMixin[]

The mixins to apply.


AddOverride
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string

ValueRequired
  • Type: object

OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
private void ResetOverrideLogicalId()

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

ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget
private void AddMoveTarget(string MoveTarget)

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
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

HasResourceMove
private TerraformResourceMoveByTarget|TerraformResourceMoveById HasResourceMove()
ImportFrom
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string

ProviderOptional
  • Type: Io.Cdktn.TerraformProvider

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

MoveFromId
private void MoveFromId(string Id)

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
private void MoveTo(string MoveTarget, string|double Index = null)

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|double

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


MoveToId
private void MoveToId(string Id)

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


PutTimeouts
private void PutTimeouts(GoogleWorkflowsWorkflowTimeouts Value)
ValueRequired

ResetCallLogLevel
private void ResetCallLogLevel()
ResetCryptoKeyName
private void ResetCryptoKeyName()
ResetDeletionPolicy
private void ResetDeletionPolicy()
ResetDeletionProtection
private void ResetDeletionProtection()
ResetDescription
private void ResetDescription()
ResetExecutionHistoryLevel
private void ResetExecutionHistoryLevel()
ResetId
private void ResetId()
ResetLabels
private void ResetLabels()
ResetName
private void ResetName()
ResetNamePrefix
private void ResetNamePrefix()
ResetProject
private void ResetProject()
ResetRegion
private void ResetRegion()
ResetServiceAccount
private void ResetServiceAccount()
ResetSourceContents
private void ResetSourceContents()
ResetTags
private void ResetTags()
ResetTimeouts
private void ResetTimeouts()
ResetUserEnvVars
private void ResetUserEnvVars()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTN code for importing a GoogleWorkflowsWorkflow resource upon running "cdktn plan ".

IsConstruct
using Io.Cdktn.Providers.GoogleBeta;

GoogleWorkflowsWorkflow.IsConstruct(object X);

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: object

Any object.


IsTerraformElement
using Io.Cdktn.Providers.GoogleBeta;

GoogleWorkflowsWorkflow.IsTerraformElement(object X);
XRequired
  • Type: object

IsTerraformResource
using Io.Cdktn.Providers.GoogleBeta;

GoogleWorkflowsWorkflow.IsTerraformResource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using Io.Cdktn.Providers.GoogleBeta;

GoogleWorkflowsWorkflow.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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


ImportFromIdRequired
  • Type: string

The id of the existing GoogleWorkflowsWorkflow that should be imported.

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


ProviderOptional
  • Type: Io.Cdktn.TerraformProvider

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


Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack Io.Cdktn.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata Io.Cdktn.TerraformProviderGeneratorMetadata No description.
Connection Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection No description.
Count double|Io.Cdktn.TerraformCount No description.
DependsOn string[] No description.
ForEach Io.Cdktn.ITerraformIterator No description.
Lifecycle Io.Cdktn.TerraformResourceLifecycle No description.
Provider Io.Cdktn.TerraformProvider No description.
Provisioners Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[] No description.
CreateTime string No description.
EffectiveLabels Io.Cdktn.StringMap No description.
RevisionId string No description.
State string No description.
TerraformLabels Io.Cdktn.StringMap No description.
Timeouts GoogleWorkflowsWorkflowTimeoutsOutputReference No description.
UpdateTime string No description.
CallLogLevelInput string No description.
CryptoKeyNameInput string No description.
DeletionPolicyInput string No description.
DeletionProtectionInput bool|Io.Cdktn.IResolvable No description.
DescriptionInput string No description.
ExecutionHistoryLevelInput string No description.
IdInput string No description.
LabelsInput System.Collections.Generic.IDictionary<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 System.Collections.Generic.IDictionary<string, string> No description.
TimeoutsInput Io.Cdktn.IResolvable|GoogleWorkflowsWorkflowTimeouts No description.
UserEnvVarsInput System.Collections.Generic.IDictionary<string, string> No description.
CallLogLevel string No description.
CryptoKeyName string No description.
DeletionPolicy string No description.
DeletionProtection bool|Io.Cdktn.IResolvable No description.
Description string No description.
ExecutionHistoryLevel string No description.
Id string No description.
Labels System.Collections.Generic.IDictionary<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 System.Collections.Generic.IDictionary<string, string> No description.
UserEnvVars System.Collections.Generic.IDictionary<string, string> No description.

NodeRequired
public Node Node { get; }
  • Type: Constructs.Node

The tree node.


CdktfStackRequired
public TerraformStack CdktfStack { get; }
  • Type: Io.Cdktn.TerraformStack

FqnRequired
public string Fqn { get; }
  • Type: string

FriendlyUniqueIdRequired
public string FriendlyUniqueId { get; }
  • Type: string

TerraformMetaArgumentsRequired
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>

TerraformResourceTypeRequired
public string TerraformResourceType { get; }
  • Type: string

TerraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: Io.Cdktn.TerraformProviderGeneratorMetadata

ConnectionOptional
public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; }
  • Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

CountOptional
public double|TerraformCount Count { get; }
  • Type: double|Io.Cdktn.TerraformCount

DependsOnOptional
public string[] DependsOn { get; }
  • Type: string[]

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: Io.Cdktn.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: Io.Cdktn.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: Io.Cdktn.TerraformProvider

ProvisionersOptional
public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; }
  • Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

CreateTimeRequired
public string CreateTime { get; }
  • Type: string

EffectiveLabelsRequired
public StringMap EffectiveLabels { get; }
  • Type: Io.Cdktn.StringMap

RevisionIdRequired
public string RevisionId { get; }
  • Type: string

StateRequired
public string State { get; }
  • Type: string

TerraformLabelsRequired
public StringMap TerraformLabels { get; }
  • Type: Io.Cdktn.StringMap

TimeoutsRequired
public GoogleWorkflowsWorkflowTimeoutsOutputReference Timeouts { get; }

UpdateTimeRequired
public string UpdateTime { get; }
  • Type: string

CallLogLevelInputOptional
public string CallLogLevelInput { get; }
  • Type: string

CryptoKeyNameInputOptional
public string CryptoKeyNameInput { get; }
  • Type: string

DeletionPolicyInputOptional
public string DeletionPolicyInput { get; }
  • Type: string

DeletionProtectionInputOptional
public bool|IResolvable DeletionProtectionInput { get; }
  • Type: bool|Io.Cdktn.IResolvable

DescriptionInputOptional
public string DescriptionInput { get; }
  • Type: string

ExecutionHistoryLevelInputOptional
public string ExecutionHistoryLevelInput { get; }
  • Type: string

IdInputOptional
public string IdInput { get; }
  • Type: string

LabelsInputOptional
public System.Collections.Generic.IDictionary<string, string> LabelsInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

NameInputOptional
public string NameInput { get; }
  • Type: string

NamePrefixInputOptional
public string NamePrefixInput { get; }
  • Type: string

ProjectInputOptional
public string ProjectInput { get; }
  • Type: string

RegionInputOptional
public string RegionInput { get; }
  • Type: string

ServiceAccountInputOptional
public string ServiceAccountInput { get; }
  • Type: string

SourceContentsInputOptional
public string SourceContentsInput { get; }
  • Type: string

TagsInputOptional
public System.Collections.Generic.IDictionary<string, string> TagsInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

TimeoutsInputOptional
public IResolvable|GoogleWorkflowsWorkflowTimeouts TimeoutsInput { get; }

UserEnvVarsInputOptional
public System.Collections.Generic.IDictionary<string, string> UserEnvVarsInput { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

CallLogLevelRequired
public string CallLogLevel { get; }
  • Type: string

CryptoKeyNameRequired
public string CryptoKeyName { get; }
  • Type: string

DeletionPolicyRequired
public string DeletionPolicy { get; }
  • Type: string

DeletionProtectionRequired
public bool|IResolvable DeletionProtection { get; }
  • Type: bool|Io.Cdktn.IResolvable

DescriptionRequired
public string Description { get; }
  • Type: string

ExecutionHistoryLevelRequired
public string ExecutionHistoryLevel { get; }
  • Type: string

IdRequired
public string Id { get; }
  • Type: string

LabelsRequired
public System.Collections.Generic.IDictionary<string, string> Labels { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

NameRequired
public string Name { get; }
  • Type: string

NamePrefixRequired
public string NamePrefix { get; }
  • Type: string

ProjectRequired
public string Project { get; }
  • Type: string

RegionRequired
public string Region { get; }
  • Type: string

ServiceAccountRequired
public string ServiceAccount { get; }
  • Type: string

SourceContentsRequired
public string SourceContents { get; }
  • Type: string

TagsRequired
public System.Collections.Generic.IDictionary<string, string> Tags { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

UserEnvVarsRequired
public System.Collections.Generic.IDictionary<string, string> UserEnvVars { get; }
  • Type: System.Collections.Generic.IDictionary<string, string>

Constants

Name Type Description
TfResourceType string No description.

TfResourceTypeRequired
public string TfResourceType { get; }
  • Type: string

Structs

GoogleWorkflowsWorkflowConfig

Initializer

using Io.Cdktn.Providers.GoogleBeta;

new GoogleWorkflowsWorkflowConfig {
    SSHProvisionerConnection|WinrmProvisionerConnection Connection = null,
    double|TerraformCount Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners = null,
    string CallLogLevel = null,
    string CryptoKeyName = null,
    string DeletionPolicy = null,
    bool|IResolvable DeletionProtection = null,
    string Description = null,
    string ExecutionHistoryLevel = null,
    string Id = null,
    System.Collections.Generic.IDictionary<string, string> Labels = null,
    string Name = null,
    string NamePrefix = null,
    string Project = null,
    string Region = null,
    string ServiceAccount = null,
    string SourceContents = null,
    System.Collections.Generic.IDictionary<string, string> Tags = null,
    GoogleWorkflowsWorkflowTimeouts Timeouts = null,
    System.Collections.Generic.IDictionary<string, string> UserEnvVars = null
};

Properties

Name Type Description
Connection Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection No description.
Count double|Io.Cdktn.TerraformCount No description.
DependsOn Io.Cdktn.ITerraformDependable[] No description.
ForEach Io.Cdktn.ITerraformIterator No description.
Lifecycle Io.Cdktn.TerraformResourceLifecycle No description.
Provider Io.Cdktn.TerraformProvider No description.
Provisioners Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.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.
DeletionPolicy string Whether Terraform will be prevented from destroying the instance.
DeletionProtection bool|Io.Cdktn.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-beta/7.36.0/docs/resources/google_workflows_workflow#id GoogleWorkflowsWorkflow#id}.
Labels System.Collections.Generic.IDictionary<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-beta/7.36.0/docs/resources/google_workflows_workflow#name_prefix GoogleWorkflowsWorkflow#name_prefix}.
Project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_workflows_workflow#project GoogleWorkflowsWorkflow#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 System.Collections.Generic.IDictionary<string, string> A map of resource manager tags.
Timeouts GoogleWorkflowsWorkflowTimeouts timeouts block.
UserEnvVars System.Collections.Generic.IDictionary<string, string> User-defined environment variables associated with this workflow revision.

ConnectionOptional
public SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; set; }
  • Type: Io.Cdktn.SSHProvisionerConnection|Io.Cdktn.WinrmProvisionerConnection

CountOptional
public double|TerraformCount Count { get; set; }
  • Type: double|Io.Cdktn.TerraformCount

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: Io.Cdktn.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: Io.Cdktn.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: Io.Cdktn.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: Io.Cdktn.TerraformProvider

ProvisionersOptional
public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; set; }
  • Type: Io.Cdktn.FileProvisioner|Io.Cdktn.LocalExecProvisioner|Io.Cdktn.RemoteExecProvisioner[]

CallLogLevelOptional
public string CallLogLevel { get; set; }
  • 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-beta/7.36.0/docs/resources/google_workflows_workflow#call_log_level GoogleWorkflowsWorkflow#call_log_level}


CryptoKeyNameOptional
public string CryptoKeyName { get; set; }
  • 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-beta/7.36.0/docs/resources/google_workflows_workflow#crypto_key_name GoogleWorkflowsWorkflow#crypto_key_name}


DeletionPolicyOptional
public string DeletionPolicy { get; set; }
  • 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.36.0/docs/resources/google_workflows_workflow#deletion_policy GoogleWorkflowsWorkflow#deletion_policy}


DeletionProtectionOptional
public bool|IResolvable DeletionProtection { get; set; }
  • Type: bool|Io.Cdktn.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-beta/7.36.0/docs/resources/google_workflows_workflow#deletion_protection GoogleWorkflowsWorkflow#deletion_protection}


DescriptionOptional
public string Description { get; set; }
  • 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-beta/7.36.0/docs/resources/google_workflows_workflow#description GoogleWorkflowsWorkflow#description}


ExecutionHistoryLevelOptional
public string ExecutionHistoryLevel { get; set; }
  • 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-beta/7.36.0/docs/resources/google_workflows_workflow#execution_history_level GoogleWorkflowsWorkflow#execution_history_level}


IdOptional
public string Id { get; set; }
  • Type: string

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


LabelsOptional
public System.Collections.Generic.IDictionary<string, string> Labels { get; set; }
  • Type: System.Collections.Generic.IDictionary<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-beta/7.36.0/docs/resources/google_workflows_workflow#labels GoogleWorkflowsWorkflow#labels}


NameOptional
public string Name { get; set; }
  • Type: string

Name of the Workflow.

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


NamePrefixOptional
public string NamePrefix { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_workflows_workflow#name_prefix GoogleWorkflowsWorkflow#name_prefix}.


ProjectOptional
public string Project { get; set; }
  • Type: string

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


RegionOptional
public string Region { get; set; }
  • Type: string

The region of the workflow.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_workflows_workflow#region GoogleWorkflowsWorkflow#region}


ServiceAccountOptional
public string ServiceAccount { get; set; }
  • 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-beta/7.36.0/docs/resources/google_workflows_workflow#service_account GoogleWorkflowsWorkflow#service_account}


SourceContentsOptional
public string SourceContents { get; set; }
  • Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_workflows_workflow#source_contents GoogleWorkflowsWorkflow#source_contents}


TagsOptional
public System.Collections.Generic.IDictionary<string, string> Tags { get; set; }
  • Type: System.Collections.Generic.IDictionary<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-beta/7.36.0/docs/resources/google_workflows_workflow#tags GoogleWorkflowsWorkflow#tags}


TimeoutsOptional
public GoogleWorkflowsWorkflowTimeouts Timeouts { get; set; }

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_workflows_workflow#timeouts GoogleWorkflowsWorkflow#timeouts}


UserEnvVarsOptional
public System.Collections.Generic.IDictionary<string, string> UserEnvVars { get; set; }
  • Type: System.Collections.Generic.IDictionary<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-beta/7.36.0/docs/resources/google_workflows_workflow#user_env_vars GoogleWorkflowsWorkflow#user_env_vars}


GoogleWorkflowsWorkflowTimeouts

Initializer

using Io.Cdktn.Providers.GoogleBeta;

new GoogleWorkflowsWorkflowTimeouts {
    string Create = null,
    string Delete = null,
    string Update = null
};

Properties

Name Type Description
Create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_workflows_workflow#create GoogleWorkflowsWorkflow#create}.
Delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_workflows_workflow#delete GoogleWorkflowsWorkflow#delete}.
Update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_workflows_workflow#update GoogleWorkflowsWorkflow#update}.

CreateOptional
public string Create { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_workflows_workflow#create GoogleWorkflowsWorkflow#create}.


DeleteOptional
public string Delete { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_workflows_workflow#delete GoogleWorkflowsWorkflow#delete}.


UpdateOptional
public string Update { get; set; }
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_workflows_workflow#update GoogleWorkflowsWorkflow#update}.


Classes

GoogleWorkflowsWorkflowTimeoutsOutputReference

Initializers

using Io.Cdktn.Providers.GoogleBeta;

new GoogleWorkflowsWorkflowTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name Type Description
TerraformResource Io.Cdktn.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.

TerraformResourceRequired
  • Type: Io.Cdktn.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • 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
private string ComputeFqn()
GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string

Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: Io.Cdktn.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetCreate
private void ResetCreate()
ResetDelete
private void ResetDelete()
ResetUpdate
private void ResetUpdate()

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 Io.Cdktn.IResolvable|GoogleWorkflowsWorkflowTimeouts No description.

CreationStackRequired
public string[] CreationStack { get; }
  • 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.


FqnRequired
public string Fqn { get; }
  • Type: string

CreateInputOptional
public string CreateInput { get; }
  • Type: string

DeleteInputOptional
public string DeleteInput { get; }
  • Type: string

UpdateInputOptional
public string UpdateInput { get; }
  • Type: string

CreateRequired
public string Create { get; }
  • Type: string

DeleteRequired
public string Delete { get; }
  • Type: string

UpdateRequired
public string Update { get; }
  • Type: string

InternalValueOptional
public IResolvable|GoogleWorkflowsWorkflowTimeouts InternalValue { get; }