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

Class WorkflowsWorkflow.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static WorkflowsWorkflow.Builder create​(software.constructs.Construct scope,
                                               String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of WorkflowsWorkflow.Builder.

      • connection

        @Stability(Experimental)
public WorkflowsWorkflow.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public WorkflowsWorkflow.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public WorkflowsWorkflow.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public WorkflowsWorkflow.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public WorkflowsWorkflow.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public WorkflowsWorkflow.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public WorkflowsWorkflow.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public WorkflowsWorkflow.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • callLogLevel

        @Stability(Stable)
public WorkflowsWorkflow.Builder callLogLevel​(String callLogLevel)
        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}

        Parameters:
        callLogLevel - Describes the level of platform logging to apply to calls and call responses during executions of this workflow. This parameter is required.
        Returns:
        this

      • cryptoKeyName

        @Stability(Stable)
public WorkflowsWorkflow.Builder cryptoKeyName​(String cryptoKeyName)
        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}

        Parameters:
        cryptoKeyName - The KMS key used to encrypt workflow and execution data. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public WorkflowsWorkflow.Builder description​(String description)
        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}

        Parameters:
        description - Description of the workflow provided by the user. Must be at most 1000 unicode characters long. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public WorkflowsWorkflow.Builder id​(String id)
        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.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/workflows_workflow#id WorkflowsWorkflow#id}. This parameter is required.
        Returns:
        this

      • labels

        @Stability(Stable)
public WorkflowsWorkflow.Builder labels​(Map<String,​String> labels)
        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}

        Parameters:
        labels - A set of key/value label pairs to assign to this Workflow. This parameter is required.
        Returns:
        this

      • name

        @Stability(Stable)
public WorkflowsWorkflow.Builder name​(String name)
        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}

        Parameters:
        name - Name of the Workflow. This parameter is required.
        Returns:
        this

      • namePrefix

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

        Parameters:
        namePrefix - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/workflows_workflow#name_prefix WorkflowsWorkflow#name_prefix}. This parameter is required.
        Returns:
        this

      • project

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

        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/workflows_workflow#project WorkflowsWorkflow#project}. This parameter is required.
        Returns:
        this

      • region

        @Stability(Stable)
public WorkflowsWorkflow.Builder region​(String region)
        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}

        Parameters:
        region - The region of the workflow. This parameter is required.
        Returns:
        this

      • serviceAccount

        @Stability(Stable)
public WorkflowsWorkflow.Builder serviceAccount​(String serviceAccount)
        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}

        Parameters:
        serviceAccount - Name of the service account associated with the latest workflow version. This parameter is required.
        Returns:
        this

      • sourceContents

        @Stability(Stable)
public WorkflowsWorkflow.Builder sourceContents​(String sourceContents)
        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}

        Parameters:
        sourceContents - Workflow code to be executed. The size limit is 128KB. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public WorkflowsWorkflow.Builder timeouts​(WorkflowsWorkflowTimeouts timeouts)
        timeouts block.

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

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this

      • userEnvVars

        @Stability(Stable)
public WorkflowsWorkflow.Builder userEnvVars​(Map<String,​String> userEnvVars)
        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}

        Parameters:
        userEnvVars - User-defined environment variables associated with this workflow revision. This parameter is required.
        Returns:
        this