Documentation
¶
Index ¶
- func NewWorkflowsWorkflowTimeoutsOutputReference_Override(w WorkflowsWorkflowTimeoutsOutputReference, ...)
- func NewWorkflowsWorkflow_Override(w WorkflowsWorkflow, scope constructs.Construct, id *string, ...)
- func WorkflowsWorkflow_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func WorkflowsWorkflow_IsConstruct(x interface{}) *bool
- func WorkflowsWorkflow_IsTerraformElement(x interface{}) *bool
- func WorkflowsWorkflow_IsTerraformResource(x interface{}) *bool
- func WorkflowsWorkflow_TfResourceType() *string
- type WorkflowsWorkflow
- type WorkflowsWorkflowConfig
- type WorkflowsWorkflowTimeouts
- type WorkflowsWorkflowTimeoutsOutputReference
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewWorkflowsWorkflowTimeoutsOutputReference_Override ¶
func NewWorkflowsWorkflowTimeoutsOutputReference_Override(w WorkflowsWorkflowTimeoutsOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)
func NewWorkflowsWorkflow_Override ¶
func NewWorkflowsWorkflow_Override(w WorkflowsWorkflow, scope constructs.Construct, id *string, config *WorkflowsWorkflowConfig)
Create a new {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/workflows_workflow google_workflows_workflow} Resource.
func WorkflowsWorkflow_GenerateConfigForImport ¶
func WorkflowsWorkflow_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a WorkflowsWorkflow resource upon running "cdktf plan <stack-name>".
func WorkflowsWorkflow_IsConstruct ¶
func WorkflowsWorkflow_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func WorkflowsWorkflow_IsTerraformElement ¶
func WorkflowsWorkflow_IsTerraformElement(x interface{}) *bool
Experimental.
func WorkflowsWorkflow_IsTerraformResource ¶
func WorkflowsWorkflow_IsTerraformResource(x interface{}) *bool
Experimental.
func WorkflowsWorkflow_TfResourceType ¶
func WorkflowsWorkflow_TfResourceType() *string
Types ¶
type WorkflowsWorkflow ¶
type WorkflowsWorkflow interface {
cdktf.TerraformResource
CallLogLevel() *string
SetCallLogLevel(val *string)
CallLogLevelInput() *string
// Experimental.
CdktfStack() cdktf.TerraformStack
// Experimental.
Connection() interface{}
// Experimental.
SetConnection(val interface{})
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
// Experimental.
Count() interface{}
// Experimental.
SetCount(val interface{})
CreateTime() *string
CryptoKeyName() *string
SetCryptoKeyName(val *string)
CryptoKeyNameInput() *string
DeletionProtection() interface{}
SetDeletionProtection(val interface{})
DeletionProtectionInput() interface{}
// Experimental.
DependsOn() *[]*string
// Experimental.
SetDependsOn(val *[]*string)
Description() *string
SetDescription(val *string)
DescriptionInput() *string
EffectiveLabels() cdktf.StringMap
ExecutionHistoryLevel() *string
SetExecutionHistoryLevel(val *string)
ExecutionHistoryLevelInput() *string
// Experimental.
ForEach() cdktf.ITerraformIterator
// Experimental.
SetForEach(val cdktf.ITerraformIterator)
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
Id() *string
SetId(val *string)
IdInput() *string
Labels() *map[string]*string
SetLabels(val *map[string]*string)
LabelsInput() *map[string]*string
// Experimental.
Lifecycle() *cdktf.TerraformResourceLifecycle
// Experimental.
SetLifecycle(val *cdktf.TerraformResourceLifecycle)
Name() *string
SetName(val *string)
NameInput() *string
NamePrefix() *string
SetNamePrefix(val *string)
NamePrefixInput() *string
// The tree node.
Node() constructs.Node
Project() *string
SetProject(val *string)
ProjectInput() *string
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
Provisioners() *[]interface{}
// Experimental.
SetProvisioners(val *[]interface{})
// Experimental.
RawOverrides() interface{}
Region() *string
SetRegion(val *string)
RegionInput() *string
RevisionId() *string
ServiceAccount() *string
SetServiceAccount(val *string)
ServiceAccountInput() *string
SourceContents() *string
SetSourceContents(val *string)
SourceContentsInput() *string
State() *string
Tags() *map[string]*string
SetTags(val *map[string]*string)
TagsInput() *map[string]*string
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
TerraformLabels() cdktf.StringMap
// Experimental.
TerraformMetaArguments() *map[string]interface{}
// Experimental.
TerraformResourceType() *string
Timeouts() WorkflowsWorkflowTimeoutsOutputReference
TimeoutsInput() interface{}
UpdateTime() *string
UserEnvVars() *map[string]*string
SetUserEnvVars(val *map[string]*string)
UserEnvVarsInput() *map[string]*string
// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
// Experimental.
AddMoveTarget(moveTarget *string)
// Experimental.
AddOverride(path *string, value interface{})
// Experimental.
GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
// Experimental.
GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
// Experimental.
GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
// Experimental.
GetListAttribute(terraformAttribute *string) *[]*string
// Experimental.
GetNumberAttribute(terraformAttribute *string) *float64
// Experimental.
GetNumberListAttribute(terraformAttribute *string) *[]*float64
// Experimental.
GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
// Experimental.
GetStringAttribute(terraformAttribute *string) *string
// Experimental.
GetStringMapAttribute(terraformAttribute *string) *map[string]*string
// Experimental.
HasResourceMove() interface{}
// Experimental.
ImportFrom(id *string, provider cdktf.TerraformProvider)
// Experimental.
InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
// 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.
// Experimental.
MoveFromId(id *string)
// Moves this resource to the target resource given by moveTarget.
// Experimental.
MoveTo(moveTarget *string, index interface{})
// Moves this resource to the resource corresponding to "id".
// Experimental.
MoveToId(id *string)
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
PutTimeouts(value *WorkflowsWorkflowTimeouts)
ResetCallLogLevel()
ResetCryptoKeyName()
ResetDeletionProtection()
ResetDescription()
ResetExecutionHistoryLevel()
ResetId()
ResetLabels()
ResetName()
ResetNamePrefix()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetProject()
ResetRegion()
ResetServiceAccount()
ResetSourceContents()
ResetTags()
ResetTimeouts()
ResetUserEnvVars()
SynthesizeAttributes() *map[string]interface{}
SynthesizeHclAttributes() *map[string]interface{}
// Experimental.
ToHclTerraform() interface{}
// Experimental.
ToMetadata() interface{}
// Returns a string representation of this construct.
ToString() *string
// Adds this resource to the terraform JSON output.
// Experimental.
ToTerraform() interface{}
}
Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/workflows_workflow google_workflows_workflow}.
func NewWorkflowsWorkflow ¶
func NewWorkflowsWorkflow(scope constructs.Construct, id *string, config *WorkflowsWorkflowConfig) WorkflowsWorkflow
Create a new {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/workflows_workflow google_workflows_workflow} Resource.
type WorkflowsWorkflowConfig ¶
type WorkflowsWorkflowConfig struct {
// Experimental.
Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
// Experimental.
Count interface{} `field:"optional" json:"count" yaml:"count"`
// Experimental.
DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
// Experimental.
ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
// Experimental.
Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
// Experimental.
Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
// Experimental.
Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
// 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.32.0/docs/resources/workflows_workflow#call_log_level WorkflowsWorkflow#call_log_level}
CallLogLevel *string `field:"optional" json:"callLogLevel" yaml:"callLogLevel"`
// 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.32.0/docs/resources/workflows_workflow#crypto_key_name WorkflowsWorkflow#crypto_key_name}
CryptoKeyName *string `field:"optional" json:"cryptoKeyName" yaml:"cryptoKeyName"`
// 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.32.0/docs/resources/workflows_workflow#deletion_protection WorkflowsWorkflow#deletion_protection}
DeletionProtection interface{} `field:"optional" json:"deletionProtection" yaml:"deletionProtection"`
// 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.32.0/docs/resources/workflows_workflow#description WorkflowsWorkflow#description}
Description *string `field:"optional" json:"description" yaml:"description"`
// 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.32.0/docs/resources/workflows_workflow#execution_history_level WorkflowsWorkflow#execution_history_level}
ExecutionHistoryLevel *string `field:"optional" json:"executionHistoryLevel" yaml:"executionHistoryLevel"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.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.
Id *string `field:"optional" json:"id" yaml:"id"`
// 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.32.0/docs/resources/workflows_workflow#labels WorkflowsWorkflow#labels}
Labels *map[string]*string `field:"optional" json:"labels" yaml:"labels"`
// Name of the Workflow.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/workflows_workflow#name WorkflowsWorkflow#name}
Name *string `field:"optional" json:"name" yaml:"name"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/workflows_workflow#name_prefix WorkflowsWorkflow#name_prefix}.
NamePrefix *string `field:"optional" json:"namePrefix" yaml:"namePrefix"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/workflows_workflow#project WorkflowsWorkflow#project}.
Project *string `field:"optional" json:"project" yaml:"project"`
// The region of the workflow.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/workflows_workflow#region WorkflowsWorkflow#region}
Region *string `field:"optional" json:"region" yaml:"region"`
// 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.32.0/docs/resources/workflows_workflow#service_account WorkflowsWorkflow#service_account}
ServiceAccount *string `field:"optional" json:"serviceAccount" yaml:"serviceAccount"`
// Workflow code to be executed. The size limit is 128KB.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/workflows_workflow#source_contents WorkflowsWorkflow#source_contents}
SourceContents *string `field:"optional" json:"sourceContents" yaml:"sourceContents"`
// 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.32.0/docs/resources/workflows_workflow#tags WorkflowsWorkflow#tags}
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
// timeouts block.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/workflows_workflow#timeouts WorkflowsWorkflow#timeouts}
Timeouts *WorkflowsWorkflowTimeouts `field:"optional" json:"timeouts" yaml:"timeouts"`
// 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.32.0/docs/resources/workflows_workflow#user_env_vars WorkflowsWorkflow#user_env_vars}
UserEnvVars *map[string]*string `field:"optional" json:"userEnvVars" yaml:"userEnvVars"`
}
type WorkflowsWorkflowTimeouts ¶
type WorkflowsWorkflowTimeouts struct {
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/workflows_workflow#create WorkflowsWorkflow#create}.
Create *string `field:"optional" json:"create" yaml:"create"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/workflows_workflow#delete WorkflowsWorkflow#delete}.
Delete *string `field:"optional" json:"delete" yaml:"delete"`
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.32.0/docs/resources/workflows_workflow#update WorkflowsWorkflow#update}.
Update *string `field:"optional" json:"update" yaml:"update"`
}
type WorkflowsWorkflowTimeoutsOutputReference ¶
type WorkflowsWorkflowTimeoutsOutputReference interface {
cdktf.ComplexObject
// the index of the complex object in a list.
// Experimental.
ComplexObjectIndex() interface{}
// Experimental.
SetComplexObjectIndex(val interface{})
// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
// Experimental.
ComplexObjectIsFromSet() *bool
// Experimental.
SetComplexObjectIsFromSet(val *bool)
Create() *string
SetCreate(val *string)
CreateInput() *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.
// Experimental.
CreationStack() *[]*string
Delete() *string
SetDelete(val *string)
DeleteInput() *string
// Experimental.
Fqn() *string
InternalValue() interface{}
SetInternalValue(val interface{})
// Experimental.
TerraformAttribute() *string
// Experimental.
SetTerraformAttribute(val *string)
// Experimental.
TerraformResource() cdktf.IInterpolatingParent
// Experimental.
SetTerraformResource(val cdktf.IInterpolatingParent)
Update() *string
SetUpdate(val *string)
UpdateInput() *string
// Experimental.
ComputeFqn() *string
// Experimental.
GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
// Experimental.
GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
// Experimental.
GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
// Experimental.
GetListAttribute(terraformAttribute *string) *[]*string
// Experimental.
GetNumberAttribute(terraformAttribute *string) *float64
// Experimental.
GetNumberListAttribute(terraformAttribute *string) *[]*float64
// Experimental.
GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
// Experimental.
GetStringAttribute(terraformAttribute *string) *string
// Experimental.
GetStringMapAttribute(terraformAttribute *string) *map[string]*string
// Experimental.
InterpolationAsList() cdktf.IResolvable
// Experimental.
InterpolationForAttribute(property *string) cdktf.IResolvable
ResetCreate()
ResetDelete()
ResetUpdate()
// Produce the Token's value at resolution time.
// Experimental.
Resolve(_context cdktf.IResolveContext) interface{}
// Return a string representation of this resolvable object.
//
// Returns a reversible string representation.
// Experimental.
ToString() *string
}
func NewWorkflowsWorkflowTimeoutsOutputReference ¶
func NewWorkflowsWorkflowTimeoutsOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) WorkflowsWorkflowTimeoutsOutputReference