Package com.hashicorp.cdktf.providers.google.workflows_workflow

Interface WorkflowsWorkflowConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    WorkflowsWorkflowConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:23.062Z")
@Stability(Stable)
public interface WorkflowsWorkflowConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getCallLogLevel

        @Stability(Stable)
@Nullable
default String getCallLogLevel()
        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/5.43.1/docs/resources/workflows_workflow#call_log_level WorkflowsWorkflow#call_log_level}

      • getCryptoKeyName

        @Stability(Stable)
@Nullable
default String getCryptoKeyName()
        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/5.43.1/docs/resources/workflows_workflow#crypto_key_name WorkflowsWorkflow#crypto_key_name}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        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/5.43.1/docs/resources/workflows_workflow#description WorkflowsWorkflow#description}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/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.

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        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/5.43.1/docs/resources/workflows_workflow#labels WorkflowsWorkflow#labels}

      • getName

        @Stability(Stable)
@Nullable
default String getName()
        Name of the Workflow.

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

      • getNamePrefix

        @Stability(Stable)
@Nullable
default String getNamePrefix()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/workflows_workflow#name_prefix WorkflowsWorkflow#name_prefix}.

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/workflows_workflow#project WorkflowsWorkflow#project}.

      • getRegion

        @Stability(Stable)
@Nullable
default String getRegion()
        The region of the workflow.

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

      • getServiceAccount

        @Stability(Stable)
@Nullable
default String getServiceAccount()
        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/5.43.1/docs/resources/workflows_workflow#service_account WorkflowsWorkflow#service_account}

      • getSourceContents

        @Stability(Stable)
@Nullable
default String getSourceContents()
        Workflow code to be executed. The size limit is 128KB.

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

      • getTimeouts

        @Stability(Stable)
@Nullable
default WorkflowsWorkflowTimeouts getTimeouts()
        timeouts block.

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

      • getUserEnvVars

        @Stability(Stable)
@Nullable
default Map<String,​String> getUserEnvVars()
        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/5.43.1/docs/resources/workflows_workflow#user_env_vars WorkflowsWorkflow#user_env_vars}