Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.dataform/v1beta1.WorkflowConfig
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Creates a new WorkflowConfig in a given Repository. Auto-naming is currently not supported for this resource.
Create WorkflowConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WorkflowConfig(name: string, args: WorkflowConfigArgs, opts?: CustomResourceOptions);@overload
def WorkflowConfig(resource_name: str,
                   args: WorkflowConfigArgs,
                   opts: Optional[ResourceOptions] = None)
@overload
def WorkflowConfig(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   release_config: Optional[str] = None,
                   repository_id: Optional[str] = None,
                   workflow_config_id: Optional[str] = None,
                   cron_schedule: Optional[str] = None,
                   invocation_config: Optional[InvocationConfigArgs] = None,
                   location: Optional[str] = None,
                   project: Optional[str] = None,
                   time_zone: Optional[str] = None)func NewWorkflowConfig(ctx *Context, name string, args WorkflowConfigArgs, opts ...ResourceOption) (*WorkflowConfig, error)public WorkflowConfig(string name, WorkflowConfigArgs args, CustomResourceOptions? opts = null)
public WorkflowConfig(String name, WorkflowConfigArgs args)
public WorkflowConfig(String name, WorkflowConfigArgs args, CustomResourceOptions options)
type: google-native:dataform/v1beta1:WorkflowConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args WorkflowConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args WorkflowConfigArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args WorkflowConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WorkflowConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WorkflowConfigArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var workflowConfigResource = new GoogleNative.Dataform.V1Beta1.WorkflowConfig("workflowConfigResource", new()
{
    ReleaseConfig = "string",
    RepositoryId = "string",
    WorkflowConfigId = "string",
    CronSchedule = "string",
    InvocationConfig = new GoogleNative.Dataform.V1Beta1.Inputs.InvocationConfigArgs
    {
        FullyRefreshIncrementalTablesEnabled = false,
        IncludedTags = new[]
        {
            "string",
        },
        IncludedTargets = new[]
        {
            new GoogleNative.Dataform.V1Beta1.Inputs.TargetArgs
            {
                Database = "string",
                Name = "string",
                Schema = "string",
            },
        },
        ServiceAccount = "string",
        TransitiveDependenciesIncluded = false,
        TransitiveDependentsIncluded = false,
    },
    Location = "string",
    Project = "string",
    TimeZone = "string",
});
example, err := dataform.NewWorkflowConfig(ctx, "workflowConfigResource", &dataform.WorkflowConfigArgs{
	ReleaseConfig:    pulumi.String("string"),
	RepositoryId:     pulumi.String("string"),
	WorkflowConfigId: pulumi.String("string"),
	CronSchedule:     pulumi.String("string"),
	InvocationConfig: &dataform.InvocationConfigArgs{
		FullyRefreshIncrementalTablesEnabled: pulumi.Bool(false),
		IncludedTags: pulumi.StringArray{
			pulumi.String("string"),
		},
		IncludedTargets: dataform.TargetArray{
			&dataform.TargetArgs{
				Database: pulumi.String("string"),
				Name:     pulumi.String("string"),
				Schema:   pulumi.String("string"),
			},
		},
		ServiceAccount:                 pulumi.String("string"),
		TransitiveDependenciesIncluded: pulumi.Bool(false),
		TransitiveDependentsIncluded:   pulumi.Bool(false),
	},
	Location: pulumi.String("string"),
	Project:  pulumi.String("string"),
	TimeZone: pulumi.String("string"),
})
var workflowConfigResource = new WorkflowConfig("workflowConfigResource", WorkflowConfigArgs.builder()
    .releaseConfig("string")
    .repositoryId("string")
    .workflowConfigId("string")
    .cronSchedule("string")
    .invocationConfig(InvocationConfigArgs.builder()
        .fullyRefreshIncrementalTablesEnabled(false)
        .includedTags("string")
        .includedTargets(TargetArgs.builder()
            .database("string")
            .name("string")
            .schema("string")
            .build())
        .serviceAccount("string")
        .transitiveDependenciesIncluded(false)
        .transitiveDependentsIncluded(false)
        .build())
    .location("string")
    .project("string")
    .timeZone("string")
    .build());
workflow_config_resource = google_native.dataform.v1beta1.WorkflowConfig("workflowConfigResource",
    release_config="string",
    repository_id="string",
    workflow_config_id="string",
    cron_schedule="string",
    invocation_config={
        "fully_refresh_incremental_tables_enabled": False,
        "included_tags": ["string"],
        "included_targets": [{
            "database": "string",
            "name": "string",
            "schema": "string",
        }],
        "service_account": "string",
        "transitive_dependencies_included": False,
        "transitive_dependents_included": False,
    },
    location="string",
    project="string",
    time_zone="string")
const workflowConfigResource = new google_native.dataform.v1beta1.WorkflowConfig("workflowConfigResource", {
    releaseConfig: "string",
    repositoryId: "string",
    workflowConfigId: "string",
    cronSchedule: "string",
    invocationConfig: {
        fullyRefreshIncrementalTablesEnabled: false,
        includedTags: ["string"],
        includedTargets: [{
            database: "string",
            name: "string",
            schema: "string",
        }],
        serviceAccount: "string",
        transitiveDependenciesIncluded: false,
        transitiveDependentsIncluded: false,
    },
    location: "string",
    project: "string",
    timeZone: "string",
});
type: google-native:dataform/v1beta1:WorkflowConfig
properties:
    cronSchedule: string
    invocationConfig:
        fullyRefreshIncrementalTablesEnabled: false
        includedTags:
            - string
        includedTargets:
            - database: string
              name: string
              schema: string
        serviceAccount: string
        transitiveDependenciesIncluded: false
        transitiveDependentsIncluded: false
    location: string
    project: string
    releaseConfig: string
    repositoryId: string
    timeZone: string
    workflowConfigId: string
WorkflowConfig Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The WorkflowConfig resource accepts the following input properties:
- ReleaseConfig string
- The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.
- RepositoryId string
- WorkflowConfig stringId 
- Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
- CronSchedule string
- Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
- InvocationConfig Pulumi.Google Native. Dataform. V1Beta1. Inputs. Invocation Config 
- Optional. If left unset, a default InvocationConfig will be used.
- Location string
- Project string
- TimeZone string
- Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
- ReleaseConfig string
- The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.
- RepositoryId string
- WorkflowConfig stringId 
- Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
- CronSchedule string
- Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
- InvocationConfig InvocationConfig Args 
- Optional. If left unset, a default InvocationConfig will be used.
- Location string
- Project string
- TimeZone string
- Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
- releaseConfig String
- The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.
- repositoryId String
- workflowConfig StringId 
- Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
- cronSchedule String
- Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
- invocationConfig InvocationConfig 
- Optional. If left unset, a default InvocationConfig will be used.
- location String
- project String
- timeZone String
- Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
- releaseConfig string
- The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.
- repositoryId string
- workflowConfig stringId 
- Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
- cronSchedule string
- Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
- invocationConfig InvocationConfig 
- Optional. If left unset, a default InvocationConfig will be used.
- location string
- project string
- timeZone string
- Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
- release_config str
- The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.
- repository_id str
- workflow_config_ strid 
- Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
- cron_schedule str
- Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
- invocation_config InvocationConfig Args 
- Optional. If left unset, a default InvocationConfig will be used.
- location str
- project str
- time_zone str
- Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
- releaseConfig String
- The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.
- repositoryId String
- workflowConfig StringId 
- Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
- cronSchedule String
- Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
- invocationConfig Property Map
- Optional. If left unset, a default InvocationConfig will be used.
- location String
- project String
- timeZone String
- Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
Outputs
All input properties are implicitly available as output properties. Additionally, the WorkflowConfig resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The workflow config's name.
- RecentScheduled List<Pulumi.Execution Records Google Native. Dataform. V1Beta1. Outputs. Scheduled Execution Record Response> 
- Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The workflow config's name.
- RecentScheduled []ScheduledExecution Records Execution Record Response 
- Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The workflow config's name.
- recentScheduled List<ScheduledExecution Records Execution Record Response> 
- Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The workflow config's name.
- recentScheduled ScheduledExecution Records Execution Record Response[] 
- Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The workflow config's name.
- recent_scheduled_ Sequence[Scheduledexecution_ records Execution Record Response] 
- Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The workflow config's name.
- recentScheduled List<Property Map>Execution Records 
- Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
Supporting Types
InvocationConfig, InvocationConfigArgs    
- FullyRefresh boolIncremental Tables Enabled 
- Optional. When set to true, any incremental tables will be fully refreshed.
- List<string>
- Optional. The set of tags to include.
- IncludedTargets List<Pulumi.Google Native. Dataform. V1Beta1. Inputs. Target> 
- Optional. The set of action identifiers to include.
- ServiceAccount string
- Optional. The service account to run workflow invocations under.
- TransitiveDependencies boolIncluded 
- Optional. When set to true, transitive dependencies of included actions will be executed.
- TransitiveDependents boolIncluded 
- Optional. When set to true, transitive dependents of included actions will be executed.
- FullyRefresh boolIncremental Tables Enabled 
- Optional. When set to true, any incremental tables will be fully refreshed.
- []string
- Optional. The set of tags to include.
- IncludedTargets []Target
- Optional. The set of action identifiers to include.
- ServiceAccount string
- Optional. The service account to run workflow invocations under.
- TransitiveDependencies boolIncluded 
- Optional. When set to true, transitive dependencies of included actions will be executed.
- TransitiveDependents boolIncluded 
- Optional. When set to true, transitive dependents of included actions will be executed.
- fullyRefresh BooleanIncremental Tables Enabled 
- Optional. When set to true, any incremental tables will be fully refreshed.
- List<String>
- Optional. The set of tags to include.
- includedTargets List<Target>
- Optional. The set of action identifiers to include.
- serviceAccount String
- Optional. The service account to run workflow invocations under.
- transitiveDependencies BooleanIncluded 
- Optional. When set to true, transitive dependencies of included actions will be executed.
- transitiveDependents BooleanIncluded 
- Optional. When set to true, transitive dependents of included actions will be executed.
- fullyRefresh booleanIncremental Tables Enabled 
- Optional. When set to true, any incremental tables will be fully refreshed.
- string[]
- Optional. The set of tags to include.
- includedTargets Target[]
- Optional. The set of action identifiers to include.
- serviceAccount string
- Optional. The service account to run workflow invocations under.
- transitiveDependencies booleanIncluded 
- Optional. When set to true, transitive dependencies of included actions will be executed.
- transitiveDependents booleanIncluded 
- Optional. When set to true, transitive dependents of included actions will be executed.
- fully_refresh_ boolincremental_ tables_ enabled 
- Optional. When set to true, any incremental tables will be fully refreshed.
- Sequence[str]
- Optional. The set of tags to include.
- included_targets Sequence[Target]
- Optional. The set of action identifiers to include.
- service_account str
- Optional. The service account to run workflow invocations under.
- transitive_dependencies_ boolincluded 
- Optional. When set to true, transitive dependencies of included actions will be executed.
- transitive_dependents_ boolincluded 
- Optional. When set to true, transitive dependents of included actions will be executed.
- fullyRefresh BooleanIncremental Tables Enabled 
- Optional. When set to true, any incremental tables will be fully refreshed.
- List<String>
- Optional. The set of tags to include.
- includedTargets List<Property Map>
- Optional. The set of action identifiers to include.
- serviceAccount String
- Optional. The service account to run workflow invocations under.
- transitiveDependencies BooleanIncluded 
- Optional. When set to true, transitive dependencies of included actions will be executed.
- transitiveDependents BooleanIncluded 
- Optional. When set to true, transitive dependents of included actions will be executed.
InvocationConfigResponse, InvocationConfigResponseArgs      
- FullyRefresh boolIncremental Tables Enabled 
- Optional. When set to true, any incremental tables will be fully refreshed.
- List<string>
- Optional. The set of tags to include.
- IncludedTargets List<Pulumi.Google Native. Dataform. V1Beta1. Inputs. Target Response> 
- Optional. The set of action identifiers to include.
- ServiceAccount string
- Optional. The service account to run workflow invocations under.
- TransitiveDependencies boolIncluded 
- Optional. When set to true, transitive dependencies of included actions will be executed.
- TransitiveDependents boolIncluded 
- Optional. When set to true, transitive dependents of included actions will be executed.
- FullyRefresh boolIncremental Tables Enabled 
- Optional. When set to true, any incremental tables will be fully refreshed.
- []string
- Optional. The set of tags to include.
- IncludedTargets []TargetResponse 
- Optional. The set of action identifiers to include.
- ServiceAccount string
- Optional. The service account to run workflow invocations under.
- TransitiveDependencies boolIncluded 
- Optional. When set to true, transitive dependencies of included actions will be executed.
- TransitiveDependents boolIncluded 
- Optional. When set to true, transitive dependents of included actions will be executed.
- fullyRefresh BooleanIncremental Tables Enabled 
- Optional. When set to true, any incremental tables will be fully refreshed.
- List<String>
- Optional. The set of tags to include.
- includedTargets List<TargetResponse> 
- Optional. The set of action identifiers to include.
- serviceAccount String
- Optional. The service account to run workflow invocations under.
- transitiveDependencies BooleanIncluded 
- Optional. When set to true, transitive dependencies of included actions will be executed.
- transitiveDependents BooleanIncluded 
- Optional. When set to true, transitive dependents of included actions will be executed.
- fullyRefresh booleanIncremental Tables Enabled 
- Optional. When set to true, any incremental tables will be fully refreshed.
- string[]
- Optional. The set of tags to include.
- includedTargets TargetResponse[] 
- Optional. The set of action identifiers to include.
- serviceAccount string
- Optional. The service account to run workflow invocations under.
- transitiveDependencies booleanIncluded 
- Optional. When set to true, transitive dependencies of included actions will be executed.
- transitiveDependents booleanIncluded 
- Optional. When set to true, transitive dependents of included actions will be executed.
- fully_refresh_ boolincremental_ tables_ enabled 
- Optional. When set to true, any incremental tables will be fully refreshed.
- Sequence[str]
- Optional. The set of tags to include.
- included_targets Sequence[TargetResponse] 
- Optional. The set of action identifiers to include.
- service_account str
- Optional. The service account to run workflow invocations under.
- transitive_dependencies_ boolincluded 
- Optional. When set to true, transitive dependencies of included actions will be executed.
- transitive_dependents_ boolincluded 
- Optional. When set to true, transitive dependents of included actions will be executed.
- fullyRefresh BooleanIncremental Tables Enabled 
- Optional. When set to true, any incremental tables will be fully refreshed.
- List<String>
- Optional. The set of tags to include.
- includedTargets List<Property Map>
- Optional. The set of action identifiers to include.
- serviceAccount String
- Optional. The service account to run workflow invocations under.
- transitiveDependencies BooleanIncluded 
- Optional. When set to true, transitive dependencies of included actions will be executed.
- transitiveDependents BooleanIncluded 
- Optional. When set to true, transitive dependents of included actions will be executed.
ScheduledExecutionRecordResponse, ScheduledExecutionRecordResponseArgs        
- ErrorStatus Pulumi.Google Native. Dataform. V1Beta1. Inputs. Status Response 
- The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
- ExecutionTime string
- The timestamp of this execution attempt.
- WorkflowInvocation string
- The name of the created workflow invocation, if one was successfully created. Must be in the format projects/*/locations/*/repositories/*/workflowInvocations/*.
- ErrorStatus StatusResponse 
- The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
- ExecutionTime string
- The timestamp of this execution attempt.
- WorkflowInvocation string
- The name of the created workflow invocation, if one was successfully created. Must be in the format projects/*/locations/*/repositories/*/workflowInvocations/*.
- errorStatus StatusResponse 
- The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
- executionTime String
- The timestamp of this execution attempt.
- workflowInvocation String
- The name of the created workflow invocation, if one was successfully created. Must be in the format projects/*/locations/*/repositories/*/workflowInvocations/*.
- errorStatus StatusResponse 
- The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
- executionTime string
- The timestamp of this execution attempt.
- workflowInvocation string
- The name of the created workflow invocation, if one was successfully created. Must be in the format projects/*/locations/*/repositories/*/workflowInvocations/*.
- error_status StatusResponse 
- The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
- execution_time str
- The timestamp of this execution attempt.
- workflow_invocation str
- The name of the created workflow invocation, if one was successfully created. Must be in the format projects/*/locations/*/repositories/*/workflowInvocations/*.
- errorStatus Property Map
- The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
- executionTime String
- The timestamp of this execution attempt.
- workflowInvocation String
- The name of the created workflow invocation, if one was successfully created. Must be in the format projects/*/locations/*/repositories/*/workflowInvocations/*.
StatusResponse, StatusResponseArgs    
- Code int
- The status code, which should be an enum value of google.rpc.Code.
- Details
List<ImmutableDictionary<string, string>> 
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message string
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- Code int
- The status code, which should be an enum value of google.rpc.Code.
- Details []map[string]string
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message string
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code Integer
- The status code, which should be an enum value of google.rpc.Code.
- details List<Map<String,String>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message String
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code number
- The status code, which should be an enum value of google.rpc.Code.
- details {[key: string]: string}[]
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message string
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code int
- The status code, which should be an enum value of google.rpc.Code.
- details Sequence[Mapping[str, str]]
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message str
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code Number
- The status code, which should be an enum value of google.rpc.Code.
- details List<Map<String>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message String
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Target, TargetArgs  
TargetResponse, TargetResponseArgs    
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.