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:
- Release
Config string - The name of the release config whose release_compilation_result should be executed. Must be in the format
projects/*/locations/*/repositories/*/releaseConfigs/*
. - Repository
Id string - Workflow
Config stringId - Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
- Cron
Schedule string - Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
- Invocation
Config Pulumi.Google Native. Dataform. V1Beta1. Inputs. Invocation Config - Optional. If left unset, a default InvocationConfig will be used.
- Location string
- Project string
- Time
Zone 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 string - The name of the release config whose release_compilation_result should be executed. Must be in the format
projects/*/locations/*/repositories/*/releaseConfigs/*
. - Repository
Id string - Workflow
Config stringId - Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
- Cron
Schedule string - 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 string
- Project string
- Time
Zone 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 String - The name of the release config whose release_compilation_result should be executed. Must be in the format
projects/*/locations/*/repositories/*/releaseConfigs/*
. - repository
Id String - workflow
Config StringId - Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
- cron
Schedule String - Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
- invocation
Config InvocationConfig - Optional. If left unset, a default InvocationConfig will be used.
- location String
- project String
- time
Zone 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 string - The name of the release config whose release_compilation_result should be executed. Must be in the format
projects/*/locations/*/repositories/*/releaseConfigs/*
. - repository
Id string - workflow
Config stringId - Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
- cron
Schedule string - Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
- invocation
Config InvocationConfig - Optional. If left unset, a default InvocationConfig will be used.
- location string
- project string
- time
Zone 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.
- release
Config String - The name of the release config whose release_compilation_result should be executed. Must be in the format
projects/*/locations/*/repositories/*/releaseConfigs/*
. - repository
Id String - workflow
Config StringId - Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
- cron
Schedule String - Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
- invocation
Config Property Map - Optional. If left unset, a default InvocationConfig will be used.
- location String
- project String
- time
Zone 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.
- Recent
Scheduled 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.
- Recent
Scheduled []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.
- recent
Scheduled 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.
- recent
Scheduled 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.
- recent
Scheduled 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
- Fully
Refresh boolIncremental Tables Enabled - Optional. When set to true, any incremental tables will be fully refreshed.
- List<string>
- Optional. The set of tags to include.
- Included
Targets List<Pulumi.Google Native. Dataform. V1Beta1. Inputs. Target> - Optional. The set of action identifiers to include.
- Service
Account string - 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.
- Fully
Refresh boolIncremental Tables Enabled - Optional. When set to true, any incremental tables will be fully refreshed.
- []string
- Optional. The set of tags to include.
- Included
Targets []Target - Optional. The set of action identifiers to include.
- Service
Account string - 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.
- fully
Refresh BooleanIncremental Tables Enabled - Optional. When set to true, any incremental tables will be fully refreshed.
- List<String>
- Optional. The set of tags to include.
- included
Targets List<Target> - Optional. The set of action identifiers to include.
- service
Account String - Optional. The service account to run workflow invocations under.
- transitive
Dependencies BooleanIncluded - Optional. When set to true, transitive dependencies of included actions will be executed.
- transitive
Dependents BooleanIncluded - Optional. When set to true, transitive dependents of included actions will be executed.
- fully
Refresh booleanIncremental Tables Enabled - Optional. When set to true, any incremental tables will be fully refreshed.
- string[]
- Optional. The set of tags to include.
- included
Targets Target[] - Optional. The set of action identifiers to include.
- service
Account string - Optional. The service account to run workflow invocations under.
- transitive
Dependencies booleanIncluded - Optional. When set to true, transitive dependencies of included actions will be executed.
- transitive
Dependents 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.
- fully
Refresh BooleanIncremental Tables Enabled - Optional. When set to true, any incremental tables will be fully refreshed.
- List<String>
- Optional. The set of tags to include.
- included
Targets List<Property Map> - Optional. The set of action identifiers to include.
- service
Account String - Optional. The service account to run workflow invocations under.
- transitive
Dependencies BooleanIncluded - Optional. When set to true, transitive dependencies of included actions will be executed.
- transitive
Dependents BooleanIncluded - Optional. When set to true, transitive dependents of included actions will be executed.
InvocationConfigResponse, InvocationConfigResponseArgs
- Fully
Refresh boolIncremental Tables Enabled - Optional. When set to true, any incremental tables will be fully refreshed.
- List<string>
- Optional. The set of tags to include.
- Included
Targets List<Pulumi.Google Native. Dataform. V1Beta1. Inputs. Target Response> - Optional. The set of action identifiers to include.
- Service
Account string - 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.
- Fully
Refresh boolIncremental Tables Enabled - Optional. When set to true, any incremental tables will be fully refreshed.
- []string
- Optional. The set of tags to include.
- Included
Targets []TargetResponse - Optional. The set of action identifiers to include.
- Service
Account string - 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.
- fully
Refresh BooleanIncremental Tables Enabled - Optional. When set to true, any incremental tables will be fully refreshed.
- List<String>
- Optional. The set of tags to include.
- included
Targets List<TargetResponse> - Optional. The set of action identifiers to include.
- service
Account String - Optional. The service account to run workflow invocations under.
- transitive
Dependencies BooleanIncluded - Optional. When set to true, transitive dependencies of included actions will be executed.
- transitive
Dependents BooleanIncluded - Optional. When set to true, transitive dependents of included actions will be executed.
- fully
Refresh booleanIncremental Tables Enabled - Optional. When set to true, any incremental tables will be fully refreshed.
- string[]
- Optional. The set of tags to include.
- included
Targets TargetResponse[] - Optional. The set of action identifiers to include.
- service
Account string - Optional. The service account to run workflow invocations under.
- transitive
Dependencies booleanIncluded - Optional. When set to true, transitive dependencies of included actions will be executed.
- transitive
Dependents 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.
- fully
Refresh BooleanIncremental Tables Enabled - Optional. When set to true, any incremental tables will be fully refreshed.
- List<String>
- Optional. The set of tags to include.
- included
Targets List<Property Map> - Optional. The set of action identifiers to include.
- service
Account String - Optional. The service account to run workflow invocations under.
- transitive
Dependencies BooleanIncluded - Optional. When set to true, transitive dependencies of included actions will be executed.
- transitive
Dependents BooleanIncluded - Optional. When set to true, transitive dependents of included actions will be executed.
ScheduledExecutionRecordResponse, ScheduledExecutionRecordResponseArgs
- Error
Status 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.
- Execution
Time string - The timestamp of this execution attempt.
- Workflow
Invocation 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 string - The timestamp of this execution attempt.
- Workflow
Invocation 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 String - The timestamp of this execution attempt.
- workflow
Invocation 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 string - The timestamp of this execution attempt.
- workflow
Invocation 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/*
.
- error
Status Property Map - The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
- execution
Time String - The timestamp of this execution attempt.
- workflow
Invocation 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<Immutable
Dictionary<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.