Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. workflows
  5. workflows/v1beta
  6. Workflow

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.workflows/v1beta.Workflow

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation will return ALREADY_EXISTS error.

    Create Workflow Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Workflow(name: string, args: WorkflowArgs, opts?: CustomResourceOptions);
    @overload
def Workflow(resource_name: str,
             args: WorkflowArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Workflow(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             workflow_id: Optional[str] = None,
             description: Optional[str] = None,
             labels: Optional[Mapping[str, str]] = None,
             location: Optional[str] = None,
             name: Optional[str] = None,
             project: Optional[str] = None,
             service_account: Optional[str] = None,
             source_contents: Optional[str] = None)
    func NewWorkflow(ctx *Context, name string, args WorkflowArgs, opts ...ResourceOption) (*Workflow, error)
    public Workflow(string name, WorkflowArgs args, CustomResourceOptions? opts = null)
    public Workflow(String name, WorkflowArgs args)
public Workflow(String name, WorkflowArgs args, CustomResourceOptions options)

    type: google-native:workflows/v1beta:Workflow
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 WorkflowArgs
    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 WorkflowArgs
    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 WorkflowArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var google_nativeWorkflowResource = new GoogleNative.Workflows.V1Beta.Workflow("google-nativeWorkflowResource", new()
{
    WorkflowId = "string",
    Description = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    Name = "string",
    Project = "string",
    ServiceAccount = "string",
    SourceContents = "string",
});

    example, err := workflowsv1beta.NewWorkflow(ctx, "google-nativeWorkflowResource", &workflowsv1beta.WorkflowArgs{
WorkflowId: pulumi.String("string"),
Description: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Project: pulumi.String("string"),
ServiceAccount: pulumi.String("string"),
SourceContents: pulumi.String("string"),
})

    var google_nativeWorkflowResource = new Workflow("google-nativeWorkflowResource", WorkflowArgs.builder()        
    .workflowId("string")
    .description("string")
    .labels(Map.of("string", "string"))
    .location("string")
    .name("string")
    .project("string")
    .serviceAccount("string")
    .sourceContents("string")
    .build());

    google_native_workflow_resource = google_native.workflows.v1beta.Workflow("google-nativeWorkflowResource",
    workflow_id="string",
    description="string",
    labels={
        "string": "string",
    },
    location="string",
    name="string",
    project="string",
    service_account="string",
    source_contents="string")

    const google_nativeWorkflowResource = new google_native.workflows.v1beta.Workflow("google-nativeWorkflowResource", {
    workflowId: "string",
    description: "string",
    labels: {
        string: "string",
    },
    location: "string",
    name: "string",
    project: "string",
    serviceAccount: "string",
    sourceContents: "string",
});

    type: google-native:workflows/v1beta:Workflow
properties:
    description: string
    labels:
        string: string
    location: string
    name: string
    project: string
    serviceAccount: string
    sourceContents: string
    workflowId: string

    Workflow Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Workflow resource accepts the following input properties:

    WorkflowId string
    Required. The ID of the workflow to be created. It has to fulfill the following requirements: * Must contain only letters, numbers, underscores and hyphens. * Must start with a letter. * Must be between 1-64 characters. * Must end with a number or a letter. * Must be unique within the customer project and location.
    Description string
    Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
    Labels Dictionary<string, string>
    Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores and dashes. Label keys must start with a letter. International characters are allowed.
    Location string
    Name string
    The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}
    Project string
    ServiceAccount string
    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.
    SourceContents string
    Workflow code to be executed. The size limit is 128KB.
    WorkflowId string
    Required. The ID of the workflow to be created. It has to fulfill the following requirements: * Must contain only letters, numbers, underscores and hyphens. * Must start with a letter. * Must be between 1-64 characters. * Must end with a number or a letter. * Must be unique within the customer project and location.
    Description string
    Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
    Labels map[string]string
    Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores and dashes. Label keys must start with a letter. International characters are allowed.
    Location string
    Name string
    The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}
    Project string
    ServiceAccount string
    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.
    SourceContents string
    Workflow code to be executed. The size limit is 128KB.
    workflowId String
    Required. The ID of the workflow to be created. It has to fulfill the following requirements: * Must contain only letters, numbers, underscores and hyphens. * Must start with a letter. * Must be between 1-64 characters. * Must end with a number or a letter. * Must be unique within the customer project and location.
    description String
    Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
    labels Map<String,String>
    Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores and dashes. Label keys must start with a letter. International characters are allowed.
    location String
    name String
    The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}
    project String
    serviceAccount String
    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.
    sourceContents String
    Workflow code to be executed. The size limit is 128KB.
    workflowId string
    Required. The ID of the workflow to be created. It has to fulfill the following requirements: * Must contain only letters, numbers, underscores and hyphens. * Must start with a letter. * Must be between 1-64 characters. * Must end with a number or a letter. * Must be unique within the customer project and location.
    description string
    Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
    labels {[key: string]: string}
    Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores and dashes. Label keys must start with a letter. International characters are allowed.
    location string
    name string
    The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}
    project string
    serviceAccount string
    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.
    sourceContents string
    Workflow code to be executed. The size limit is 128KB.
    workflow_id str
    Required. The ID of the workflow to be created. It has to fulfill the following requirements: * Must contain only letters, numbers, underscores and hyphens. * Must start with a letter. * Must be between 1-64 characters. * Must end with a number or a letter. * Must be unique within the customer project and location.
    description str
    Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
    labels Mapping[str, str]
    Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores and dashes. Label keys must start with a letter. International characters are allowed.
    location str
    name str
    The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}
    project str
    service_account str
    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.
    source_contents str
    Workflow code to be executed. The size limit is 128KB.
    workflowId String
    Required. The ID of the workflow to be created. It has to fulfill the following requirements: * Must contain only letters, numbers, underscores and hyphens. * Must start with a letter. * Must be between 1-64 characters. * Must end with a number or a letter. * Must be unique within the customer project and location.
    description String
    Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
    labels Map<String>
    Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores and dashes. Label keys must start with a letter. International characters are allowed.
    location String
    name String
    The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}
    project String
    serviceAccount String
    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.
    sourceContents String
    Workflow code to be executed. The size limit is 128KB.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Workflow resource produces the following output properties:

    CreateTime string
    The timestamp of when the workflow was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    RevisionCreateTime string
    The timestamp that the latest revision of the workflow was created.
    RevisionId string
    The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 hexadecimal random characters.
    State string
    State of the workflow deployment.
    UpdateTime string
    The last update timestamp of the workflow.
    CreateTime string
    The timestamp of when the workflow was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    RevisionCreateTime string
    The timestamp that the latest revision of the workflow was created.
    RevisionId string
    The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 hexadecimal random characters.
    State string
    State of the workflow deployment.
    UpdateTime string
    The last update timestamp of the workflow.
    createTime String
    The timestamp of when the workflow was created.
    id String
    The provider-assigned unique ID for this managed resource.
    revisionCreateTime String
    The timestamp that the latest revision of the workflow was created.
    revisionId String
    The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 hexadecimal random characters.
    state String
    State of the workflow deployment.
    updateTime String
    The last update timestamp of the workflow.
    createTime string
    The timestamp of when the workflow was created.
    id string
    The provider-assigned unique ID for this managed resource.
    revisionCreateTime string
    The timestamp that the latest revision of the workflow was created.
    revisionId string
    The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 hexadecimal random characters.
    state string
    State of the workflow deployment.
    updateTime string
    The last update timestamp of the workflow.
    create_time str
    The timestamp of when the workflow was created.
    id str
    The provider-assigned unique ID for this managed resource.
    revision_create_time str
    The timestamp that the latest revision of the workflow was created.
    revision_id str
    The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 hexadecimal random characters.
    state str
    State of the workflow deployment.
    update_time str
    The last update timestamp of the workflow.
    createTime String
    The timestamp of when the workflow was created.
    id String
    The provider-assigned unique ID for this managed resource.
    revisionCreateTime String
    The timestamp that the latest revision of the workflow was created.
    revisionId String
    The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 hexadecimal random characters.
    state String
    State of the workflow deployment.
    updateTime String
    The last update timestamp of the workflow.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native