published on Wednesday, Nov 18, 2026 by Pulumi
published on Wednesday, Nov 18, 2026 by Pulumi
An instance of a machine learning PipelineJob. A PipelineJob runs a pipeline created using Kubeflow Pipelines or Vertex AI Pipelines.
To get more information about PipelineJob, see:
- API documentation
- How-to Guides
Example Usage
Vertex Ai Pipeline Job Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const bucket = new gcp.storage.Bucket("bucket", {
name: "example-pipeline-bucket",
location: "us-central1",
uniformBucketLevelAccess: true,
forceDestroy: true,
});
const pipelineJob = new gcp.vertex.AiPipelineJob("pipeline_job", {
displayName: "example-pipeline-job",
pipelineJobId: "example-pipeline-job",
region: "us-central1",
preflightValidations: false,
deletionPolicy: "FORCE",
pipelineSpec: JSON.stringify({
components: {
"comp-hello-world": {
executorLabel: "exec-hello-world",
inputDefinitions: {
parameters: {
text: {
parameterType: "STRING",
},
},
},
},
},
deploymentSpec: {
executors: {
"exec-hello-world": {
container: {
args: [
"--text",
"{{$.inputs.parameters['text']}}",
],
command: [
"sh",
"-c",
"echo \"$0\"",
],
image: "python:3.11",
},
},
},
},
pipelineInfo: {
name: "hello-world-pipeline",
},
root: {
dag: {
tasks: {
"hello-world": {
cachingOptions: {
enableCache: true,
},
componentRef: {
name: "comp-hello-world",
},
inputs: {
parameters: {
text: {
componentInputParameter: "text",
},
},
},
taskInfo: {
name: "hello-world",
},
},
},
},
inputDefinitions: {
parameters: {
text: {
defaultValue: "Hello World",
isOptional: true,
parameterType: "STRING",
},
},
},
},
schemaVersion: "2.1.0",
sdkVersion: "kfp-2.7.0",
}),
runtimeConfig: {
gcsOutputDirectory: pulumi.interpolate`gs://${bucket.name}/output`,
failurePolicy: "PIPELINE_FAILURE_POLICY_FAIL_FAST",
parameterValues: {
text: "Hello Vertex AI",
},
},
labels: {
env: "test",
},
});
import pulumi
import json
import pulumi_gcp as gcp
bucket = gcp.storage.Bucket("bucket",
name="example-pipeline-bucket",
location="us-central1",
uniform_bucket_level_access=True,
force_destroy=True)
pipeline_job = gcp.vertex.AiPipelineJob("pipeline_job",
display_name="example-pipeline-job",
pipeline_job_id="example-pipeline-job",
region="us-central1",
preflight_validations=False,
deletion_policy="FORCE",
pipeline_spec=json.dumps({
"components": {
"comp-hello-world": {
"executorLabel": "exec-hello-world",
"inputDefinitions": {
"parameters": {
"text": {
"parameterType": "STRING",
},
},
},
},
},
"deploymentSpec": {
"executors": {
"exec-hello-world": {
"container": {
"args": [
"--text",
"{{$.inputs.parameters['text']}}",
],
"command": [
"sh",
"-c",
"echo \"$0\"",
],
"image": "python:3.11",
},
},
},
},
"pipelineInfo": {
"name": "hello-world-pipeline",
},
"root": {
"dag": {
"tasks": {
"hello-world": {
"cachingOptions": {
"enableCache": True,
},
"componentRef": {
"name": "comp-hello-world",
},
"inputs": {
"parameters": {
"text": {
"componentInputParameter": "text",
},
},
},
"taskInfo": {
"name": "hello-world",
},
},
},
},
"inputDefinitions": {
"parameters": {
"text": {
"defaultValue": "Hello World",
"isOptional": True,
"parameterType": "STRING",
},
},
},
},
"schemaVersion": "2.1.0",
"sdkVersion": "kfp-2.7.0",
}),
runtime_config={
"gcs_output_directory": bucket.name.apply(lambda name: f"gs://{name}/output"),
"failure_policy": "PIPELINE_FAILURE_POLICY_FAIL_FAST",
"parameter_values": {
"text": "Hello Vertex AI",
},
},
labels={
"env": "test",
})
package main
import (
"encoding/json"
"fmt"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/storage"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/vertex"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
bucket, err := storage.NewBucket(ctx, "bucket", &storage.BucketArgs{
Name: pulumi.String("example-pipeline-bucket"),
Location: pulumi.String("us-central1"),
UniformBucketLevelAccess: pulumi.Bool(true),
ForceDestroy: pulumi.Bool(true),
})
if err != nil {
return err
}
tmpJSON0, err := json.Marshal(map[string]interface{}{
"components": map[string]map[string]interface{}{
"comp-hello-world": map[string]interface{}{
"executorLabel": "exec-hello-world",
"inputDefinitions": map[string]map[string]map[string]string{
"parameters": map[string]map[string]string{
"text": map[string]string{
"parameterType": "STRING",
},
},
},
},
},
"deploymentSpec": map[string]map[string]map[string]map[string]interface{}{
"executors": map[string]map[string]map[string]interface{}{
"exec-hello-world": map[string]map[string]interface{}{
"container": map[string]interface{}{
"args": []string{
"--text",
"{{$.inputs.parameters['text']}}",
},
"command": []string{
"sh",
"-c",
"echo \"$0\"",
},
"image": "python:3.11",
},
},
},
},
"pipelineInfo": map[string]string{
"name": "hello-world-pipeline",
},
"root": map[string]map[string]map[string]map[string]interface{}{
"dag": map[string]map[string]map[string]interface{}{
"tasks": map[string]map[string]interface{}{
"hello-world": map[string]interface{}{
"cachingOptions": map[string]bool{
"enableCache": true,
},
"componentRef": map[string]string{
"name": "comp-hello-world",
},
"inputs": map[string]map[string]map[string]string{
"parameters": map[string]map[string]string{
"text": map[string]string{
"componentInputParameter": "text",
},
},
},
"taskInfo": map[string]string{
"name": "hello-world",
},
},
},
},
"inputDefinitions": map[string]map[string]map[string]interface{}{
"parameters": map[string]map[string]interface{}{
"text": map[string]interface{}{
"defaultValue": "Hello World",
"isOptional": true,
"parameterType": "STRING",
},
},
},
},
"schemaVersion": "2.1.0",
"sdkVersion": "kfp-2.7.0",
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = vertex.NewAiPipelineJob(ctx, "pipeline_job", &vertex.AiPipelineJobArgs{
DisplayName: pulumi.String("example-pipeline-job"),
PipelineJobId: pulumi.String("example-pipeline-job"),
Region: pulumi.String("us-central1"),
PreflightValidations: pulumi.Bool(false),
DeletionPolicy: pulumi.String("FORCE"),
PipelineSpec: pulumi.String(json0),
RuntimeConfig: &vertex.AiPipelineJobRuntimeConfigArgs{
GcsOutputDirectory: bucket.Name.ApplyT(func(name string) (string, error) {
return fmt.Sprintf("gs://%v/output", name), nil
}).(pulumi.StringOutput),
FailurePolicy: pulumi.String("PIPELINE_FAILURE_POLICY_FAIL_FAST"),
ParameterValues: pulumi.StringMap{
"text": pulumi.String("Hello Vertex AI"),
},
},
Labels: pulumi.StringMap{
"env": pulumi.String("test"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var bucket = new Gcp.Storage.Bucket("bucket", new()
{
Name = "example-pipeline-bucket",
Location = "us-central1",
UniformBucketLevelAccess = true,
ForceDestroy = true,
});
var pipelineJob = new Gcp.Vertex.AiPipelineJob("pipeline_job", new()
{
DisplayName = "example-pipeline-job",
PipelineJobId = "example-pipeline-job",
Region = "us-central1",
PreflightValidations = false,
DeletionPolicy = "FORCE",
PipelineSpec = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["components"] = new Dictionary<string, object?>
{
["comp-hello-world"] = new Dictionary<string, object?>
{
["executorLabel"] = "exec-hello-world",
["inputDefinitions"] = new Dictionary<string, object?>
{
["parameters"] = new Dictionary<string, object?>
{
["text"] = new Dictionary<string, object?>
{
["parameterType"] = "STRING",
},
},
},
},
},
["deploymentSpec"] = new Dictionary<string, object?>
{
["executors"] = new Dictionary<string, object?>
{
["exec-hello-world"] = new Dictionary<string, object?>
{
["container"] = new Dictionary<string, object?>
{
["args"] = new[]
{
"--text",
"{{$.inputs.parameters['text']}}",
},
["command"] = new[]
{
"sh",
"-c",
"echo \"$0\"",
},
["image"] = "python:3.11",
},
},
},
},
["pipelineInfo"] = new Dictionary<string, object?>
{
["name"] = "hello-world-pipeline",
},
["root"] = new Dictionary<string, object?>
{
["dag"] = new Dictionary<string, object?>
{
["tasks"] = new Dictionary<string, object?>
{
["hello-world"] = new Dictionary<string, object?>
{
["cachingOptions"] = new Dictionary<string, object?>
{
["enableCache"] = true,
},
["componentRef"] = new Dictionary<string, object?>
{
["name"] = "comp-hello-world",
},
["inputs"] = new Dictionary<string, object?>
{
["parameters"] = new Dictionary<string, object?>
{
["text"] = new Dictionary<string, object?>
{
["componentInputParameter"] = "text",
},
},
},
["taskInfo"] = new Dictionary<string, object?>
{
["name"] = "hello-world",
},
},
},
},
["inputDefinitions"] = new Dictionary<string, object?>
{
["parameters"] = new Dictionary<string, object?>
{
["text"] = new Dictionary<string, object?>
{
["defaultValue"] = "Hello World",
["isOptional"] = true,
["parameterType"] = "STRING",
},
},
},
},
["schemaVersion"] = "2.1.0",
["sdkVersion"] = "kfp-2.7.0",
}),
RuntimeConfig = new Gcp.Vertex.Inputs.AiPipelineJobRuntimeConfigArgs
{
GcsOutputDirectory = bucket.Name.Apply(name => $"gs://{name}/output"),
FailurePolicy = "PIPELINE_FAILURE_POLICY_FAIL_FAST",
ParameterValues =
{
{ "text", "Hello Vertex AI" },
},
},
Labels =
{
{ "env", "test" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.storage.Bucket;
import com.pulumi.gcp.storage.BucketArgs;
import com.pulumi.gcp.vertex.AiPipelineJob;
import com.pulumi.gcp.vertex.AiPipelineJobArgs;
import com.pulumi.gcp.vertex.inputs.AiPipelineJobRuntimeConfigArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var bucket = new Bucket("bucket", BucketArgs.builder()
.name("example-pipeline-bucket")
.location("us-central1")
.uniformBucketLevelAccess(true)
.forceDestroy(true)
.build());
var pipelineJob = new AiPipelineJob("pipelineJob", AiPipelineJobArgs.builder()
.displayName("example-pipeline-job")
.pipelineJobId("example-pipeline-job")
.region("us-central1")
.preflightValidations(false)
.deletionPolicy("FORCE")
.pipelineSpec(serializeJson(
jsonObject(
jsonProperty("components", jsonObject(
jsonProperty("comp-hello-world", jsonObject(
jsonProperty("executorLabel", "exec-hello-world"),
jsonProperty("inputDefinitions", jsonObject(
jsonProperty("parameters", jsonObject(
jsonProperty("text", jsonObject(
jsonProperty("parameterType", "STRING")
))
))
))
))
)),
jsonProperty("deploymentSpec", jsonObject(
jsonProperty("executors", jsonObject(
jsonProperty("exec-hello-world", jsonObject(
jsonProperty("container", jsonObject(
jsonProperty("args", jsonArray(
"--text",
"{{$.inputs.parameters['text']}}"
)),
jsonProperty("command", jsonArray(
"sh",
"-c",
"echo \"$0\""
)),
jsonProperty("image", "python:3.11")
))
))
))
)),
jsonProperty("pipelineInfo", jsonObject(
jsonProperty("name", "hello-world-pipeline")
)),
jsonProperty("root", jsonObject(
jsonProperty("dag", jsonObject(
jsonProperty("tasks", jsonObject(
jsonProperty("hello-world", jsonObject(
jsonProperty("cachingOptions", jsonObject(
jsonProperty("enableCache", true)
)),
jsonProperty("componentRef", jsonObject(
jsonProperty("name", "comp-hello-world")
)),
jsonProperty("inputs", jsonObject(
jsonProperty("parameters", jsonObject(
jsonProperty("text", jsonObject(
jsonProperty("componentInputParameter", "text")
))
))
)),
jsonProperty("taskInfo", jsonObject(
jsonProperty("name", "hello-world")
))
))
))
)),
jsonProperty("inputDefinitions", jsonObject(
jsonProperty("parameters", jsonObject(
jsonProperty("text", jsonObject(
jsonProperty("defaultValue", "Hello World"),
jsonProperty("isOptional", true),
jsonProperty("parameterType", "STRING")
))
))
))
)),
jsonProperty("schemaVersion", "2.1.0"),
jsonProperty("sdkVersion", "kfp-2.7.0")
)))
.runtimeConfig(AiPipelineJobRuntimeConfigArgs.builder()
.gcsOutputDirectory(bucket.name().applyValue(_name -> String.format("gs://%s/output", _name)))
.failurePolicy("PIPELINE_FAILURE_POLICY_FAIL_FAST")
.parameterValues(Map.of("text", "Hello Vertex AI"))
.build())
.labels(Map.of("env", "test"))
.build());
}
}
resources:
bucket:
type: gcp:storage:Bucket
properties:
name: example-pipeline-bucket
location: us-central1
uniformBucketLevelAccess: true
forceDestroy: true
pipelineJob:
type: gcp:vertex:AiPipelineJob
name: pipeline_job
properties:
displayName: example-pipeline-job
pipelineJobId: example-pipeline-job
region: us-central1
preflightValidations: false
deletionPolicy: FORCE
pipelineSpec:
fn::toJSON:
components:
comp-hello-world:
executorLabel: exec-hello-world
inputDefinitions:
parameters:
text:
parameterType: STRING
deploymentSpec:
executors:
exec-hello-world:
container:
args:
- --text
- '{{$.inputs.parameters[''text'']}}'
command:
- sh
- -c
- echo "$0"
image: python:3.11
pipelineInfo:
name: hello-world-pipeline
root:
dag:
tasks:
hello-world:
cachingOptions:
enableCache: true
componentRef:
name: comp-hello-world
inputs:
parameters:
text:
componentInputParameter: text
taskInfo:
name: hello-world
inputDefinitions:
parameters:
text:
defaultValue: Hello World
isOptional: true
parameterType: STRING
schemaVersion: 2.1.0
sdkVersion: kfp-2.7.0
runtimeConfig:
gcsOutputDirectory: gs://${bucket.name}/output
failurePolicy: PIPELINE_FAILURE_POLICY_FAIL_FAST
parameterValues:
text: Hello Vertex AI
labels:
env: test
terraform {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
resource "gcp_storage_bucket" "bucket" {
lifecycle {
create_before_destroy = true
}
name = "example-pipeline-bucket"
location = "us-central1"
uniform_bucket_level_access = true
force_destroy = true
}
resource "gcp_vertex_ai_pipeline_job" "pipeline_job" {
lifecycle {
create_before_destroy = true
}
display_name = "example-pipeline-job"
pipeline_job_id = "example-pipeline-job"
region = "us-central1"
preflight_validations = false
deletion_policy = "FORCE"
pipeline_spec = jsonencode({
"components" = {
"comp-hello-world" = {
"executorLabel" = "exec-hello-world"
"inputDefinitions" = {
"parameters" = {
"text" = {
"parameterType" = "STRING"
}
}
}
}
}
"deploymentSpec" = {
"executors" = {
"exec-hello-world" = {
"container" = {
"args" = ["--text", "{{$.inputs.parameters['text']}}"]
"command" = ["sh", "-c", "echo \"$0\""]
"image" = "python:3.11"
}
}
}
}
"pipelineInfo" = {
"name" = "hello-world-pipeline"
}
"root" = {
"dag" = {
"tasks" = {
"hello-world" = {
"cachingOptions" = {
"enableCache" = true
}
"componentRef" = {
"name" = "comp-hello-world"
}
"inputs" = {
"parameters" = {
"text" = {
"componentInputParameter" = "text"
}
}
}
"taskInfo" = {
"name" = "hello-world"
}
}
}
}
"inputDefinitions" = {
"parameters" = {
"text" = {
"defaultValue" = "Hello World"
"isOptional" = true
"parameterType" = "STRING"
}
}
}
}
"schemaVersion" = "2.1.0"
"sdkVersion" = "kfp-2.7.0"
})
runtime_config = {
gcs_output_directory ="gs://${gcp_storage_bucket.bucket.name}/output"
failure_policy = "PIPELINE_FAILURE_POLICY_FAIL_FAST"
parameter_values = {
"text" = "Hello Vertex AI"
}
}
labels = {
"env" = "test"
}
}
Vertex Ai Pipeline Job Full
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const project = gcp.organizations.getProject({});
const bucket = new gcp.storage.Bucket("bucket", {
name: "example-pipeline-bucket-full",
location: "us-central1",
uniformBucketLevelAccess: true,
forceDestroy: true,
});
const vertexNetwork = new gcp.compute.Network("vertex_network", {
name: "vertex-pipeline-network",
autoCreateSubnetworks: false,
});
const vertexRange = new gcp.compute.GlobalAddress("vertex_range", {
name: "vertex-pipeline-ip-range",
purpose: "VPC_PEERING",
addressType: "INTERNAL",
prefixLength: 24,
network: vertexNetwork.id,
});
const vertexVpcConnection = new gcp.servicenetworking.Connection("vertex_vpc_connection", {
network: vertexNetwork.id,
service: "servicenetworking.googleapis.com",
reservedPeeringRanges: [vertexRange.name],
});
const pscSubnetwork = new gcp.compute.Subnetwork("psc_subnetwork", {
name: "psc-pipeline-subnetwork",
region: "us-central1",
ipCidrRange: "10.0.0.0/16",
network: vertexNetwork.id,
});
const pscAttachment = new gcp.compute.NetworkAttachment("psc_attachment", {
name: "psc-pipeline-attachment",
region: "us-central1",
connectionPreference: "ACCEPT_MANUAL",
subnetworks: [pscSubnetwork.id],
});
const cryptoKey = new gcp.kms.CryptoKeyIAMMember("crypto_key", {
cryptoKeyId: "example-key",
role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
member: project.then(project => `serviceAccount:service-${project.number}@gcp-sa-aiplatform.iam.gserviceaccount.com`),
});
const pipelineJob = new gcp.vertex.AiPipelineJob("pipeline_job", {
displayName: "example-pipeline-job-full",
pipelineJobId: "example-pipeline-job-full",
region: "us-central1",
preflightValidations: false,
deletionPolicy: "FORCE",
serviceAccount: project.then(project => `${project.number}-compute@developer.gserviceaccount.com`),
network: pulumi.all([project, vertexNetwork.name]).apply(([project, name]) => `projects/${project.number}/global/networks/${name}`),
reservedIpRanges: [vertexRange.name],
templateUri: "https://us-kfp.pkg.dev/ml-pipeline/google-cloud-registry/hello-world/sha256:1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
pipelineSpec: JSON.stringify({
components: {
"comp-hello-world": {
executorLabel: "exec-hello-world",
inputDefinitions: {
parameters: {
param1: {
parameterType: "STRING",
},
},
},
},
},
deploymentSpec: {
executors: {
"exec-hello-world": {
container: {
args: [
"--param1",
"{{$.inputs.parameters['param1']}}",
],
command: [
"sh",
"-c",
"echo \"$0\"",
],
image: "python:3.11",
},
},
},
},
pipelineInfo: {
name: "hello-world-pipeline-full",
},
root: {
dag: {
tasks: {
"hello-world": {
cachingOptions: {
enableCache: true,
},
componentRef: {
name: "comp-hello-world",
},
inputs: {
parameters: {
param1: {
componentInputParameter: "param1",
},
},
},
taskInfo: {
name: "hello-world",
},
},
},
},
inputDefinitions: {
parameters: {
param1: {
defaultValue: "default-val",
isOptional: true,
parameterType: "STRING",
},
},
},
},
schemaVersion: "2.1.0",
sdkVersion: "kfp-2.7.0",
}),
encryptionSpec: {
kmsKeyName: "example-key",
},
pscInterfaceConfig: {
networkAttachment: pscAttachment.id,
dnsPeeringConfigs: [{
domain: "example.com.",
targetProject: project.then(project => project.projectId),
targetNetwork: vertexNetwork.name,
}],
},
runtimeConfig: {
gcsOutputDirectory: pulumi.interpolate`gs://${bucket.name}/output`,
failurePolicy: "PIPELINE_FAILURE_POLICY_FAIL_SLOW",
parameterValues: {
param1: "value1",
},
inputArtifacts: [{
artifactKey: "input_dataset",
artifactId: "123456789",
}],
},
labels: {
env: "full",
},
}, {
dependsOn: [
vertexVpcConnection,
cryptoKey,
],
});
import pulumi
import json
import pulumi_gcp as gcp
project = gcp.organizations.get_project()
bucket = gcp.storage.Bucket("bucket",
name="example-pipeline-bucket-full",
location="us-central1",
uniform_bucket_level_access=True,
force_destroy=True)
vertex_network = gcp.compute.Network("vertex_network",
name="vertex-pipeline-network",
auto_create_subnetworks=False)
vertex_range = gcp.compute.GlobalAddress("vertex_range",
name="vertex-pipeline-ip-range",
purpose="VPC_PEERING",
address_type="INTERNAL",
prefix_length=24,
network=vertex_network.id)
vertex_vpc_connection = gcp.servicenetworking.Connection("vertex_vpc_connection",
network=vertex_network.id,
service="servicenetworking.googleapis.com",
reserved_peering_ranges=[vertex_range.name])
psc_subnetwork = gcp.compute.Subnetwork("psc_subnetwork",
name="psc-pipeline-subnetwork",
region="us-central1",
ip_cidr_range="10.0.0.0/16",
network=vertex_network.id)
psc_attachment = gcp.compute.NetworkAttachment("psc_attachment",
name="psc-pipeline-attachment",
region="us-central1",
connection_preference="ACCEPT_MANUAL",
subnetworks=[psc_subnetwork.id])
crypto_key = gcp.kms.CryptoKeyIAMMember("crypto_key",
crypto_key_id="example-key",
role="roles/cloudkms.cryptoKeyEncrypterDecrypter",
member=f"serviceAccount:service-{project.number}@gcp-sa-aiplatform.iam.gserviceaccount.com")
pipeline_job = gcp.vertex.AiPipelineJob("pipeline_job",
display_name="example-pipeline-job-full",
pipeline_job_id="example-pipeline-job-full",
region="us-central1",
preflight_validations=False,
deletion_policy="FORCE",
service_account=f"{project.number}-compute@developer.gserviceaccount.com",
network=vertex_network.name.apply(lambda name: f"projects/{project.number}/global/networks/{name}"),
reserved_ip_ranges=[vertex_range.name],
template_uri="https://us-kfp.pkg.dev/ml-pipeline/google-cloud-registry/hello-world/sha256:1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
pipeline_spec=json.dumps({
"components": {
"comp-hello-world": {
"executorLabel": "exec-hello-world",
"inputDefinitions": {
"parameters": {
"param1": {
"parameterType": "STRING",
},
},
},
},
},
"deploymentSpec": {
"executors": {
"exec-hello-world": {
"container": {
"args": [
"--param1",
"{{$.inputs.parameters['param1']}}",
],
"command": [
"sh",
"-c",
"echo \"$0\"",
],
"image": "python:3.11",
},
},
},
},
"pipelineInfo": {
"name": "hello-world-pipeline-full",
},
"root": {
"dag": {
"tasks": {
"hello-world": {
"cachingOptions": {
"enableCache": True,
},
"componentRef": {
"name": "comp-hello-world",
},
"inputs": {
"parameters": {
"param1": {
"componentInputParameter": "param1",
},
},
},
"taskInfo": {
"name": "hello-world",
},
},
},
},
"inputDefinitions": {
"parameters": {
"param1": {
"defaultValue": "default-val",
"isOptional": True,
"parameterType": "STRING",
},
},
},
},
"schemaVersion": "2.1.0",
"sdkVersion": "kfp-2.7.0",
}),
encryption_spec={
"kms_key_name": "example-key",
},
psc_interface_config={
"network_attachment": psc_attachment.id,
"dns_peering_configs": [{
"domain": "example.com.",
"target_project": project.project_id,
"target_network": vertex_network.name,
}],
},
runtime_config={
"gcs_output_directory": bucket.name.apply(lambda name: f"gs://{name}/output"),
"failure_policy": "PIPELINE_FAILURE_POLICY_FAIL_SLOW",
"parameter_values": {
"param1": "value1",
},
"input_artifacts": [{
"artifact_key": "input_dataset",
"artifact_id": "123456789",
}],
},
labels={
"env": "full",
},
opts = pulumi.ResourceOptions(depends_on=[
vertex_vpc_connection,
crypto_key,
]))
package main
import (
"encoding/json"
"fmt"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/kms"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/organizations"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/servicenetworking"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/storage"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/vertex"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
project, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{}, nil)
if err != nil {
return err
}
bucket, err := storage.NewBucket(ctx, "bucket", &storage.BucketArgs{
Name: pulumi.String("example-pipeline-bucket-full"),
Location: pulumi.String("us-central1"),
UniformBucketLevelAccess: pulumi.Bool(true),
ForceDestroy: pulumi.Bool(true),
})
if err != nil {
return err
}
vertexNetwork, err := compute.NewNetwork(ctx, "vertex_network", &compute.NetworkArgs{
Name: pulumi.String("vertex-pipeline-network"),
AutoCreateSubnetworks: pulumi.Bool(false),
})
if err != nil {
return err
}
vertexRange, err := compute.NewGlobalAddress(ctx, "vertex_range", &compute.GlobalAddressArgs{
Name: pulumi.String("vertex-pipeline-ip-range"),
Purpose: pulumi.String("VPC_PEERING"),
AddressType: pulumi.String("INTERNAL"),
PrefixLength: pulumi.Int(24),
Network: vertexNetwork.ID(),
})
if err != nil {
return err
}
vertexVpcConnection, err := servicenetworking.NewConnection(ctx, "vertex_vpc_connection", &servicenetworking.ConnectionArgs{
Network: vertexNetwork.ID(),
Service: pulumi.String("servicenetworking.googleapis.com"),
ReservedPeeringRanges: pulumi.StringArray{
vertexRange.Name,
},
})
if err != nil {
return err
}
pscSubnetwork, err := compute.NewSubnetwork(ctx, "psc_subnetwork", &compute.SubnetworkArgs{
Name: pulumi.String("psc-pipeline-subnetwork"),
Region: pulumi.String("us-central1"),
IpCidrRange: pulumi.String("10.0.0.0/16"),
Network: vertexNetwork.ID(),
})
if err != nil {
return err
}
pscAttachment, err := compute.NewNetworkAttachment(ctx, "psc_attachment", &compute.NetworkAttachmentArgs{
Name: pulumi.String("psc-pipeline-attachment"),
Region: pulumi.String("us-central1"),
ConnectionPreference: pulumi.String("ACCEPT_MANUAL"),
Subnetworks: pulumi.StringArray{
pscSubnetwork.ID(),
},
})
if err != nil {
return err
}
cryptoKey, err := kms.NewCryptoKeyIAMMember(ctx, "crypto_key", &kms.CryptoKeyIAMMemberArgs{
CryptoKeyId: pulumi.String("example-key"),
Role: pulumi.String("roles/cloudkms.cryptoKeyEncrypterDecrypter"),
Member: pulumi.Sprintf("serviceAccount:service-%v@gcp-sa-aiplatform.iam.gserviceaccount.com", project.Number),
})
if err != nil {
return err
}
tmpJSON0, err := json.Marshal(map[string]interface{}{
"components": map[string]map[string]interface{}{
"comp-hello-world": map[string]interface{}{
"executorLabel": "exec-hello-world",
"inputDefinitions": map[string]map[string]map[string]string{
"parameters": map[string]map[string]string{
"param1": map[string]string{
"parameterType": "STRING",
},
},
},
},
},
"deploymentSpec": map[string]map[string]map[string]map[string]interface{}{
"executors": map[string]map[string]map[string]interface{}{
"exec-hello-world": map[string]map[string]interface{}{
"container": map[string]interface{}{
"args": []string{
"--param1",
"{{$.inputs.parameters['param1']}}",
},
"command": []string{
"sh",
"-c",
"echo \"$0\"",
},
"image": "python:3.11",
},
},
},
},
"pipelineInfo": map[string]string{
"name": "hello-world-pipeline-full",
},
"root": map[string]map[string]map[string]map[string]interface{}{
"dag": map[string]map[string]map[string]interface{}{
"tasks": map[string]map[string]interface{}{
"hello-world": map[string]interface{}{
"cachingOptions": map[string]bool{
"enableCache": true,
},
"componentRef": map[string]string{
"name": "comp-hello-world",
},
"inputs": map[string]map[string]map[string]string{
"parameters": map[string]map[string]string{
"param1": map[string]string{
"componentInputParameter": "param1",
},
},
},
"taskInfo": map[string]string{
"name": "hello-world",
},
},
},
},
"inputDefinitions": map[string]map[string]map[string]interface{}{
"parameters": map[string]map[string]interface{}{
"param1": map[string]interface{}{
"defaultValue": "default-val",
"isOptional": true,
"parameterType": "STRING",
},
},
},
},
"schemaVersion": "2.1.0",
"sdkVersion": "kfp-2.7.0",
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = vertex.NewAiPipelineJob(ctx, "pipeline_job", &vertex.AiPipelineJobArgs{
DisplayName: pulumi.String("example-pipeline-job-full"),
PipelineJobId: pulumi.String("example-pipeline-job-full"),
Region: pulumi.String("us-central1"),
PreflightValidations: pulumi.Bool(false),
DeletionPolicy: pulumi.String("FORCE"),
ServiceAccount: pulumi.Sprintf("%v-compute@developer.gserviceaccount.com", project.Number),
Network: vertexNetwork.Name.ApplyT(func(name string) (string, error) {
return fmt.Sprintf("projects/%v/global/networks/%v", project.Number, name), nil
}).(pulumi.StringOutput),
ReservedIpRanges: pulumi.StringArray{
vertexRange.Name,
},
TemplateUri: pulumi.String("https://us-kfp.pkg.dev/ml-pipeline/google-cloud-registry/hello-world/sha256:1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"),
PipelineSpec: pulumi.String(json0),
EncryptionSpec: &vertex.AiPipelineJobEncryptionSpecArgs{
KmsKeyName: pulumi.String("example-key"),
},
PscInterfaceConfig: &vertex.AiPipelineJobPscInterfaceConfigArgs{
NetworkAttachment: pscAttachment.ID(),
DnsPeeringConfigs: vertex.AiPipelineJobPscInterfaceConfigDnsPeeringConfigArray{
&vertex.AiPipelineJobPscInterfaceConfigDnsPeeringConfigArgs{
Domain: pulumi.String("example.com."),
TargetProject: pulumi.String(project.ProjectId),
TargetNetwork: vertexNetwork.Name,
},
},
},
RuntimeConfig: &vertex.AiPipelineJobRuntimeConfigArgs{
GcsOutputDirectory: bucket.Name.ApplyT(func(name string) (string, error) {
return fmt.Sprintf("gs://%v/output", name), nil
}).(pulumi.StringOutput),
FailurePolicy: pulumi.String("PIPELINE_FAILURE_POLICY_FAIL_SLOW"),
ParameterValues: pulumi.StringMap{
"param1": pulumi.String("value1"),
},
InputArtifacts: vertex.AiPipelineJobRuntimeConfigInputArtifactArray{
&vertex.AiPipelineJobRuntimeConfigInputArtifactArgs{
ArtifactKey: pulumi.String("input_dataset"),
ArtifactId: pulumi.String("123456789"),
},
},
},
Labels: pulumi.StringMap{
"env": pulumi.String("full"),
},
}, pulumi.DependsOn([]pulumi.Resource{
vertexVpcConnection,
cryptoKey,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var project = Gcp.Organizations.GetProject.Invoke();
var bucket = new Gcp.Storage.Bucket("bucket", new()
{
Name = "example-pipeline-bucket-full",
Location = "us-central1",
UniformBucketLevelAccess = true,
ForceDestroy = true,
});
var vertexNetwork = new Gcp.Compute.Network("vertex_network", new()
{
Name = "vertex-pipeline-network",
AutoCreateSubnetworks = false,
});
var vertexRange = new Gcp.Compute.GlobalAddress("vertex_range", new()
{
Name = "vertex-pipeline-ip-range",
Purpose = "VPC_PEERING",
AddressType = "INTERNAL",
PrefixLength = 24,
Network = vertexNetwork.Id,
});
var vertexVpcConnection = new Gcp.ServiceNetworking.Connection("vertex_vpc_connection", new()
{
Network = vertexNetwork.Id,
Service = "servicenetworking.googleapis.com",
ReservedPeeringRanges = new[]
{
vertexRange.Name,
},
});
var pscSubnetwork = new Gcp.Compute.Subnetwork("psc_subnetwork", new()
{
Name = "psc-pipeline-subnetwork",
Region = "us-central1",
IpCidrRange = "10.0.0.0/16",
Network = vertexNetwork.Id,
});
var pscAttachment = new Gcp.Compute.NetworkAttachment("psc_attachment", new()
{
Name = "psc-pipeline-attachment",
Region = "us-central1",
ConnectionPreference = "ACCEPT_MANUAL",
Subnetworks = new[]
{
pscSubnetwork.Id,
},
});
var cryptoKey = new Gcp.Kms.CryptoKeyIAMMember("crypto_key", new()
{
CryptoKeyId = "example-key",
Role = "roles/cloudkms.cryptoKeyEncrypterDecrypter",
Member = $"serviceAccount:service-{project.Apply(getProjectResult => getProjectResult.Number)}@gcp-sa-aiplatform.iam.gserviceaccount.com",
});
var pipelineJob = new Gcp.Vertex.AiPipelineJob("pipeline_job", new()
{
DisplayName = "example-pipeline-job-full",
PipelineJobId = "example-pipeline-job-full",
Region = "us-central1",
PreflightValidations = false,
DeletionPolicy = "FORCE",
ServiceAccount = $"{project.Apply(getProjectResult => getProjectResult.Number)}-compute@developer.gserviceaccount.com",
Network = Output.Tuple(project, vertexNetwork.Name).Apply(values =>
{
var project = values.Item1;
var name = values.Item2;
return $"projects/{project.Apply(getProjectResult => getProjectResult.Number)}/global/networks/{name}";
}),
ReservedIpRanges = new[]
{
vertexRange.Name,
},
TemplateUri = "https://us-kfp.pkg.dev/ml-pipeline/google-cloud-registry/hello-world/sha256:1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
PipelineSpec = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["components"] = new Dictionary<string, object?>
{
["comp-hello-world"] = new Dictionary<string, object?>
{
["executorLabel"] = "exec-hello-world",
["inputDefinitions"] = new Dictionary<string, object?>
{
["parameters"] = new Dictionary<string, object?>
{
["param1"] = new Dictionary<string, object?>
{
["parameterType"] = "STRING",
},
},
},
},
},
["deploymentSpec"] = new Dictionary<string, object?>
{
["executors"] = new Dictionary<string, object?>
{
["exec-hello-world"] = new Dictionary<string, object?>
{
["container"] = new Dictionary<string, object?>
{
["args"] = new[]
{
"--param1",
"{{$.inputs.parameters['param1']}}",
},
["command"] = new[]
{
"sh",
"-c",
"echo \"$0\"",
},
["image"] = "python:3.11",
},
},
},
},
["pipelineInfo"] = new Dictionary<string, object?>
{
["name"] = "hello-world-pipeline-full",
},
["root"] = new Dictionary<string, object?>
{
["dag"] = new Dictionary<string, object?>
{
["tasks"] = new Dictionary<string, object?>
{
["hello-world"] = new Dictionary<string, object?>
{
["cachingOptions"] = new Dictionary<string, object?>
{
["enableCache"] = true,
},
["componentRef"] = new Dictionary<string, object?>
{
["name"] = "comp-hello-world",
},
["inputs"] = new Dictionary<string, object?>
{
["parameters"] = new Dictionary<string, object?>
{
["param1"] = new Dictionary<string, object?>
{
["componentInputParameter"] = "param1",
},
},
},
["taskInfo"] = new Dictionary<string, object?>
{
["name"] = "hello-world",
},
},
},
},
["inputDefinitions"] = new Dictionary<string, object?>
{
["parameters"] = new Dictionary<string, object?>
{
["param1"] = new Dictionary<string, object?>
{
["defaultValue"] = "default-val",
["isOptional"] = true,
["parameterType"] = "STRING",
},
},
},
},
["schemaVersion"] = "2.1.0",
["sdkVersion"] = "kfp-2.7.0",
}),
EncryptionSpec = new Gcp.Vertex.Inputs.AiPipelineJobEncryptionSpecArgs
{
KmsKeyName = "example-key",
},
PscInterfaceConfig = new Gcp.Vertex.Inputs.AiPipelineJobPscInterfaceConfigArgs
{
NetworkAttachment = pscAttachment.Id,
DnsPeeringConfigs = new[]
{
new Gcp.Vertex.Inputs.AiPipelineJobPscInterfaceConfigDnsPeeringConfigArgs
{
Domain = "example.com.",
TargetProject = project.Apply(getProjectResult => getProjectResult.ProjectId),
TargetNetwork = vertexNetwork.Name,
},
},
},
RuntimeConfig = new Gcp.Vertex.Inputs.AiPipelineJobRuntimeConfigArgs
{
GcsOutputDirectory = bucket.Name.Apply(name => $"gs://{name}/output"),
FailurePolicy = "PIPELINE_FAILURE_POLICY_FAIL_SLOW",
ParameterValues =
{
{ "param1", "value1" },
},
InputArtifacts = new[]
{
new Gcp.Vertex.Inputs.AiPipelineJobRuntimeConfigInputArtifactArgs
{
ArtifactKey = "input_dataset",
ArtifactId = "123456789",
},
},
},
Labels =
{
{ "env", "full" },
},
}, new CustomResourceOptions
{
DependsOn =
{
vertexVpcConnection,
cryptoKey,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.storage.Bucket;
import com.pulumi.gcp.storage.BucketArgs;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.compute.GlobalAddress;
import com.pulumi.gcp.compute.GlobalAddressArgs;
import com.pulumi.gcp.servicenetworking.Connection;
import com.pulumi.gcp.servicenetworking.ConnectionArgs;
import com.pulumi.gcp.compute.Subnetwork;
import com.pulumi.gcp.compute.SubnetworkArgs;
import com.pulumi.gcp.compute.NetworkAttachment;
import com.pulumi.gcp.compute.NetworkAttachmentArgs;
import com.pulumi.gcp.kms.CryptoKeyIAMMember;
import com.pulumi.gcp.kms.CryptoKeyIAMMemberArgs;
import com.pulumi.gcp.vertex.AiPipelineJob;
import com.pulumi.gcp.vertex.AiPipelineJobArgs;
import com.pulumi.gcp.vertex.inputs.AiPipelineJobEncryptionSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiPipelineJobPscInterfaceConfigArgs;
import com.pulumi.gcp.vertex.inputs.AiPipelineJobPscInterfaceConfigDnsPeeringConfigArgs;
import com.pulumi.gcp.vertex.inputs.AiPipelineJobRuntimeConfigArgs;
import com.pulumi.gcp.vertex.inputs.AiPipelineJobRuntimeConfigInputArtifactArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var project = OrganizationsFunctions.getProject(GetProjectArgs.builder()
.build());
var bucket = new Bucket("bucket", BucketArgs.builder()
.name("example-pipeline-bucket-full")
.location("us-central1")
.uniformBucketLevelAccess(true)
.forceDestroy(true)
.build());
var vertexNetwork = new Network("vertexNetwork", NetworkArgs.builder()
.name("vertex-pipeline-network")
.autoCreateSubnetworks(false)
.build());
var vertexRange = new GlobalAddress("vertexRange", GlobalAddressArgs.builder()
.name("vertex-pipeline-ip-range")
.purpose("VPC_PEERING")
.addressType("INTERNAL")
.prefixLength(24)
.network(vertexNetwork.id())
.build());
var vertexVpcConnection = new Connection("vertexVpcConnection", ConnectionArgs.builder()
.network(vertexNetwork.id())
.service("servicenetworking.googleapis.com")
.reservedPeeringRanges(vertexRange.name())
.build());
var pscSubnetwork = new Subnetwork("pscSubnetwork", SubnetworkArgs.builder()
.name("psc-pipeline-subnetwork")
.region("us-central1")
.ipCidrRange("10.0.0.0/16")
.network(vertexNetwork.id())
.build());
var pscAttachment = new NetworkAttachment("pscAttachment", NetworkAttachmentArgs.builder()
.name("psc-pipeline-attachment")
.region("us-central1")
.connectionPreference("ACCEPT_MANUAL")
.subnetworks(pscSubnetwork.id())
.build());
var cryptoKey = new CryptoKeyIAMMember("cryptoKey", CryptoKeyIAMMemberArgs.builder()
.cryptoKeyId("example-key")
.role("roles/cloudkms.cryptoKeyEncrypterDecrypter")
.member(String.format("serviceAccount:service-%s@gcp-sa-aiplatform.iam.gserviceaccount.com", project.number()))
.build());
var pipelineJob = new AiPipelineJob("pipelineJob", AiPipelineJobArgs.builder()
.displayName("example-pipeline-job-full")
.pipelineJobId("example-pipeline-job-full")
.region("us-central1")
.preflightValidations(false)
.deletionPolicy("FORCE")
.serviceAccount(String.format("%s-compute@developer.gserviceaccount.com", project.number()))
.network(vertexNetwork.name().applyValue(_name -> String.format("projects/%s/global/networks/%s", project.number(),_name)))
.reservedIpRanges(vertexRange.name())
.templateUri("https://us-kfp.pkg.dev/ml-pipeline/google-cloud-registry/hello-world/sha256:1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef")
.pipelineSpec(serializeJson(
jsonObject(
jsonProperty("components", jsonObject(
jsonProperty("comp-hello-world", jsonObject(
jsonProperty("executorLabel", "exec-hello-world"),
jsonProperty("inputDefinitions", jsonObject(
jsonProperty("parameters", jsonObject(
jsonProperty("param1", jsonObject(
jsonProperty("parameterType", "STRING")
))
))
))
))
)),
jsonProperty("deploymentSpec", jsonObject(
jsonProperty("executors", jsonObject(
jsonProperty("exec-hello-world", jsonObject(
jsonProperty("container", jsonObject(
jsonProperty("args", jsonArray(
"--param1",
"{{$.inputs.parameters['param1']}}"
)),
jsonProperty("command", jsonArray(
"sh",
"-c",
"echo \"$0\""
)),
jsonProperty("image", "python:3.11")
))
))
))
)),
jsonProperty("pipelineInfo", jsonObject(
jsonProperty("name", "hello-world-pipeline-full")
)),
jsonProperty("root", jsonObject(
jsonProperty("dag", jsonObject(
jsonProperty("tasks", jsonObject(
jsonProperty("hello-world", jsonObject(
jsonProperty("cachingOptions", jsonObject(
jsonProperty("enableCache", true)
)),
jsonProperty("componentRef", jsonObject(
jsonProperty("name", "comp-hello-world")
)),
jsonProperty("inputs", jsonObject(
jsonProperty("parameters", jsonObject(
jsonProperty("param1", jsonObject(
jsonProperty("componentInputParameter", "param1")
))
))
)),
jsonProperty("taskInfo", jsonObject(
jsonProperty("name", "hello-world")
))
))
))
)),
jsonProperty("inputDefinitions", jsonObject(
jsonProperty("parameters", jsonObject(
jsonProperty("param1", jsonObject(
jsonProperty("defaultValue", "default-val"),
jsonProperty("isOptional", true),
jsonProperty("parameterType", "STRING")
))
))
))
)),
jsonProperty("schemaVersion", "2.1.0"),
jsonProperty("sdkVersion", "kfp-2.7.0")
)))
.encryptionSpec(AiPipelineJobEncryptionSpecArgs.builder()
.kmsKeyName("example-key")
.build())
.pscInterfaceConfig(AiPipelineJobPscInterfaceConfigArgs.builder()
.networkAttachment(pscAttachment.id())
.dnsPeeringConfigs(AiPipelineJobPscInterfaceConfigDnsPeeringConfigArgs.builder()
.domain("example.com.")
.targetProject(project.projectId())
.targetNetwork(vertexNetwork.name())
.build())
.build())
.runtimeConfig(AiPipelineJobRuntimeConfigArgs.builder()
.gcsOutputDirectory(bucket.name().applyValue(_name -> String.format("gs://%s/output", _name)))
.failurePolicy("PIPELINE_FAILURE_POLICY_FAIL_SLOW")
.parameterValues(Map.of("param1", "value1"))
.inputArtifacts(AiPipelineJobRuntimeConfigInputArtifactArgs.builder()
.artifactKey("input_dataset")
.artifactId("123456789")
.build())
.build())
.labels(Map.of("env", "full"))
.build(), CustomResourceOptions.builder()
.dependsOn(
vertexVpcConnection,
cryptoKey)
.build());
}
}
resources:
bucket:
type: gcp:storage:Bucket
properties:
name: example-pipeline-bucket-full
location: us-central1
uniformBucketLevelAccess: true
forceDestroy: true
vertexNetwork:
type: gcp:compute:Network
name: vertex_network
properties:
name: vertex-pipeline-network
autoCreateSubnetworks: false
vertexRange:
type: gcp:compute:GlobalAddress
name: vertex_range
properties:
name: vertex-pipeline-ip-range
purpose: VPC_PEERING
addressType: INTERNAL
prefixLength: 24
network: ${vertexNetwork.id}
vertexVpcConnection:
type: gcp:servicenetworking:Connection
name: vertex_vpc_connection
properties:
network: ${vertexNetwork.id}
service: servicenetworking.googleapis.com
reservedPeeringRanges:
- ${vertexRange.name}
pscSubnetwork:
type: gcp:compute:Subnetwork
name: psc_subnetwork
properties:
name: psc-pipeline-subnetwork
region: us-central1
ipCidrRange: 10.0.0.0/16
network: ${vertexNetwork.id}
pscAttachment:
type: gcp:compute:NetworkAttachment
name: psc_attachment
properties:
name: psc-pipeline-attachment
region: us-central1
connectionPreference: ACCEPT_MANUAL
subnetworks:
- ${pscSubnetwork.id}
cryptoKey:
type: gcp:kms:CryptoKeyIAMMember
name: crypto_key
properties:
cryptoKeyId: example-key
role: roles/cloudkms.cryptoKeyEncrypterDecrypter
member: serviceAccount:service-${project.number}@gcp-sa-aiplatform.iam.gserviceaccount.com
pipelineJob:
type: gcp:vertex:AiPipelineJob
name: pipeline_job
properties:
displayName: example-pipeline-job-full
pipelineJobId: example-pipeline-job-full
region: us-central1
preflightValidations: false
deletionPolicy: FORCE
serviceAccount: ${project.number}-compute@developer.gserviceaccount.com
network: projects/${project.number}/global/networks/${vertexNetwork.name}
reservedIpRanges:
- ${vertexRange.name}
templateUri: https://us-kfp.pkg.dev/ml-pipeline/google-cloud-registry/hello-world/sha256:1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
pipelineSpec:
fn::toJSON:
components:
comp-hello-world:
executorLabel: exec-hello-world
inputDefinitions:
parameters:
param1:
parameterType: STRING
deploymentSpec:
executors:
exec-hello-world:
container:
args:
- --param1
- '{{$.inputs.parameters[''param1'']}}'
command:
- sh
- -c
- echo "$0"
image: python:3.11
pipelineInfo:
name: hello-world-pipeline-full
root:
dag:
tasks:
hello-world:
cachingOptions:
enableCache: true
componentRef:
name: comp-hello-world
inputs:
parameters:
param1:
componentInputParameter: param1
taskInfo:
name: hello-world
inputDefinitions:
parameters:
param1:
defaultValue: default-val
isOptional: true
parameterType: STRING
schemaVersion: 2.1.0
sdkVersion: kfp-2.7.0
encryptionSpec:
kmsKeyName: example-key
pscInterfaceConfig:
networkAttachment: ${pscAttachment.id}
dnsPeeringConfigs:
- domain: example.com.
targetProject: ${project.projectId}
targetNetwork: ${vertexNetwork.name}
runtimeConfig:
gcsOutputDirectory: gs://${bucket.name}/output
failurePolicy: PIPELINE_FAILURE_POLICY_FAIL_SLOW
parameterValues:
param1: value1
inputArtifacts:
- artifactKey: input_dataset
artifactId: '123456789'
labels:
env: full
options:
dependsOn:
- ${vertexVpcConnection}
- ${cryptoKey}
variables:
project:
fn::invoke:
function: gcp:organizations:getProject
arguments: {}
terraform {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
data "gcp_organizations_project" "project" {
}
resource "gcp_storage_bucket" "bucket" {
lifecycle {
create_before_destroy = true
}
name = "example-pipeline-bucket-full"
location = "us-central1"
uniform_bucket_level_access = true
force_destroy = true
}
resource "gcp_compute_network" "vertex_network" {
lifecycle {
create_before_destroy = true
}
name = "vertex-pipeline-network"
auto_create_subnetworks = false
}
resource "gcp_compute_global_address" "vertex_range" {
lifecycle {
create_before_destroy = true
}
name = "vertex-pipeline-ip-range"
purpose = "VPC_PEERING"
address_type = "INTERNAL"
prefix_length = 24
network = gcp_compute_network.vertex_network.id
}
resource "gcp_servicenetworking_connection" "vertex_vpc_connection" {
lifecycle {
create_before_destroy = true
}
network = gcp_compute_network.vertex_network.id
service = "servicenetworking.googleapis.com"
reserved_peering_ranges = [gcp_compute_global_address.vertex_range.name]
}
resource "gcp_compute_subnetwork" "psc_subnetwork" {
lifecycle {
create_before_destroy = true
}
name = "psc-pipeline-subnetwork"
region = "us-central1"
ip_cidr_range = "10.0.0.0/16"
network = gcp_compute_network.vertex_network.id
}
resource "gcp_compute_network_attachment" "psc_attachment" {
lifecycle {
create_before_destroy = true
}
name = "psc-pipeline-attachment"
region = "us-central1"
connection_preference = "ACCEPT_MANUAL"
subnetworks = [gcp_compute_subnetwork.psc_subnetwork.id]
}
resource "gcp_kms_crypto_key_i_a_m_member" "crypto_key" {
lifecycle {
create_before_destroy = true
}
crypto_key_id = "example-key"
role = "roles/cloudkms.cryptoKeyEncrypterDecrypter"
member ="serviceAccount:service-${data.gcp_organizations_project.project.number}@gcp-sa-aiplatform.iam.gserviceaccount.com"
}
resource "gcp_vertex_ai_pipeline_job" "pipeline_job" {
depends_on = [gcp_servicenetworking_connection.vertex_vpc_connection, gcp_kms_crypto_key_i_a_m_member.crypto_key]
lifecycle {
create_before_destroy = true
}
display_name = "example-pipeline-job-full"
pipeline_job_id = "example-pipeline-job-full"
region = "us-central1"
preflight_validations = false
deletion_policy = "FORCE"
service_account ="${data.gcp_organizations_project.project.number}-compute@developer.gserviceaccount.com"
network ="projects/${data.gcp_organizations_project.project.number}/global/networks/${gcp_compute_network.vertex_network.name}"
reserved_ip_ranges = [gcp_compute_global_address.vertex_range.name]
template_uri = "https://us-kfp.pkg.dev/ml-pipeline/google-cloud-registry/hello-world/sha256:1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
pipeline_spec = jsonencode({
"components" = {
"comp-hello-world" = {
"executorLabel" = "exec-hello-world"
"inputDefinitions" = {
"parameters" = {
"param1" = {
"parameterType" = "STRING"
}
}
}
}
}
"deploymentSpec" = {
"executors" = {
"exec-hello-world" = {
"container" = {
"args" = ["--param1", "{{$.inputs.parameters['param1']}}"]
"command" = ["sh", "-c", "echo \"$0\""]
"image" = "python:3.11"
}
}
}
}
"pipelineInfo" = {
"name" = "hello-world-pipeline-full"
}
"root" = {
"dag" = {
"tasks" = {
"hello-world" = {
"cachingOptions" = {
"enableCache" = true
}
"componentRef" = {
"name" = "comp-hello-world"
}
"inputs" = {
"parameters" = {
"param1" = {
"componentInputParameter" = "param1"
}
}
}
"taskInfo" = {
"name" = "hello-world"
}
}
}
}
"inputDefinitions" = {
"parameters" = {
"param1" = {
"defaultValue" = "default-val"
"isOptional" = true
"parameterType" = "STRING"
}
}
}
}
"schemaVersion" = "2.1.0"
"sdkVersion" = "kfp-2.7.0"
})
encryption_spec = {
kms_key_name = "example-key"
}
psc_interface_config = {
network_attachment = gcp_compute_network_attachment.psc_attachment.id
dns_peering_configs = [{
domain = "example.com."
target_project = data.gcp_organizations_project.project.project_id
target_network = gcp_compute_network.vertex_network.name
}]
}
runtime_config = {
gcs_output_directory ="gs://${gcp_storage_bucket.bucket.name}/output"
failure_policy = "PIPELINE_FAILURE_POLICY_FAIL_SLOW"
parameter_values = {
"param1" = "value1"
}
input_artifacts = [{
artifact_key = "input_dataset"
artifact_id = "123456789"
}]
}
labels = {
"env" = "full"
}
}
Vertex Ai Pipeline Job Persistent Resource
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const project = gcp.organizations.getProject({});
const bucket = new gcp.storage.Bucket("bucket", {
name: "example-pipeline-bucket-pr",
location: "us-central1",
uniformBucketLevelAccess: true,
forceDestroy: true,
});
const pipelineJob = new gcp.vertex.AiPipelineJob("pipeline_job", {
displayName: "example-pipeline-job-pr",
pipelineJobId: "example-pipeline-job-pr",
region: "us-central1",
deletionPolicy: "FORCE",
pipelineSpec: JSON.stringify({
components: {
"comp-hello-world": {
executorLabel: "exec-hello-world",
},
},
deploymentSpec: {
executors: {
"exec-hello-world": {
container: {
command: [
"sh",
"-c",
"echo hello",
],
image: "python:3.11",
},
},
},
},
pipelineInfo: {
name: "persistent-resource-pipeline",
},
root: {
dag: {
tasks: {
"hello-world": {
componentRef: {
name: "comp-hello-world",
},
taskInfo: {
name: "hello-world",
},
},
},
},
},
schemaVersion: "2.1.0",
sdkVersion: "kfp-2.7.0",
}),
runtimeConfig: {
gcsOutputDirectory: pulumi.interpolate`gs://${bucket.name}/output`,
defaultRuntime: {
persistentResourceRuntimeDetail: {
persistentResourceName: project.then(project => `projects/${project.number}/locations/us-central1/persistentResources/example-persistent-resource`),
taskResourceUnavailableWaitTimeMs: "60000",
taskResourceUnavailableTimeoutBehavior: "FALL_BACK_TO_ON_DEMAND",
},
},
},
});
import pulumi
import json
import pulumi_gcp as gcp
project = gcp.organizations.get_project()
bucket = gcp.storage.Bucket("bucket",
name="example-pipeline-bucket-pr",
location="us-central1",
uniform_bucket_level_access=True,
force_destroy=True)
pipeline_job = gcp.vertex.AiPipelineJob("pipeline_job",
display_name="example-pipeline-job-pr",
pipeline_job_id="example-pipeline-job-pr",
region="us-central1",
deletion_policy="FORCE",
pipeline_spec=json.dumps({
"components": {
"comp-hello-world": {
"executorLabel": "exec-hello-world",
},
},
"deploymentSpec": {
"executors": {
"exec-hello-world": {
"container": {
"command": [
"sh",
"-c",
"echo hello",
],
"image": "python:3.11",
},
},
},
},
"pipelineInfo": {
"name": "persistent-resource-pipeline",
},
"root": {
"dag": {
"tasks": {
"hello-world": {
"componentRef": {
"name": "comp-hello-world",
},
"taskInfo": {
"name": "hello-world",
},
},
},
},
},
"schemaVersion": "2.1.0",
"sdkVersion": "kfp-2.7.0",
}),
runtime_config={
"gcs_output_directory": bucket.name.apply(lambda name: f"gs://{name}/output"),
"default_runtime": {
"persistent_resource_runtime_detail": {
"persistent_resource_name": f"projects/{project.number}/locations/us-central1/persistentResources/example-persistent-resource",
"task_resource_unavailable_wait_time_ms": "60000",
"task_resource_unavailable_timeout_behavior": "FALL_BACK_TO_ON_DEMAND",
},
},
})
package main
import (
"encoding/json"
"fmt"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/organizations"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/storage"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/vertex"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
project, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{}, nil)
if err != nil {
return err
}
bucket, err := storage.NewBucket(ctx, "bucket", &storage.BucketArgs{
Name: pulumi.String("example-pipeline-bucket-pr"),
Location: pulumi.String("us-central1"),
UniformBucketLevelAccess: pulumi.Bool(true),
ForceDestroy: pulumi.Bool(true),
})
if err != nil {
return err
}
tmpJSON0, err := json.Marshal(map[string]interface{}{
"components": map[string]map[string]string{
"comp-hello-world": map[string]string{
"executorLabel": "exec-hello-world",
},
},
"deploymentSpec": map[string]map[string]map[string]map[string]interface{}{
"executors": map[string]map[string]map[string]interface{}{
"exec-hello-world": map[string]map[string]interface{}{
"container": map[string]interface{}{
"command": []string{
"sh",
"-c",
"echo hello",
},
"image": "python:3.11",
},
},
},
},
"pipelineInfo": map[string]string{
"name": "persistent-resource-pipeline",
},
"root": map[string]map[string]map[string]map[string]map[string]string{
"dag": map[string]map[string]map[string]map[string]string{
"tasks": map[string]map[string]map[string]string{
"hello-world": map[string]map[string]string{
"componentRef": map[string]string{
"name": "comp-hello-world",
},
"taskInfo": map[string]string{
"name": "hello-world",
},
},
},
},
},
"schemaVersion": "2.1.0",
"sdkVersion": "kfp-2.7.0",
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = vertex.NewAiPipelineJob(ctx, "pipeline_job", &vertex.AiPipelineJobArgs{
DisplayName: pulumi.String("example-pipeline-job-pr"),
PipelineJobId: pulumi.String("example-pipeline-job-pr"),
Region: pulumi.String("us-central1"),
DeletionPolicy: pulumi.String("FORCE"),
PipelineSpec: pulumi.String(json0),
RuntimeConfig: &vertex.AiPipelineJobRuntimeConfigArgs{
GcsOutputDirectory: bucket.Name.ApplyT(func(name string) (string, error) {
return fmt.Sprintf("gs://%v/output", name), nil
}).(pulumi.StringOutput),
DefaultRuntime: &vertex.AiPipelineJobRuntimeConfigDefaultRuntimeArgs{
PersistentResourceRuntimeDetail: &vertex.AiPipelineJobRuntimeConfigDefaultRuntimePersistentResourceRuntimeDetailArgs{
PersistentResourceName: pulumi.Sprintf("projects/%v/locations/us-central1/persistentResources/example-persistent-resource", project.Number),
TaskResourceUnavailableWaitTimeMs: pulumi.String("60000"),
TaskResourceUnavailableTimeoutBehavior: pulumi.String("FALL_BACK_TO_ON_DEMAND"),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var project = Gcp.Organizations.GetProject.Invoke();
var bucket = new Gcp.Storage.Bucket("bucket", new()
{
Name = "example-pipeline-bucket-pr",
Location = "us-central1",
UniformBucketLevelAccess = true,
ForceDestroy = true,
});
var pipelineJob = new Gcp.Vertex.AiPipelineJob("pipeline_job", new()
{
DisplayName = "example-pipeline-job-pr",
PipelineJobId = "example-pipeline-job-pr",
Region = "us-central1",
DeletionPolicy = "FORCE",
PipelineSpec = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["components"] = new Dictionary<string, object?>
{
["comp-hello-world"] = new Dictionary<string, object?>
{
["executorLabel"] = "exec-hello-world",
},
},
["deploymentSpec"] = new Dictionary<string, object?>
{
["executors"] = new Dictionary<string, object?>
{
["exec-hello-world"] = new Dictionary<string, object?>
{
["container"] = new Dictionary<string, object?>
{
["command"] = new[]
{
"sh",
"-c",
"echo hello",
},
["image"] = "python:3.11",
},
},
},
},
["pipelineInfo"] = new Dictionary<string, object?>
{
["name"] = "persistent-resource-pipeline",
},
["root"] = new Dictionary<string, object?>
{
["dag"] = new Dictionary<string, object?>
{
["tasks"] = new Dictionary<string, object?>
{
["hello-world"] = new Dictionary<string, object?>
{
["componentRef"] = new Dictionary<string, object?>
{
["name"] = "comp-hello-world",
},
["taskInfo"] = new Dictionary<string, object?>
{
["name"] = "hello-world",
},
},
},
},
},
["schemaVersion"] = "2.1.0",
["sdkVersion"] = "kfp-2.7.0",
}),
RuntimeConfig = new Gcp.Vertex.Inputs.AiPipelineJobRuntimeConfigArgs
{
GcsOutputDirectory = bucket.Name.Apply(name => $"gs://{name}/output"),
DefaultRuntime = new Gcp.Vertex.Inputs.AiPipelineJobRuntimeConfigDefaultRuntimeArgs
{
PersistentResourceRuntimeDetail = new Gcp.Vertex.Inputs.AiPipelineJobRuntimeConfigDefaultRuntimePersistentResourceRuntimeDetailArgs
{
PersistentResourceName = $"projects/{project.Apply(getProjectResult => getProjectResult.Number)}/locations/us-central1/persistentResources/example-persistent-resource",
TaskResourceUnavailableWaitTimeMs = "60000",
TaskResourceUnavailableTimeoutBehavior = "FALL_BACK_TO_ON_DEMAND",
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.storage.Bucket;
import com.pulumi.gcp.storage.BucketArgs;
import com.pulumi.gcp.vertex.AiPipelineJob;
import com.pulumi.gcp.vertex.AiPipelineJobArgs;
import com.pulumi.gcp.vertex.inputs.AiPipelineJobRuntimeConfigArgs;
import com.pulumi.gcp.vertex.inputs.AiPipelineJobRuntimeConfigDefaultRuntimeArgs;
import com.pulumi.gcp.vertex.inputs.AiPipelineJobRuntimeConfigDefaultRuntimePersistentResourceRuntimeDetailArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var project = OrganizationsFunctions.getProject(GetProjectArgs.builder()
.build());
var bucket = new Bucket("bucket", BucketArgs.builder()
.name("example-pipeline-bucket-pr")
.location("us-central1")
.uniformBucketLevelAccess(true)
.forceDestroy(true)
.build());
var pipelineJob = new AiPipelineJob("pipelineJob", AiPipelineJobArgs.builder()
.displayName("example-pipeline-job-pr")
.pipelineJobId("example-pipeline-job-pr")
.region("us-central1")
.deletionPolicy("FORCE")
.pipelineSpec(serializeJson(
jsonObject(
jsonProperty("components", jsonObject(
jsonProperty("comp-hello-world", jsonObject(
jsonProperty("executorLabel", "exec-hello-world")
))
)),
jsonProperty("deploymentSpec", jsonObject(
jsonProperty("executors", jsonObject(
jsonProperty("exec-hello-world", jsonObject(
jsonProperty("container", jsonObject(
jsonProperty("command", jsonArray(
"sh",
"-c",
"echo hello"
)),
jsonProperty("image", "python:3.11")
))
))
))
)),
jsonProperty("pipelineInfo", jsonObject(
jsonProperty("name", "persistent-resource-pipeline")
)),
jsonProperty("root", jsonObject(
jsonProperty("dag", jsonObject(
jsonProperty("tasks", jsonObject(
jsonProperty("hello-world", jsonObject(
jsonProperty("componentRef", jsonObject(
jsonProperty("name", "comp-hello-world")
)),
jsonProperty("taskInfo", jsonObject(
jsonProperty("name", "hello-world")
))
))
))
))
)),
jsonProperty("schemaVersion", "2.1.0"),
jsonProperty("sdkVersion", "kfp-2.7.0")
)))
.runtimeConfig(AiPipelineJobRuntimeConfigArgs.builder()
.gcsOutputDirectory(bucket.name().applyValue(_name -> String.format("gs://%s/output", _name)))
.defaultRuntime(AiPipelineJobRuntimeConfigDefaultRuntimeArgs.builder()
.persistentResourceRuntimeDetail(AiPipelineJobRuntimeConfigDefaultRuntimePersistentResourceRuntimeDetailArgs.builder()
.persistentResourceName(String.format("projects/%s/locations/us-central1/persistentResources/example-persistent-resource", project.number()))
.taskResourceUnavailableWaitTimeMs("60000")
.taskResourceUnavailableTimeoutBehavior("FALL_BACK_TO_ON_DEMAND")
.build())
.build())
.build())
.build());
}
}
resources:
bucket:
type: gcp:storage:Bucket
properties:
name: example-pipeline-bucket-pr
location: us-central1
uniformBucketLevelAccess: true
forceDestroy: true
pipelineJob:
type: gcp:vertex:AiPipelineJob
name: pipeline_job
properties:
displayName: example-pipeline-job-pr
pipelineJobId: example-pipeline-job-pr
region: us-central1
deletionPolicy: FORCE
pipelineSpec:
fn::toJSON:
components:
comp-hello-world:
executorLabel: exec-hello-world
deploymentSpec:
executors:
exec-hello-world:
container:
command:
- sh
- -c
- echo hello
image: python:3.11
pipelineInfo:
name: persistent-resource-pipeline
root:
dag:
tasks:
hello-world:
componentRef:
name: comp-hello-world
taskInfo:
name: hello-world
schemaVersion: 2.1.0
sdkVersion: kfp-2.7.0
runtimeConfig:
gcsOutputDirectory: gs://${bucket.name}/output
defaultRuntime:
persistentResourceRuntimeDetail:
persistentResourceName: projects/${project.number}/locations/us-central1/persistentResources/example-persistent-resource
taskResourceUnavailableWaitTimeMs: '60000'
taskResourceUnavailableTimeoutBehavior: FALL_BACK_TO_ON_DEMAND
variables:
project:
fn::invoke:
function: gcp:organizations:getProject
arguments: {}
terraform {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
data "gcp_organizations_project" "project" {
}
resource "gcp_storage_bucket" "bucket" {
lifecycle {
create_before_destroy = true
}
name = "example-pipeline-bucket-pr"
location = "us-central1"
uniform_bucket_level_access = true
force_destroy = true
}
resource "gcp_vertex_ai_pipeline_job" "pipeline_job" {
lifecycle {
create_before_destroy = true
}
display_name = "example-pipeline-job-pr"
pipeline_job_id = "example-pipeline-job-pr"
region = "us-central1"
deletion_policy = "FORCE"
pipeline_spec = jsonencode({
"components" = {
"comp-hello-world" = {
"executorLabel" = "exec-hello-world"
}
}
"deploymentSpec" = {
"executors" = {
"exec-hello-world" = {
"container" = {
"command" = ["sh", "-c", "echo hello"]
"image" = "python:3.11"
}
}
}
}
"pipelineInfo" = {
"name" = "persistent-resource-pipeline"
}
"root" = {
"dag" = {
"tasks" = {
"hello-world" = {
"componentRef" = {
"name" = "comp-hello-world"
}
"taskInfo" = {
"name" = "hello-world"
}
}
}
}
}
"schemaVersion" = "2.1.0"
"sdkVersion" = "kfp-2.7.0"
})
runtime_config = {
gcs_output_directory ="gs://${gcp_storage_bucket.bucket.name}/output"
default_runtime = {
persistent_resource_runtime_detail = {
persistent_resource_name ="projects/${data.gcp_organizations_project.project.number}/locations/us-central1/persistentResources/example-persistent-resource"
task_resource_unavailable_wait_time_ms = "60000"
task_resource_unavailable_timeout_behavior = "FALL_BACK_TO_ON_DEMAND"
}
}
}
}
Create AiPipelineJob Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AiPipelineJob(name: string, args?: AiPipelineJobArgs, opts?: CustomResourceOptions);@overload
def AiPipelineJob(resource_name: str,
args: Optional[AiPipelineJobArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def AiPipelineJob(resource_name: str,
opts: Optional[ResourceOptions] = None,
deletion_policy: Optional[str] = None,
display_name: Optional[str] = None,
encryption_spec: Optional[AiPipelineJobEncryptionSpecArgs] = None,
labels: Optional[Mapping[str, str]] = None,
network: Optional[str] = None,
pipeline_job_id: Optional[str] = None,
pipeline_spec: Optional[str] = None,
preflight_validations: Optional[bool] = None,
project: Optional[str] = None,
psc_interface_config: Optional[AiPipelineJobPscInterfaceConfigArgs] = None,
region: Optional[str] = None,
reserved_ip_ranges: Optional[Sequence[str]] = None,
runtime_config: Optional[AiPipelineJobRuntimeConfigArgs] = None,
service_account: Optional[str] = None,
template_uri: Optional[str] = None)func NewAiPipelineJob(ctx *Context, name string, args *AiPipelineJobArgs, opts ...ResourceOption) (*AiPipelineJob, error)public AiPipelineJob(string name, AiPipelineJobArgs? args = null, CustomResourceOptions? opts = null)
public AiPipelineJob(String name, AiPipelineJobArgs args)
public AiPipelineJob(String name, AiPipelineJobArgs args, CustomResourceOptions options)
type: gcp:vertex:AiPipelineJob
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "gcp_vertex_ai_pipeline_job" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args AiPipelineJobArgs
- 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 AiPipelineJobArgs
- 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 AiPipelineJobArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AiPipelineJobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AiPipelineJobArgs
- 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 aiPipelineJobResource = new Gcp.Vertex.AiPipelineJob("aiPipelineJobResource", new()
{
DeletionPolicy = "string",
DisplayName = "string",
EncryptionSpec = new Gcp.Vertex.Inputs.AiPipelineJobEncryptionSpecArgs
{
KmsKeyName = "string",
},
Labels =
{
{ "string", "string" },
},
Network = "string",
PipelineJobId = "string",
PipelineSpec = "string",
PreflightValidations = false,
Project = "string",
PscInterfaceConfig = new Gcp.Vertex.Inputs.AiPipelineJobPscInterfaceConfigArgs
{
DnsPeeringConfigs = new[]
{
new Gcp.Vertex.Inputs.AiPipelineJobPscInterfaceConfigDnsPeeringConfigArgs
{
Domain = "string",
TargetNetwork = "string",
TargetProject = "string",
},
},
NetworkAttachment = "string",
},
Region = "string",
ReservedIpRanges = new[]
{
"string",
},
RuntimeConfig = new Gcp.Vertex.Inputs.AiPipelineJobRuntimeConfigArgs
{
GcsOutputDirectory = "string",
DefaultRuntime = new Gcp.Vertex.Inputs.AiPipelineJobRuntimeConfigDefaultRuntimeArgs
{
PersistentResourceRuntimeDetail = new Gcp.Vertex.Inputs.AiPipelineJobRuntimeConfigDefaultRuntimePersistentResourceRuntimeDetailArgs
{
PersistentResourceName = "string",
TaskResourceUnavailableTimeoutBehavior = "string",
TaskResourceUnavailableWaitTimeMs = "string",
},
},
FailurePolicy = "string",
InputArtifacts = new[]
{
new Gcp.Vertex.Inputs.AiPipelineJobRuntimeConfigInputArtifactArgs
{
ArtifactId = "string",
ArtifactKey = "string",
},
},
ParameterValues =
{
{ "string", "string" },
},
},
ServiceAccount = "string",
TemplateUri = "string",
});
example, err := vertex.NewAiPipelineJob(ctx, "aiPipelineJobResource", &vertex.AiPipelineJobArgs{
DeletionPolicy: pulumi.String("string"),
DisplayName: pulumi.String("string"),
EncryptionSpec: &vertex.AiPipelineJobEncryptionSpecArgs{
KmsKeyName: pulumi.String("string"),
},
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Network: pulumi.String("string"),
PipelineJobId: pulumi.String("string"),
PipelineSpec: pulumi.String("string"),
PreflightValidations: pulumi.Bool(false),
Project: pulumi.String("string"),
PscInterfaceConfig: &vertex.AiPipelineJobPscInterfaceConfigArgs{
DnsPeeringConfigs: vertex.AiPipelineJobPscInterfaceConfigDnsPeeringConfigArray{
&vertex.AiPipelineJobPscInterfaceConfigDnsPeeringConfigArgs{
Domain: pulumi.String("string"),
TargetNetwork: pulumi.String("string"),
TargetProject: pulumi.String("string"),
},
},
NetworkAttachment: pulumi.String("string"),
},
Region: pulumi.String("string"),
ReservedIpRanges: pulumi.StringArray{
pulumi.String("string"),
},
RuntimeConfig: &vertex.AiPipelineJobRuntimeConfigArgs{
GcsOutputDirectory: pulumi.String("string"),
DefaultRuntime: &vertex.AiPipelineJobRuntimeConfigDefaultRuntimeArgs{
PersistentResourceRuntimeDetail: &vertex.AiPipelineJobRuntimeConfigDefaultRuntimePersistentResourceRuntimeDetailArgs{
PersistentResourceName: pulumi.String("string"),
TaskResourceUnavailableTimeoutBehavior: pulumi.String("string"),
TaskResourceUnavailableWaitTimeMs: pulumi.String("string"),
},
},
FailurePolicy: pulumi.String("string"),
InputArtifacts: vertex.AiPipelineJobRuntimeConfigInputArtifactArray{
&vertex.AiPipelineJobRuntimeConfigInputArtifactArgs{
ArtifactId: pulumi.String("string"),
ArtifactKey: pulumi.String("string"),
},
},
ParameterValues: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
ServiceAccount: pulumi.String("string"),
TemplateUri: pulumi.String("string"),
})
resource "gcp_vertex_ai_pipeline_job" "aiPipelineJobResource" {
lifecycle {
create_before_destroy = true
}
deletion_policy = "string"
display_name = "string"
encryption_spec = {
kms_key_name = "string"
}
labels = {
"string" = "string"
}
network = "string"
pipeline_job_id = "string"
pipeline_spec = "string"
preflight_validations = false
project = "string"
psc_interface_config = {
dns_peering_configs = [{
domain = "string"
target_network = "string"
target_project = "string"
}]
network_attachment = "string"
}
region = "string"
reserved_ip_ranges = ["string"]
runtime_config = {
gcs_output_directory = "string"
default_runtime = {
persistent_resource_runtime_detail = {
persistent_resource_name = "string"
task_resource_unavailable_timeout_behavior = "string"
task_resource_unavailable_wait_time_ms = "string"
}
}
failure_policy = "string"
input_artifacts = [{
artifact_id = "string"
artifact_key = "string"
}]
parameter_values = {
"string" = "string"
}
}
service_account = "string"
template_uri = "string"
}
var aiPipelineJobResource = new AiPipelineJob("aiPipelineJobResource", AiPipelineJobArgs.builder()
.deletionPolicy("string")
.displayName("string")
.encryptionSpec(AiPipelineJobEncryptionSpecArgs.builder()
.kmsKeyName("string")
.build())
.labels(Map.of("string", "string"))
.network("string")
.pipelineJobId("string")
.pipelineSpec("string")
.preflightValidations(false)
.project("string")
.pscInterfaceConfig(AiPipelineJobPscInterfaceConfigArgs.builder()
.dnsPeeringConfigs(AiPipelineJobPscInterfaceConfigDnsPeeringConfigArgs.builder()
.domain("string")
.targetNetwork("string")
.targetProject("string")
.build())
.networkAttachment("string")
.build())
.region("string")
.reservedIpRanges("string")
.runtimeConfig(AiPipelineJobRuntimeConfigArgs.builder()
.gcsOutputDirectory("string")
.defaultRuntime(AiPipelineJobRuntimeConfigDefaultRuntimeArgs.builder()
.persistentResourceRuntimeDetail(AiPipelineJobRuntimeConfigDefaultRuntimePersistentResourceRuntimeDetailArgs.builder()
.persistentResourceName("string")
.taskResourceUnavailableTimeoutBehavior("string")
.taskResourceUnavailableWaitTimeMs("string")
.build())
.build())
.failurePolicy("string")
.inputArtifacts(AiPipelineJobRuntimeConfigInputArtifactArgs.builder()
.artifactId("string")
.artifactKey("string")
.build())
.parameterValues(Map.of("string", "string"))
.build())
.serviceAccount("string")
.templateUri("string")
.build());
ai_pipeline_job_resource = gcp.vertex.AiPipelineJob("aiPipelineJobResource",
deletion_policy="string",
display_name="string",
encryption_spec={
"kms_key_name": "string",
},
labels={
"string": "string",
},
network="string",
pipeline_job_id="string",
pipeline_spec="string",
preflight_validations=False,
project="string",
psc_interface_config={
"dns_peering_configs": [{
"domain": "string",
"target_network": "string",
"target_project": "string",
}],
"network_attachment": "string",
},
region="string",
reserved_ip_ranges=["string"],
runtime_config={
"gcs_output_directory": "string",
"default_runtime": {
"persistent_resource_runtime_detail": {
"persistent_resource_name": "string",
"task_resource_unavailable_timeout_behavior": "string",
"task_resource_unavailable_wait_time_ms": "string",
},
},
"failure_policy": "string",
"input_artifacts": [{
"artifact_id": "string",
"artifact_key": "string",
}],
"parameter_values": {
"string": "string",
},
},
service_account="string",
template_uri="string")
const aiPipelineJobResource = new gcp.vertex.AiPipelineJob("aiPipelineJobResource", {
deletionPolicy: "string",
displayName: "string",
encryptionSpec: {
kmsKeyName: "string",
},
labels: {
string: "string",
},
network: "string",
pipelineJobId: "string",
pipelineSpec: "string",
preflightValidations: false,
project: "string",
pscInterfaceConfig: {
dnsPeeringConfigs: [{
domain: "string",
targetNetwork: "string",
targetProject: "string",
}],
networkAttachment: "string",
},
region: "string",
reservedIpRanges: ["string"],
runtimeConfig: {
gcsOutputDirectory: "string",
defaultRuntime: {
persistentResourceRuntimeDetail: {
persistentResourceName: "string",
taskResourceUnavailableTimeoutBehavior: "string",
taskResourceUnavailableWaitTimeMs: "string",
},
},
failurePolicy: "string",
inputArtifacts: [{
artifactId: "string",
artifactKey: "string",
}],
parameterValues: {
string: "string",
},
},
serviceAccount: "string",
templateUri: "string",
});
type: gcp:vertex:AiPipelineJob
properties:
deletionPolicy: string
displayName: string
encryptionSpec:
kmsKeyName: string
labels:
string: string
network: string
pipelineJobId: string
pipelineSpec: string
preflightValidations: false
project: string
pscInterfaceConfig:
dnsPeeringConfigs:
- domain: string
targetNetwork: string
targetProject: string
networkAttachment: string
region: string
reservedIpRanges:
- string
runtimeConfig:
defaultRuntime:
persistentResourceRuntimeDetail:
persistentResourceName: string
taskResourceUnavailableTimeoutBehavior: string
taskResourceUnavailableWaitTimeMs: string
failurePolicy: string
gcsOutputDirectory: string
inputArtifacts:
- artifactId: string
artifactKey: string
parameterValues:
string: string
serviceAccount: string
templateUri: string
AiPipelineJob 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 AiPipelineJob resource accepts the following input properties:
- Deletion
Policy string The deletion policy for the pipeline job. Setting
FORCEwill cancel the pipeline job if it is in an active state before deleting it. Defaults toDELETE.When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", Terraform will attempt to delete the pipeline job without cancelling it first, which will fail if the pipeline job is still in an active state.
- Display
Name string - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- Encryption
Spec AiPipeline Job Encryption Spec - Customer-managed encryption key options for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key. Structure is documented below.
- Labels Dictionary<string, string>
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- Network string
- The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC. Format is of the formprojects/{project}/global/networks/{network}. Where{project}is a project number, as in12345, and{network}is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. - Pipeline
Job stringId - The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated.
This value should be less than 128 characters, and valid characters are
/[a-z][0-9]-/. - Pipeline
Spec string - The spec of the pipeline. This is a JSON object that describes the pipeline.
- Preflight
Validations bool - Whether to do component level validations before job creation.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Psc
Interface AiConfig Pipeline Job Psc Interface Config - Configuration for PSC-I for PipelineJob. Structure is documented below.
- Region string
- The region of the pipeline job. eg us-central1
- Reserved
Ip List<string>Ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.
- Runtime
Config AiPipeline Job Runtime Config - Runtime config of the pipeline. Structure is documented below.
- Service
Account string - The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
- Template
Uri string - A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported.
- Deletion
Policy string The deletion policy for the pipeline job. Setting
FORCEwill cancel the pipeline job if it is in an active state before deleting it. Defaults toDELETE.When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", Terraform will attempt to delete the pipeline job without cancelling it first, which will fail if the pipeline job is still in an active state.
- Display
Name string - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- Encryption
Spec AiPipeline Job Encryption Spec Args - Customer-managed encryption key options for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key. Structure is documented below.
- Labels map[string]string
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- Network string
- The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC. Format is of the formprojects/{project}/global/networks/{network}. Where{project}is a project number, as in12345, and{network}is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. - Pipeline
Job stringId - The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated.
This value should be less than 128 characters, and valid characters are
/[a-z][0-9]-/. - Pipeline
Spec string - The spec of the pipeline. This is a JSON object that describes the pipeline.
- Preflight
Validations bool - Whether to do component level validations before job creation.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Psc
Interface AiConfig Pipeline Job Psc Interface Config Args - Configuration for PSC-I for PipelineJob. Structure is documented below.
- Region string
- The region of the pipeline job. eg us-central1
- Reserved
Ip []stringRanges - A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.
- Runtime
Config AiPipeline Job Runtime Config Args - Runtime config of the pipeline. Structure is documented below.
- Service
Account string - The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
- Template
Uri string - A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported.
- deletion_
policy string The deletion policy for the pipeline job. Setting
FORCEwill cancel the pipeline job if it is in an active state before deleting it. Defaults toDELETE.When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", Terraform will attempt to delete the pipeline job without cancelling it first, which will fail if the pipeline job is still in an active state.
- display_
name string - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- encryption_
spec object - Customer-managed encryption key options for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key. Structure is documented below.
- labels map(string)
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- network string
- The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC. Format is of the formprojects/{project}/global/networks/{network}. Where{project}is a project number, as in12345, and{network}is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. - pipeline_
job_ stringid - The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated.
This value should be less than 128 characters, and valid characters are
/[a-z][0-9]-/. - pipeline_
spec string - The spec of the pipeline. This is a JSON object that describes the pipeline.
- preflight_
validations bool - Whether to do component level validations before job creation.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- psc_
interface_ objectconfig - Configuration for PSC-I for PipelineJob. Structure is documented below.
- region string
- The region of the pipeline job. eg us-central1
- reserved_
ip_ list(string)ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.
- runtime_
config object - Runtime config of the pipeline. Structure is documented below.
- service_
account string - The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
- template_
uri string - A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported.
- deletion
Policy String The deletion policy for the pipeline job. Setting
FORCEwill cancel the pipeline job if it is in an active state before deleting it. Defaults toDELETE.When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", Terraform will attempt to delete the pipeline job without cancelling it first, which will fail if the pipeline job is still in an active state.
- display
Name String - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- encryption
Spec AiPipeline Job Encryption Spec - Customer-managed encryption key options for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key. Structure is documented below.
- labels Map<String,String>
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- network String
- The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC. Format is of the formprojects/{project}/global/networks/{network}. Where{project}is a project number, as in12345, and{network}is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. - pipeline
Job StringId - The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated.
This value should be less than 128 characters, and valid characters are
/[a-z][0-9]-/. - pipeline
Spec String - The spec of the pipeline. This is a JSON object that describes the pipeline.
- preflight
Validations Boolean - Whether to do component level validations before job creation.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- psc
Interface AiConfig Pipeline Job Psc Interface Config - Configuration for PSC-I for PipelineJob. Structure is documented below.
- region String
- The region of the pipeline job. eg us-central1
- reserved
Ip List<String>Ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.
- runtime
Config AiPipeline Job Runtime Config - Runtime config of the pipeline. Structure is documented below.
- service
Account String - The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
- template
Uri String - A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported.
- deletion
Policy string The deletion policy for the pipeline job. Setting
FORCEwill cancel the pipeline job if it is in an active state before deleting it. Defaults toDELETE.When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", Terraform will attempt to delete the pipeline job without cancelling it first, which will fail if the pipeline job is still in an active state.
- display
Name string - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- encryption
Spec AiPipeline Job Encryption Spec - Customer-managed encryption key options for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key. Structure is documented below.
- labels {[key: string]: string}
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- network string
- The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC. Format is of the formprojects/{project}/global/networks/{network}. Where{project}is a project number, as in12345, and{network}is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. - pipeline
Job stringId - The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated.
This value should be less than 128 characters, and valid characters are
/[a-z][0-9]-/. - pipeline
Spec string - The spec of the pipeline. This is a JSON object that describes the pipeline.
- preflight
Validations boolean - Whether to do component level validations before job creation.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- psc
Interface AiConfig Pipeline Job Psc Interface Config - Configuration for PSC-I for PipelineJob. Structure is documented below.
- region string
- The region of the pipeline job. eg us-central1
- reserved
Ip string[]Ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.
- runtime
Config AiPipeline Job Runtime Config - Runtime config of the pipeline. Structure is documented below.
- service
Account string - The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
- template
Uri string - A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported.
- deletion_
policy str The deletion policy for the pipeline job. Setting
FORCEwill cancel the pipeline job if it is in an active state before deleting it. Defaults toDELETE.When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", Terraform will attempt to delete the pipeline job without cancelling it first, which will fail if the pipeline job is still in an active state.
- display_
name str - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- encryption_
spec AiPipeline Job Encryption Spec Args - Customer-managed encryption key options for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key. Structure is documented below.
- labels Mapping[str, str]
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- network str
- The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC. Format is of the formprojects/{project}/global/networks/{network}. Where{project}is a project number, as in12345, and{network}is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. - pipeline_
job_ strid - The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated.
This value should be less than 128 characters, and valid characters are
/[a-z][0-9]-/. - pipeline_
spec str - The spec of the pipeline. This is a JSON object that describes the pipeline.
- preflight_
validations bool - Whether to do component level validations before job creation.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- psc_
interface_ Aiconfig Pipeline Job Psc Interface Config Args - Configuration for PSC-I for PipelineJob. Structure is documented below.
- region str
- The region of the pipeline job. eg us-central1
- reserved_
ip_ Sequence[str]ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.
- runtime_
config AiPipeline Job Runtime Config Args - Runtime config of the pipeline. Structure is documented below.
- service_
account str - The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
- template_
uri str - A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported.
- deletion
Policy String The deletion policy for the pipeline job. Setting
FORCEwill cancel the pipeline job if it is in an active state before deleting it. Defaults toDELETE.When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", Terraform will attempt to delete the pipeline job without cancelling it first, which will fail if the pipeline job is still in an active state.
- display
Name String - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- encryption
Spec Property Map - Customer-managed encryption key options for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key. Structure is documented below.
- labels Map<String>
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- network String
- The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC. Format is of the formprojects/{project}/global/networks/{network}. Where{project}is a project number, as in12345, and{network}is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. - pipeline
Job StringId - The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated.
This value should be less than 128 characters, and valid characters are
/[a-z][0-9]-/. - pipeline
Spec String - The spec of the pipeline. This is a JSON object that describes the pipeline.
- preflight
Validations Boolean - Whether to do component level validations before job creation.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- psc
Interface Property MapConfig - Configuration for PSC-I for PipelineJob. Structure is documented below.
- region String
- The region of the pipeline job. eg us-central1
- reserved
Ip List<String>Ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.
- runtime
Config Property Map - Runtime config of the pipeline. Structure is documented below.
- service
Account String - The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
- template
Uri String - A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported.
Outputs
All input properties are implicitly available as output properties. Additionally, the AiPipelineJob resource produces the following output properties:
- Create
Time string - (Output) Task create time.
- Effective
Labels Dictionary<string, string> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- End
Time string - (Output) Task end time.
- Errors
List<Ai
Pipeline Job Error> - (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- Id string
- The provider-assigned unique ID for this managed resource.
- Job
Details List<AiPipeline Job Job Detail> - The details of pipeline run. Not available in the list view. Structure is documented below.
- Name string
- (Output) The resource name of the Context.
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Schedule
Name string - The schedule resource name. Only returned if the Pipeline is created by Schedule API.
- Start
Time string - (Output) Task start time.
- State string
- (Output) The detailed state of the task.
- Template
Metadatas List<AiPipeline Job Template Metadata> - Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry. Structure is documented below.
- Update
Time string - (Output) Timestamp when this Context was last updated.
- Create
Time string - (Output) Task create time.
- Effective
Labels map[string]string - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- End
Time string - (Output) Task end time.
- Errors
[]Ai
Pipeline Job Error - (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- Id string
- The provider-assigned unique ID for this managed resource.
- Job
Details []AiPipeline Job Job Detail - The details of pipeline run. Not available in the list view. Structure is documented below.
- Name string
- (Output) The resource name of the Context.
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Schedule
Name string - The schedule resource name. Only returned if the Pipeline is created by Schedule API.
- Start
Time string - (Output) Task start time.
- State string
- (Output) The detailed state of the task.
- Template
Metadatas []AiPipeline Job Template Metadata - Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry. Structure is documented below.
- Update
Time string - (Output) Timestamp when this Context was last updated.
- create_
time string - (Output) Task create time.
- effective_
labels map(string) - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- end_
time string - (Output) Task end time.
- errors list(object)
- (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- id string
- The provider-assigned unique ID for this managed resource.
- job_
details list(object) - The details of pipeline run. Not available in the list view. Structure is documented below.
- name string
- (Output) The resource name of the Context.
- pulumi_
labels map(string) - The combination of labels configured directly on the resource and default labels configured on the provider.
- schedule_
name string - The schedule resource name. Only returned if the Pipeline is created by Schedule API.
- start_
time string - (Output) Task start time.
- state string
- (Output) The detailed state of the task.
- template_
metadatas list(object) - Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry. Structure is documented below.
- update_
time string - (Output) Timestamp when this Context was last updated.
- create
Time String - (Output) Task create time.
- effective
Labels Map<String,String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- end
Time String - (Output) Task end time.
- errors
List<Ai
Pipeline Job Error> - (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- id String
- The provider-assigned unique ID for this managed resource.
- job
Details List<AiPipeline Job Job Detail> - The details of pipeline run. Not available in the list view. Structure is documented below.
- name String
- (Output) The resource name of the Context.
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- schedule
Name String - The schedule resource name. Only returned if the Pipeline is created by Schedule API.
- start
Time String - (Output) Task start time.
- state String
- (Output) The detailed state of the task.
- template
Metadatas List<AiPipeline Job Template Metadata> - Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry. Structure is documented below.
- update
Time String - (Output) Timestamp when this Context was last updated.
- create
Time string - (Output) Task create time.
- effective
Labels {[key: string]: string} - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- end
Time string - (Output) Task end time.
- errors
Ai
Pipeline Job Error[] - (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- id string
- The provider-assigned unique ID for this managed resource.
- job
Details AiPipeline Job Job Detail[] - The details of pipeline run. Not available in the list view. Structure is documented below.
- name string
- (Output) The resource name of the Context.
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- schedule
Name string - The schedule resource name. Only returned if the Pipeline is created by Schedule API.
- start
Time string - (Output) Task start time.
- state string
- (Output) The detailed state of the task.
- template
Metadatas AiPipeline Job Template Metadata[] - Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry. Structure is documented below.
- update
Time string - (Output) Timestamp when this Context was last updated.
- create_
time str - (Output) Task create time.
- effective_
labels Mapping[str, str] - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- end_
time str - (Output) Task end time.
- errors
Sequence[Ai
Pipeline Job Error] - (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- id str
- The provider-assigned unique ID for this managed resource.
- job_
details Sequence[AiPipeline Job Job Detail] - The details of pipeline run. Not available in the list view. Structure is documented below.
- name str
- (Output) The resource name of the Context.
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- schedule_
name str - The schedule resource name. Only returned if the Pipeline is created by Schedule API.
- start_
time str - (Output) Task start time.
- state str
- (Output) The detailed state of the task.
- template_
metadatas Sequence[AiPipeline Job Template Metadata] - Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry. Structure is documented below.
- update_
time str - (Output) Timestamp when this Context was last updated.
- create
Time String - (Output) Task create time.
- effective
Labels Map<String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- end
Time String - (Output) Task end time.
- errors List<Property Map>
- (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- id String
- The provider-assigned unique ID for this managed resource.
- job
Details List<Property Map> - The details of pipeline run. Not available in the list view. Structure is documented below.
- name String
- (Output) The resource name of the Context.
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- schedule
Name String - The schedule resource name. Only returned if the Pipeline is created by Schedule API.
- start
Time String - (Output) Task start time.
- state String
- (Output) The detailed state of the task.
- template
Metadatas List<Property Map> - Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry. Structure is documented below.
- update
Time String - (Output) Timestamp when this Context was last updated.
Look up Existing AiPipelineJob Resource
Get an existing AiPipelineJob resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AiPipelineJobState, opts?: CustomResourceOptions): AiPipelineJob@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
create_time: Optional[str] = None,
deletion_policy: Optional[str] = None,
display_name: Optional[str] = None,
effective_labels: Optional[Mapping[str, str]] = None,
encryption_spec: Optional[AiPipelineJobEncryptionSpecArgs] = None,
end_time: Optional[str] = None,
errors: Optional[Sequence[AiPipelineJobErrorArgs]] = None,
job_details: Optional[Sequence[AiPipelineJobJobDetailArgs]] = None,
labels: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
network: Optional[str] = None,
pipeline_job_id: Optional[str] = None,
pipeline_spec: Optional[str] = None,
preflight_validations: Optional[bool] = None,
project: Optional[str] = None,
psc_interface_config: Optional[AiPipelineJobPscInterfaceConfigArgs] = None,
pulumi_labels: Optional[Mapping[str, str]] = None,
region: Optional[str] = None,
reserved_ip_ranges: Optional[Sequence[str]] = None,
runtime_config: Optional[AiPipelineJobRuntimeConfigArgs] = None,
schedule_name: Optional[str] = None,
service_account: Optional[str] = None,
start_time: Optional[str] = None,
state: Optional[str] = None,
template_metadatas: Optional[Sequence[AiPipelineJobTemplateMetadataArgs]] = None,
template_uri: Optional[str] = None,
update_time: Optional[str] = None) -> AiPipelineJobfunc GetAiPipelineJob(ctx *Context, name string, id IDInput, state *AiPipelineJobState, opts ...ResourceOption) (*AiPipelineJob, error)public static AiPipelineJob Get(string name, Input<string> id, AiPipelineJobState? state, CustomResourceOptions? opts = null)public static AiPipelineJob get(String name, Output<String> id, AiPipelineJobState state, CustomResourceOptions options)resources: existingAiPipelineJob: type: gcp:vertex:AiPipelineJob get: id: ${id}import {
to = gcp_vertex_ai_pipeline_job.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state AiPipelineJobState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state AiPipelineJobState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state AiPipelineJobState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state AiPipelineJobState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Create
Time string - (Output) Task create time.
- Deletion
Policy string The deletion policy for the pipeline job. Setting
FORCEwill cancel the pipeline job if it is in an active state before deleting it. Defaults toDELETE.When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", Terraform will attempt to delete the pipeline job without cancelling it first, which will fail if the pipeline job is still in an active state.
- Display
Name string - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- Effective
Labels Dictionary<string, string> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Encryption
Spec AiPipeline Job Encryption Spec - Customer-managed encryption key options for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key. Structure is documented below.
- End
Time string - (Output) Task end time.
- Errors
List<Ai
Pipeline Job Error> - (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- Job
Details List<AiPipeline Job Job Detail> - The details of pipeline run. Not available in the list view. Structure is documented below.
- Labels Dictionary<string, string>
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- Name string
- (Output) The resource name of the Context.
- Network string
- The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC. Format is of the formprojects/{project}/global/networks/{network}. Where{project}is a project number, as in12345, and{network}is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. - Pipeline
Job stringId - The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated.
This value should be less than 128 characters, and valid characters are
/[a-z][0-9]-/. - Pipeline
Spec string - The spec of the pipeline. This is a JSON object that describes the pipeline.
- Preflight
Validations bool - Whether to do component level validations before job creation.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Psc
Interface AiConfig Pipeline Job Psc Interface Config - Configuration for PSC-I for PipelineJob. Structure is documented below.
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Region string
- The region of the pipeline job. eg us-central1
- Reserved
Ip List<string>Ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.
- Runtime
Config AiPipeline Job Runtime Config - Runtime config of the pipeline. Structure is documented below.
- Schedule
Name string - The schedule resource name. Only returned if the Pipeline is created by Schedule API.
- Service
Account string - The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
- Start
Time string - (Output) Task start time.
- State string
- (Output) The detailed state of the task.
- Template
Metadatas List<AiPipeline Job Template Metadata> - Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry. Structure is documented below.
- Template
Uri string - A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported.
- Update
Time string - (Output) Timestamp when this Context was last updated.
- Create
Time string - (Output) Task create time.
- Deletion
Policy string The deletion policy for the pipeline job. Setting
FORCEwill cancel the pipeline job if it is in an active state before deleting it. Defaults toDELETE.When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", Terraform will attempt to delete the pipeline job without cancelling it first, which will fail if the pipeline job is still in an active state.
- Display
Name string - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- Effective
Labels map[string]string - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Encryption
Spec AiPipeline Job Encryption Spec Args - Customer-managed encryption key options for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key. Structure is documented below.
- End
Time string - (Output) Task end time.
- Errors
[]Ai
Pipeline Job Error Args - (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- Job
Details []AiPipeline Job Job Detail Args - The details of pipeline run. Not available in the list view. Structure is documented below.
- Labels map[string]string
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- Name string
- (Output) The resource name of the Context.
- Network string
- The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC. Format is of the formprojects/{project}/global/networks/{network}. Where{project}is a project number, as in12345, and{network}is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. - Pipeline
Job stringId - The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated.
This value should be less than 128 characters, and valid characters are
/[a-z][0-9]-/. - Pipeline
Spec string - The spec of the pipeline. This is a JSON object that describes the pipeline.
- Preflight
Validations bool - Whether to do component level validations before job creation.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Psc
Interface AiConfig Pipeline Job Psc Interface Config Args - Configuration for PSC-I for PipelineJob. Structure is documented below.
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Region string
- The region of the pipeline job. eg us-central1
- Reserved
Ip []stringRanges - A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.
- Runtime
Config AiPipeline Job Runtime Config Args - Runtime config of the pipeline. Structure is documented below.
- Schedule
Name string - The schedule resource name. Only returned if the Pipeline is created by Schedule API.
- Service
Account string - The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
- Start
Time string - (Output) Task start time.
- State string
- (Output) The detailed state of the task.
- Template
Metadatas []AiPipeline Job Template Metadata Args - Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry. Structure is documented below.
- Template
Uri string - A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported.
- Update
Time string - (Output) Timestamp when this Context was last updated.
- create_
time string - (Output) Task create time.
- deletion_
policy string The deletion policy for the pipeline job. Setting
FORCEwill cancel the pipeline job if it is in an active state before deleting it. Defaults toDELETE.When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", Terraform will attempt to delete the pipeline job without cancelling it first, which will fail if the pipeline job is still in an active state.
- display_
name string - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- effective_
labels map(string) - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- encryption_
spec object - Customer-managed encryption key options for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key. Structure is documented below.
- end_
time string - (Output) Task end time.
- errors list(object)
- (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- job_
details list(object) - The details of pipeline run. Not available in the list view. Structure is documented below.
- labels map(string)
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- name string
- (Output) The resource name of the Context.
- network string
- The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC. Format is of the formprojects/{project}/global/networks/{network}. Where{project}is a project number, as in12345, and{network}is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. - pipeline_
job_ stringid - The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated.
This value should be less than 128 characters, and valid characters are
/[a-z][0-9]-/. - pipeline_
spec string - The spec of the pipeline. This is a JSON object that describes the pipeline.
- preflight_
validations bool - Whether to do component level validations before job creation.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- psc_
interface_ objectconfig - Configuration for PSC-I for PipelineJob. Structure is documented below.
- pulumi_
labels map(string) - The combination of labels configured directly on the resource and default labels configured on the provider.
- region string
- The region of the pipeline job. eg us-central1
- reserved_
ip_ list(string)ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.
- runtime_
config object - Runtime config of the pipeline. Structure is documented below.
- schedule_
name string - The schedule resource name. Only returned if the Pipeline is created by Schedule API.
- service_
account string - The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
- start_
time string - (Output) Task start time.
- state string
- (Output) The detailed state of the task.
- template_
metadatas list(object) - Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry. Structure is documented below.
- template_
uri string - A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported.
- update_
time string - (Output) Timestamp when this Context was last updated.
- create
Time String - (Output) Task create time.
- deletion
Policy String The deletion policy for the pipeline job. Setting
FORCEwill cancel the pipeline job if it is in an active state before deleting it. Defaults toDELETE.When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", Terraform will attempt to delete the pipeline job without cancelling it first, which will fail if the pipeline job is still in an active state.
- display
Name String - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- effective
Labels Map<String,String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- encryption
Spec AiPipeline Job Encryption Spec - Customer-managed encryption key options for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key. Structure is documented below.
- end
Time String - (Output) Task end time.
- errors
List<Ai
Pipeline Job Error> - (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- job
Details List<AiPipeline Job Job Detail> - The details of pipeline run. Not available in the list view. Structure is documented below.
- labels Map<String,String>
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- name String
- (Output) The resource name of the Context.
- network String
- The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC. Format is of the formprojects/{project}/global/networks/{network}. Where{project}is a project number, as in12345, and{network}is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. - pipeline
Job StringId - The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated.
This value should be less than 128 characters, and valid characters are
/[a-z][0-9]-/. - pipeline
Spec String - The spec of the pipeline. This is a JSON object that describes the pipeline.
- preflight
Validations Boolean - Whether to do component level validations before job creation.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- psc
Interface AiConfig Pipeline Job Psc Interface Config - Configuration for PSC-I for PipelineJob. Structure is documented below.
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- region String
- The region of the pipeline job. eg us-central1
- reserved
Ip List<String>Ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.
- runtime
Config AiPipeline Job Runtime Config - Runtime config of the pipeline. Structure is documented below.
- schedule
Name String - The schedule resource name. Only returned if the Pipeline is created by Schedule API.
- service
Account String - The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
- start
Time String - (Output) Task start time.
- state String
- (Output) The detailed state of the task.
- template
Metadatas List<AiPipeline Job Template Metadata> - Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry. Structure is documented below.
- template
Uri String - A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported.
- update
Time String - (Output) Timestamp when this Context was last updated.
- create
Time string - (Output) Task create time.
- deletion
Policy string The deletion policy for the pipeline job. Setting
FORCEwill cancel the pipeline job if it is in an active state before deleting it. Defaults toDELETE.When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", Terraform will attempt to delete the pipeline job without cancelling it first, which will fail if the pipeline job is still in an active state.
- display
Name string - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- effective
Labels {[key: string]: string} - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- encryption
Spec AiPipeline Job Encryption Spec - Customer-managed encryption key options for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key. Structure is documented below.
- end
Time string - (Output) Task end time.
- errors
Ai
Pipeline Job Error[] - (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- job
Details AiPipeline Job Job Detail[] - The details of pipeline run. Not available in the list view. Structure is documented below.
- labels {[key: string]: string}
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- name string
- (Output) The resource name of the Context.
- network string
- The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC. Format is of the formprojects/{project}/global/networks/{network}. Where{project}is a project number, as in12345, and{network}is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. - pipeline
Job stringId - The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated.
This value should be less than 128 characters, and valid characters are
/[a-z][0-9]-/. - pipeline
Spec string - The spec of the pipeline. This is a JSON object that describes the pipeline.
- preflight
Validations boolean - Whether to do component level validations before job creation.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- psc
Interface AiConfig Pipeline Job Psc Interface Config - Configuration for PSC-I for PipelineJob. Structure is documented below.
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- region string
- The region of the pipeline job. eg us-central1
- reserved
Ip string[]Ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.
- runtime
Config AiPipeline Job Runtime Config - Runtime config of the pipeline. Structure is documented below.
- schedule
Name string - The schedule resource name. Only returned if the Pipeline is created by Schedule API.
- service
Account string - The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
- start
Time string - (Output) Task start time.
- state string
- (Output) The detailed state of the task.
- template
Metadatas AiPipeline Job Template Metadata[] - Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry. Structure is documented below.
- template
Uri string - A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported.
- update
Time string - (Output) Timestamp when this Context was last updated.
- create_
time str - (Output) Task create time.
- deletion_
policy str The deletion policy for the pipeline job. Setting
FORCEwill cancel the pipeline job if it is in an active state before deleting it. Defaults toDELETE.When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", Terraform will attempt to delete the pipeline job without cancelling it first, which will fail if the pipeline job is still in an active state.
- display_
name str - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- effective_
labels Mapping[str, str] - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- encryption_
spec AiPipeline Job Encryption Spec Args - Customer-managed encryption key options for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key. Structure is documented below.
- end_
time str - (Output) Task end time.
- errors
Sequence[Ai
Pipeline Job Error Args] - (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- job_
details Sequence[AiPipeline Job Job Detail Args] - The details of pipeline run. Not available in the list view. Structure is documented below.
- labels Mapping[str, str]
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- name str
- (Output) The resource name of the Context.
- network str
- The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC. Format is of the formprojects/{project}/global/networks/{network}. Where{project}is a project number, as in12345, and{network}is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. - pipeline_
job_ strid - The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated.
This value should be less than 128 characters, and valid characters are
/[a-z][0-9]-/. - pipeline_
spec str - The spec of the pipeline. This is a JSON object that describes the pipeline.
- preflight_
validations bool - Whether to do component level validations before job creation.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- psc_
interface_ Aiconfig Pipeline Job Psc Interface Config Args - Configuration for PSC-I for PipelineJob. Structure is documented below.
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- region str
- The region of the pipeline job. eg us-central1
- reserved_
ip_ Sequence[str]ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.
- runtime_
config AiPipeline Job Runtime Config Args - Runtime config of the pipeline. Structure is documented below.
- schedule_
name str - The schedule resource name. Only returned if the Pipeline is created by Schedule API.
- service_
account str - The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
- start_
time str - (Output) Task start time.
- state str
- (Output) The detailed state of the task.
- template_
metadatas Sequence[AiPipeline Job Template Metadata Args] - Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry. Structure is documented below.
- template_
uri str - A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported.
- update_
time str - (Output) Timestamp when this Context was last updated.
- create
Time String - (Output) Task create time.
- deletion
Policy String The deletion policy for the pipeline job. Setting
FORCEwill cancel the pipeline job if it is in an active state before deleting it. Defaults toDELETE.When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", Terraform will attempt to delete the pipeline job without cancelling it first, which will fail if the pipeline job is still in an active state.
- display
Name String - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- effective
Labels Map<String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- encryption
Spec Property Map - Customer-managed encryption key options for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key. Structure is documented below.
- end
Time String - (Output) Task end time.
- errors List<Property Map>
- (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- job
Details List<Property Map> - The details of pipeline run. Not available in the list view. Structure is documented below.
- labels Map<String>
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- name String
- (Output) The resource name of the Context.
- network String
- The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example,
projects/12345/global/networks/myVPC. Format is of the formprojects/{project}/global/networks/{network}. Where{project}is a project number, as in12345, and{network}is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. - pipeline
Job StringId - The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated.
This value should be less than 128 characters, and valid characters are
/[a-z][0-9]-/. - pipeline
Spec String - The spec of the pipeline. This is a JSON object that describes the pipeline.
- preflight
Validations Boolean - Whether to do component level validations before job creation.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- psc
Interface Property MapConfig - Configuration for PSC-I for PipelineJob. Structure is documented below.
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- region String
- The region of the pipeline job. eg us-central1
- reserved
Ip List<String>Ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network.
- runtime
Config Property Map - Runtime config of the pipeline. Structure is documented below.
- schedule
Name String - The schedule resource name. Only returned if the Pipeline is created by Schedule API.
- service
Account String - The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
- start
Time String - (Output) Task start time.
- state String
- (Output) The detailed state of the task.
- template
Metadatas List<Property Map> - Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry. Structure is documented below.
- template
Uri String - A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported.
- update
Time String - (Output) Timestamp when this Context was last updated.
Supporting Types
AiPipelineJobEncryptionSpec, AiPipelineJobEncryptionSpecArgs
- Kms
Key stringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- Kms
Key stringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- kms_
key_ stringname - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- kms
Key StringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- kms
Key stringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- kms_
key_ strname - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
- kms
Key StringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
AiPipelineJobError, AiPipelineJobErrorArgs
AiPipelineJobJobDetail, AiPipelineJobJobDetailArgs
- Pipeline
Contexts List<AiPipeline Job Job Detail Pipeline Context> - (Output) The context of the pipeline. Structure is documented below.
- Pipeline
Run List<AiContexts Pipeline Job Job Detail Pipeline Run Context> - (Output) The context of the current pipeline run. Structure is documented below.
- Task
Details List<AiPipeline Job Job Detail Task Detail> - (Output) The runtime details of the tasks under the pipeline. Structure is documented below.
- Pipeline
Contexts []AiPipeline Job Job Detail Pipeline Context - (Output) The context of the pipeline. Structure is documented below.
- Pipeline
Run []AiContexts Pipeline Job Job Detail Pipeline Run Context - (Output) The context of the current pipeline run. Structure is documented below.
- Task
Details []AiPipeline Job Job Detail Task Detail - (Output) The runtime details of the tasks under the pipeline. Structure is documented below.
- pipeline_
contexts list(object) - (Output) The context of the pipeline. Structure is documented below.
- pipeline_
run_ list(object)contexts - (Output) The context of the current pipeline run. Structure is documented below.
- task_
details list(object) - (Output) The runtime details of the tasks under the pipeline. Structure is documented below.
- pipeline
Contexts List<AiPipeline Job Job Detail Pipeline Context> - (Output) The context of the pipeline. Structure is documented below.
- pipeline
Run List<AiContexts Pipeline Job Job Detail Pipeline Run Context> - (Output) The context of the current pipeline run. Structure is documented below.
- task
Details List<AiPipeline Job Job Detail Task Detail> - (Output) The runtime details of the tasks under the pipeline. Structure is documented below.
- pipeline
Contexts AiPipeline Job Job Detail Pipeline Context[] - (Output) The context of the pipeline. Structure is documented below.
- pipeline
Run AiContexts Pipeline Job Job Detail Pipeline Run Context[] - (Output) The context of the current pipeline run. Structure is documented below.
- task
Details AiPipeline Job Job Detail Task Detail[] - (Output) The runtime details of the tasks under the pipeline. Structure is documented below.
- pipeline_
contexts Sequence[AiPipeline Job Job Detail Pipeline Context] - (Output) The context of the pipeline. Structure is documented below.
- pipeline_
run_ Sequence[Aicontexts Pipeline Job Job Detail Pipeline Run Context] - (Output) The context of the current pipeline run. Structure is documented below.
- task_
details Sequence[AiPipeline Job Job Detail Task Detail] - (Output) The runtime details of the tasks under the pipeline. Structure is documented below.
- pipeline
Contexts List<Property Map> - (Output) The context of the pipeline. Structure is documented below.
- pipeline
Run List<Property Map>Contexts - (Output) The context of the current pipeline run. Structure is documented below.
- task
Details List<Property Map> - (Output) The runtime details of the tasks under the pipeline. Structure is documented below.
AiPipelineJobJobDetailPipelineContext, AiPipelineJobJobDetailPipelineContextArgs
- Create
Time string - (Output) Task create time.
- Description string
- (Output) Description of the Context.
- Display
Name string - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- Etag string
- (Output) An eTag used to perform consistent read-modify-write updates.
- Labels Dictionary<string, string>
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- Metadata string
- (Output) Properties of the Context.
- Name string
- (Output) The resource name of the Context.
- Parent
Contexts List<string> - (Output) A list of resource names of Contexts that are parents of this Context.
- Schema
Title string - (Output) The title of the schema describing the metadata.
- Schema
Version string - (Output) The version of the schema in schemaName to use.
- Update
Time string - (Output) Timestamp when this Context was last updated.
- Create
Time string - (Output) Task create time.
- Description string
- (Output) Description of the Context.
- Display
Name string - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- Etag string
- (Output) An eTag used to perform consistent read-modify-write updates.
- Labels map[string]string
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- Metadata string
- (Output) Properties of the Context.
- Name string
- (Output) The resource name of the Context.
- Parent
Contexts []string - (Output) A list of resource names of Contexts that are parents of this Context.
- Schema
Title string - (Output) The title of the schema describing the metadata.
- Schema
Version string - (Output) The version of the schema in schemaName to use.
- Update
Time string - (Output) Timestamp when this Context was last updated.
- create_
time string - (Output) Task create time.
- description string
- (Output) Description of the Context.
- display_
name string - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- etag string
- (Output) An eTag used to perform consistent read-modify-write updates.
- labels map(string)
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- metadata string
- (Output) Properties of the Context.
- name string
- (Output) The resource name of the Context.
- parent_
contexts list(string) - (Output) A list of resource names of Contexts that are parents of this Context.
- schema_
title string - (Output) The title of the schema describing the metadata.
- schema_
version string - (Output) The version of the schema in schemaName to use.
- update_
time string - (Output) Timestamp when this Context was last updated.
- create
Time String - (Output) Task create time.
- description String
- (Output) Description of the Context.
- display
Name String - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- etag String
- (Output) An eTag used to perform consistent read-modify-write updates.
- labels Map<String,String>
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- metadata String
- (Output) Properties of the Context.
- name String
- (Output) The resource name of the Context.
- parent
Contexts List<String> - (Output) A list of resource names of Contexts that are parents of this Context.
- schema
Title String - (Output) The title of the schema describing the metadata.
- schema
Version String - (Output) The version of the schema in schemaName to use.
- update
Time String - (Output) Timestamp when this Context was last updated.
- create
Time string - (Output) Task create time.
- description string
- (Output) Description of the Context.
- display
Name string - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- etag string
- (Output) An eTag used to perform consistent read-modify-write updates.
- labels {[key: string]: string}
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- metadata string
- (Output) Properties of the Context.
- name string
- (Output) The resource name of the Context.
- parent
Contexts string[] - (Output) A list of resource names of Contexts that are parents of this Context.
- schema
Title string - (Output) The title of the schema describing the metadata.
- schema
Version string - (Output) The version of the schema in schemaName to use.
- update
Time string - (Output) Timestamp when this Context was last updated.
- create_
time str - (Output) Task create time.
- description str
- (Output) Description of the Context.
- display_
name str - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- etag str
- (Output) An eTag used to perform consistent read-modify-write updates.
- labels Mapping[str, str]
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- metadata str
- (Output) Properties of the Context.
- name str
- (Output) The resource name of the Context.
- parent_
contexts Sequence[str] - (Output) A list of resource names of Contexts that are parents of this Context.
- schema_
title str - (Output) The title of the schema describing the metadata.
- schema_
version str - (Output) The version of the schema in schemaName to use.
- update_
time str - (Output) Timestamp when this Context was last updated.
- create
Time String - (Output) Task create time.
- description String
- (Output) Description of the Context.
- display
Name String - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- etag String
- (Output) An eTag used to perform consistent read-modify-write updates.
- labels Map<String>
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- metadata String
- (Output) Properties of the Context.
- name String
- (Output) The resource name of the Context.
- parent
Contexts List<String> - (Output) A list of resource names of Contexts that are parents of this Context.
- schema
Title String - (Output) The title of the schema describing the metadata.
- schema
Version String - (Output) The version of the schema in schemaName to use.
- update
Time String - (Output) Timestamp when this Context was last updated.
AiPipelineJobJobDetailPipelineRunContext, AiPipelineJobJobDetailPipelineRunContextArgs
- Create
Time string - (Output) Task create time.
- Description string
- (Output) Description of the Context.
- Display
Name string - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- Etag string
- (Output) An eTag used to perform consistent read-modify-write updates.
- Labels Dictionary<string, string>
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- Metadata string
- (Output) Properties of the Context.
- Name string
- (Output) The resource name of the Context.
- Parent
Contexts List<string> - (Output) A list of resource names of Contexts that are parents of this Context.
- Schema
Title string - (Output) The title of the schema describing the metadata.
- Schema
Version string - (Output) The version of the schema in schemaName to use.
- Update
Time string - (Output) Timestamp when this Context was last updated.
- Create
Time string - (Output) Task create time.
- Description string
- (Output) Description of the Context.
- Display
Name string - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- Etag string
- (Output) An eTag used to perform consistent read-modify-write updates.
- Labels map[string]string
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- Metadata string
- (Output) Properties of the Context.
- Name string
- (Output) The resource name of the Context.
- Parent
Contexts []string - (Output) A list of resource names of Contexts that are parents of this Context.
- Schema
Title string - (Output) The title of the schema describing the metadata.
- Schema
Version string - (Output) The version of the schema in schemaName to use.
- Update
Time string - (Output) Timestamp when this Context was last updated.
- create_
time string - (Output) Task create time.
- description string
- (Output) Description of the Context.
- display_
name string - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- etag string
- (Output) An eTag used to perform consistent read-modify-write updates.
- labels map(string)
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- metadata string
- (Output) Properties of the Context.
- name string
- (Output) The resource name of the Context.
- parent_
contexts list(string) - (Output) A list of resource names of Contexts that are parents of this Context.
- schema_
title string - (Output) The title of the schema describing the metadata.
- schema_
version string - (Output) The version of the schema in schemaName to use.
- update_
time string - (Output) Timestamp when this Context was last updated.
- create
Time String - (Output) Task create time.
- description String
- (Output) Description of the Context.
- display
Name String - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- etag String
- (Output) An eTag used to perform consistent read-modify-write updates.
- labels Map<String,String>
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- metadata String
- (Output) Properties of the Context.
- name String
- (Output) The resource name of the Context.
- parent
Contexts List<String> - (Output) A list of resource names of Contexts that are parents of this Context.
- schema
Title String - (Output) The title of the schema describing the metadata.
- schema
Version String - (Output) The version of the schema in schemaName to use.
- update
Time String - (Output) Timestamp when this Context was last updated.
- create
Time string - (Output) Task create time.
- description string
- (Output) Description of the Context.
- display
Name string - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- etag string
- (Output) An eTag used to perform consistent read-modify-write updates.
- labels {[key: string]: string}
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- metadata string
- (Output) Properties of the Context.
- name string
- (Output) The resource name of the Context.
- parent
Contexts string[] - (Output) A list of resource names of Contexts that are parents of this Context.
- schema
Title string - (Output) The title of the schema describing the metadata.
- schema
Version string - (Output) The version of the schema in schemaName to use.
- update
Time string - (Output) Timestamp when this Context was last updated.
- create_
time str - (Output) Task create time.
- description str
- (Output) Description of the Context.
- display_
name str - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- etag str
- (Output) An eTag used to perform consistent read-modify-write updates.
- labels Mapping[str, str]
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- metadata str
- (Output) Properties of the Context.
- name str
- (Output) The resource name of the Context.
- parent_
contexts Sequence[str] - (Output) A list of resource names of Contexts that are parents of this Context.
- schema_
title str - (Output) The title of the schema describing the metadata.
- schema_
version str - (Output) The version of the schema in schemaName to use.
- update_
time str - (Output) Timestamp when this Context was last updated.
- create
Time String - (Output) Task create time.
- description String
- (Output) Description of the Context.
- display
Name String - The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- etag String
- (Output) An eTag used to perform consistent read-modify-write updates.
- labels Map<String>
The labels with user-defined metadata to organize PipelineJob.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effectiveLabelsfor all of the labels present on the resource.- metadata String
- (Output) Properties of the Context.
- name String
- (Output) The resource name of the Context.
- parent
Contexts List<String> - (Output) A list of resource names of Contexts that are parents of this Context.
- schema
Title String - (Output) The title of the schema describing the metadata.
- schema
Version String - (Output) The version of the schema in schemaName to use.
- update
Time String - (Output) Timestamp when this Context was last updated.
AiPipelineJobJobDetailTaskDetail, AiPipelineJobJobDetailTaskDetailArgs
- Create
Time string - (Output) Task create time.
- End
Time string - (Output) Task end time.
- Errors
List<Ai
Pipeline Job Job Detail Task Detail Error> - (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- Parent
Task stringId - (Output) The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
- Start
Time string - (Output) Task start time.
- State string
- (Output) The detailed state of the task.
- Task
Id string - (Output) The system generated ID of the task.
- Task
Name string - (Output) The user specified name of the task that is defined in pipeline_spec.
- Task
Unique stringName - (Output) The unique name of a task.
- Create
Time string - (Output) Task create time.
- End
Time string - (Output) Task end time.
- Errors
[]Ai
Pipeline Job Job Detail Task Detail Error - (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- Parent
Task stringId - (Output) The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
- Start
Time string - (Output) Task start time.
- State string
- (Output) The detailed state of the task.
- Task
Id string - (Output) The system generated ID of the task.
- Task
Name string - (Output) The user specified name of the task that is defined in pipeline_spec.
- Task
Unique stringName - (Output) The unique name of a task.
- create_
time string - (Output) Task create time.
- end_
time string - (Output) Task end time.
- errors list(object)
- (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- parent_
task_ stringid - (Output) The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
- start_
time string - (Output) Task start time.
- state string
- (Output) The detailed state of the task.
- task_
id string - (Output) The system generated ID of the task.
- task_
name string - (Output) The user specified name of the task that is defined in pipeline_spec.
- task_
unique_ stringname - (Output) The unique name of a task.
- create
Time String - (Output) Task create time.
- end
Time String - (Output) Task end time.
- errors
List<Ai
Pipeline Job Job Detail Task Detail Error> - (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- parent
Task StringId - (Output) The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
- start
Time String - (Output) Task start time.
- state String
- (Output) The detailed state of the task.
- task
Id String - (Output) The system generated ID of the task.
- task
Name String - (Output) The user specified name of the task that is defined in pipeline_spec.
- task
Unique StringName - (Output) The unique name of a task.
- create
Time string - (Output) Task create time.
- end
Time string - (Output) Task end time.
- errors
Ai
Pipeline Job Job Detail Task Detail Error[] - (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- parent
Task stringId - (Output) The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
- start
Time string - (Output) Task start time.
- state string
- (Output) The detailed state of the task.
- task
Id string - (Output) The system generated ID of the task.
- task
Name string - (Output) The user specified name of the task that is defined in pipeline_spec.
- task
Unique stringName - (Output) The unique name of a task.
- create_
time str - (Output) Task create time.
- end_
time str - (Output) Task end time.
- errors
Sequence[Ai
Pipeline Job Job Detail Task Detail Error] - (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- parent_
task_ strid - (Output) The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
- start_
time str - (Output) Task start time.
- state str
- (Output) The detailed state of the task.
- task_
id str - (Output) The system generated ID of the task.
- task_
name str - (Output) The user specified name of the task that is defined in pipeline_spec.
- task_
unique_ strname - (Output) The unique name of a task.
- create
Time String - (Output) Task create time.
- end
Time String - (Output) Task end time.
- errors List<Property Map>
- (Output) The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED. Structure is documented below.
- parent
Task StringId - (Output) The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
- start
Time String - (Output) Task start time.
- state String
- (Output) The detailed state of the task.
- task
Id String - (Output) The system generated ID of the task.
- task
Name String - (Output) The user specified name of the task that is defined in pipeline_spec.
- task
Unique StringName - (Output) The unique name of a task.
AiPipelineJobJobDetailTaskDetailError, AiPipelineJobJobDetailTaskDetailErrorArgs
AiPipelineJobPscInterfaceConfig, AiPipelineJobPscInterfaceConfigArgs
- Dns
Peering List<AiConfigs Pipeline Job Psc Interface Config Dns Peering Config> - DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project. Structure is documented below.
- Network
Attachment string - The name of the Compute Engine network attachment to attach to the resource within the region and user project. To specify this field, you must have already created a network attachment. This field is only used for resources using PSC-I.
- Dns
Peering []AiConfigs Pipeline Job Psc Interface Config Dns Peering Config - DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project. Structure is documented below.
- Network
Attachment string - The name of the Compute Engine network attachment to attach to the resource within the region and user project. To specify this field, you must have already created a network attachment. This field is only used for resources using PSC-I.
- dns_
peering_ list(object)configs - DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project. Structure is documented below.
- network_
attachment string - The name of the Compute Engine network attachment to attach to the resource within the region and user project. To specify this field, you must have already created a network attachment. This field is only used for resources using PSC-I.
- dns
Peering List<AiConfigs Pipeline Job Psc Interface Config Dns Peering Config> - DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project. Structure is documented below.
- network
Attachment String - The name of the Compute Engine network attachment to attach to the resource within the region and user project. To specify this field, you must have already created a network attachment. This field is only used for resources using PSC-I.
- dns
Peering AiConfigs Pipeline Job Psc Interface Config Dns Peering Config[] - DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project. Structure is documented below.
- network
Attachment string - The name of the Compute Engine network attachment to attach to the resource within the region and user project. To specify this field, you must have already created a network attachment. This field is only used for resources using PSC-I.
- dns_
peering_ Sequence[Aiconfigs Pipeline Job Psc Interface Config Dns Peering Config] - DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project. Structure is documented below.
- network_
attachment str - The name of the Compute Engine network attachment to attach to the resource within the region and user project. To specify this field, you must have already created a network attachment. This field is only used for resources using PSC-I.
- dns
Peering List<Property Map>Configs - DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project. Structure is documented below.
- network
Attachment String - The name of the Compute Engine network attachment to attach to the resource within the region and user project. To specify this field, you must have already created a network attachment. This field is only used for resources using PSC-I.
AiPipelineJobPscInterfaceConfigDnsPeeringConfig, AiPipelineJobPscInterfaceConfigDnsPeeringConfigArgs
- Domain string
- The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
- Target
Network string - The VPC network name in the targetProject where the DNS zone specified by domain is visible.
- Target
Project string - The project ID hosting the Cloud DNS managed zone that contains the above domain. The Vertex AI Service Agent must be granted the dns.peer role on this project.
- Domain string
- The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
- Target
Network string - The VPC network name in the targetProject where the DNS zone specified by domain is visible.
- Target
Project string - The project ID hosting the Cloud DNS managed zone that contains the above domain. The Vertex AI Service Agent must be granted the dns.peer role on this project.
- domain string
- The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
- target_
network string - The VPC network name in the targetProject where the DNS zone specified by domain is visible.
- target_
project string - The project ID hosting the Cloud DNS managed zone that contains the above domain. The Vertex AI Service Agent must be granted the dns.peer role on this project.
- domain String
- The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
- target
Network String - The VPC network name in the targetProject where the DNS zone specified by domain is visible.
- target
Project String - The project ID hosting the Cloud DNS managed zone that contains the above domain. The Vertex AI Service Agent must be granted the dns.peer role on this project.
- domain string
- The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
- target
Network string - The VPC network name in the targetProject where the DNS zone specified by domain is visible.
- target
Project string - The project ID hosting the Cloud DNS managed zone that contains the above domain. The Vertex AI Service Agent must be granted the dns.peer role on this project.
- domain str
- The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
- target_
network str - The VPC network name in the targetProject where the DNS zone specified by domain is visible.
- target_
project str - The project ID hosting the Cloud DNS managed zone that contains the above domain. The Vertex AI Service Agent must be granted the dns.peer role on this project.
- domain String
- The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
- target
Network String - The VPC network name in the targetProject where the DNS zone specified by domain is visible.
- target
Project String - The project ID hosting the Cloud DNS managed zone that contains the above domain. The Vertex AI Service Agent must be granted the dns.peer role on this project.
AiPipelineJobRuntimeConfig, AiPipelineJobRuntimeConfigArgs
- Gcs
Output stringDirectory - A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-directory pattern
{job_id}/{task_id}/{output_key}under the specified output directory. The service account specified in this pipeline must have thestorage.objects.getandstorage.objects.createpermissions for this bucket. - Default
Runtime AiPipeline Job Runtime Config Default Runtime - (Optional, Beta) The default runtime for the PipelineJob. Structure is documented below.
- Failure
Policy string - Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as
PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set toPIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks as soon as the pipeline fails. Possible values are:PIPELINE_FAILURE_POLICY_UNSPECIFIED,PIPELINE_FAILURE_POLICY_FAIL_SLOW,PIPELINE_FAILURE_POLICY_FAIL_FAST. - Input
Artifacts List<AiPipeline Job Runtime Config Input Artifact> - The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact. Structure is documented below.
- Parameter
Values Dictionary<string, string> - The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using
PipelineJob.pipeline_spec.schema_version2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
- Gcs
Output stringDirectory - A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-directory pattern
{job_id}/{task_id}/{output_key}under the specified output directory. The service account specified in this pipeline must have thestorage.objects.getandstorage.objects.createpermissions for this bucket. - Default
Runtime AiPipeline Job Runtime Config Default Runtime - (Optional, Beta) The default runtime for the PipelineJob. Structure is documented below.
- Failure
Policy string - Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as
PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set toPIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks as soon as the pipeline fails. Possible values are:PIPELINE_FAILURE_POLICY_UNSPECIFIED,PIPELINE_FAILURE_POLICY_FAIL_SLOW,PIPELINE_FAILURE_POLICY_FAIL_FAST. - Input
Artifacts []AiPipeline Job Runtime Config Input Artifact - The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact. Structure is documented below.
- Parameter
Values map[string]string - The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using
PipelineJob.pipeline_spec.schema_version2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
- gcs_
output_ stringdirectory - A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-directory pattern
{job_id}/{task_id}/{output_key}under the specified output directory. The service account specified in this pipeline must have thestorage.objects.getandstorage.objects.createpermissions for this bucket. - default_
runtime object - (Optional, Beta) The default runtime for the PipelineJob. Structure is documented below.
- failure_
policy string - Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as
PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set toPIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks as soon as the pipeline fails. Possible values are:PIPELINE_FAILURE_POLICY_UNSPECIFIED,PIPELINE_FAILURE_POLICY_FAIL_SLOW,PIPELINE_FAILURE_POLICY_FAIL_FAST. - input_
artifacts list(object) - The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact. Structure is documented below.
- parameter_
values map(string) - The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using
PipelineJob.pipeline_spec.schema_version2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
- gcs
Output StringDirectory - A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-directory pattern
{job_id}/{task_id}/{output_key}under the specified output directory. The service account specified in this pipeline must have thestorage.objects.getandstorage.objects.createpermissions for this bucket. - default
Runtime AiPipeline Job Runtime Config Default Runtime - (Optional, Beta) The default runtime for the PipelineJob. Structure is documented below.
- failure
Policy String - Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as
PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set toPIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks as soon as the pipeline fails. Possible values are:PIPELINE_FAILURE_POLICY_UNSPECIFIED,PIPELINE_FAILURE_POLICY_FAIL_SLOW,PIPELINE_FAILURE_POLICY_FAIL_FAST. - input
Artifacts List<AiPipeline Job Runtime Config Input Artifact> - The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact. Structure is documented below.
- parameter
Values Map<String,String> - The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using
PipelineJob.pipeline_spec.schema_version2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
- gcs
Output stringDirectory - A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-directory pattern
{job_id}/{task_id}/{output_key}under the specified output directory. The service account specified in this pipeline must have thestorage.objects.getandstorage.objects.createpermissions for this bucket. - default
Runtime AiPipeline Job Runtime Config Default Runtime - (Optional, Beta) The default runtime for the PipelineJob. Structure is documented below.
- failure
Policy string - Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as
PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set toPIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks as soon as the pipeline fails. Possible values are:PIPELINE_FAILURE_POLICY_UNSPECIFIED,PIPELINE_FAILURE_POLICY_FAIL_SLOW,PIPELINE_FAILURE_POLICY_FAIL_FAST. - input
Artifacts AiPipeline Job Runtime Config Input Artifact[] - The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact. Structure is documented below.
- parameter
Values {[key: string]: string} - The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using
PipelineJob.pipeline_spec.schema_version2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
- gcs_
output_ strdirectory - A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-directory pattern
{job_id}/{task_id}/{output_key}under the specified output directory. The service account specified in this pipeline must have thestorage.objects.getandstorage.objects.createpermissions for this bucket. - default_
runtime AiPipeline Job Runtime Config Default Runtime - (Optional, Beta) The default runtime for the PipelineJob. Structure is documented below.
- failure_
policy str - Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as
PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set toPIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks as soon as the pipeline fails. Possible values are:PIPELINE_FAILURE_POLICY_UNSPECIFIED,PIPELINE_FAILURE_POLICY_FAIL_SLOW,PIPELINE_FAILURE_POLICY_FAIL_FAST. - input_
artifacts Sequence[AiPipeline Job Runtime Config Input Artifact] - The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact. Structure is documented below.
- parameter_
values Mapping[str, str] - The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using
PipelineJob.pipeline_spec.schema_version2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
- gcs
Output StringDirectory - A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-directory pattern
{job_id}/{task_id}/{output_key}under the specified output directory. The service account specified in this pipeline must have thestorage.objects.getandstorage.objects.createpermissions for this bucket. - default
Runtime Property Map - (Optional, Beta) The default runtime for the PipelineJob. Structure is documented below.
- failure
Policy String - Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as
PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set toPIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks as soon as the pipeline fails. Possible values are:PIPELINE_FAILURE_POLICY_UNSPECIFIED,PIPELINE_FAILURE_POLICY_FAIL_SLOW,PIPELINE_FAILURE_POLICY_FAIL_FAST. - input
Artifacts List<Property Map> - The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact. Structure is documented below.
- parameter
Values Map<String> - The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using
PipelineJob.pipeline_spec.schema_version2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
AiPipelineJobRuntimeConfigDefaultRuntime, AiPipelineJobRuntimeConfigDefaultRuntimeArgs
- Persistent
Resource AiRuntime Detail Pipeline Job Runtime Config Default Runtime Persistent Resource Runtime Detail - (Optional, Beta) Persistent resource based runtime detail. Structure is documented below.
- Persistent
Resource AiRuntime Detail Pipeline Job Runtime Config Default Runtime Persistent Resource Runtime Detail - (Optional, Beta) Persistent resource based runtime detail. Structure is documented below.
- persistent_
resource_ objectruntime_ detail - (Optional, Beta) Persistent resource based runtime detail. Structure is documented below.
- persistent
Resource AiRuntime Detail Pipeline Job Runtime Config Default Runtime Persistent Resource Runtime Detail - (Optional, Beta) Persistent resource based runtime detail. Structure is documented below.
- persistent
Resource AiRuntime Detail Pipeline Job Runtime Config Default Runtime Persistent Resource Runtime Detail - (Optional, Beta) Persistent resource based runtime detail. Structure is documented below.
- persistent_
resource_ Airuntime_ detail Pipeline Job Runtime Config Default Runtime Persistent Resource Runtime Detail - (Optional, Beta) Persistent resource based runtime detail. Structure is documented below.
- persistent
Resource Property MapRuntime Detail - (Optional, Beta) Persistent resource based runtime detail. Structure is documented below.
AiPipelineJobRuntimeConfigDefaultRuntimePersistentResourceRuntimeDetail, AiPipelineJobRuntimeConfigDefaultRuntimePersistentResourceRuntimeDetailArgs
- Persistent
Resource stringName - (Optional, Beta)
PersistentResource name, format:
projects/{project}/locations/{location}/persistentResources/{persistent_resource}. - string
- (Optional, Beta)
Sets the behavior when a task has reached the defined wait duration while waiting for task resources to become available in the specified persistent resource.
Possible values are:
TASK_RESOURCE_UNAVAILABLE_TIMEOUT_BEHAVIOR_UNSPECIFIED,FAIL,FALL_BACK_TO_ON_DEMAND. - string
- (Optional, Beta) The maxWaitTime for the task if the persistent resource is unavailable.
- Persistent
Resource stringName - (Optional, Beta)
PersistentResource name, format:
projects/{project}/locations/{location}/persistentResources/{persistent_resource}. - string
- (Optional, Beta)
Sets the behavior when a task has reached the defined wait duration while waiting for task resources to become available in the specified persistent resource.
Possible values are:
TASK_RESOURCE_UNAVAILABLE_TIMEOUT_BEHAVIOR_UNSPECIFIED,FAIL,FALL_BACK_TO_ON_DEMAND. - string
- (Optional, Beta) The maxWaitTime for the task if the persistent resource is unavailable.
- persistent_
resource_ stringname - (Optional, Beta)
PersistentResource name, format:
projects/{project}/locations/{location}/persistentResources/{persistent_resource}. - string
- (Optional, Beta)
Sets the behavior when a task has reached the defined wait duration while waiting for task resources to become available in the specified persistent resource.
Possible values are:
TASK_RESOURCE_UNAVAILABLE_TIMEOUT_BEHAVIOR_UNSPECIFIED,FAIL,FALL_BACK_TO_ON_DEMAND. - string
- (Optional, Beta) The maxWaitTime for the task if the persistent resource is unavailable.
- persistent
Resource StringName - (Optional, Beta)
PersistentResource name, format:
projects/{project}/locations/{location}/persistentResources/{persistent_resource}. - String
- (Optional, Beta)
Sets the behavior when a task has reached the defined wait duration while waiting for task resources to become available in the specified persistent resource.
Possible values are:
TASK_RESOURCE_UNAVAILABLE_TIMEOUT_BEHAVIOR_UNSPECIFIED,FAIL,FALL_BACK_TO_ON_DEMAND. - String
- (Optional, Beta) The maxWaitTime for the task if the persistent resource is unavailable.
- persistent
Resource stringName - (Optional, Beta)
PersistentResource name, format:
projects/{project}/locations/{location}/persistentResources/{persistent_resource}. - string
- (Optional, Beta)
Sets the behavior when a task has reached the defined wait duration while waiting for task resources to become available in the specified persistent resource.
Possible values are:
TASK_RESOURCE_UNAVAILABLE_TIMEOUT_BEHAVIOR_UNSPECIFIED,FAIL,FALL_BACK_TO_ON_DEMAND. - string
- (Optional, Beta) The maxWaitTime for the task if the persistent resource is unavailable.
- persistent_
resource_ strname - (Optional, Beta)
PersistentResource name, format:
projects/{project}/locations/{location}/persistentResources/{persistent_resource}. - str
- (Optional, Beta)
Sets the behavior when a task has reached the defined wait duration while waiting for task resources to become available in the specified persistent resource.
Possible values are:
TASK_RESOURCE_UNAVAILABLE_TIMEOUT_BEHAVIOR_UNSPECIFIED,FAIL,FALL_BACK_TO_ON_DEMAND. - str
- (Optional, Beta) The maxWaitTime for the task if the persistent resource is unavailable.
- persistent
Resource StringName - (Optional, Beta)
PersistentResource name, format:
projects/{project}/locations/{location}/persistentResources/{persistent_resource}. - String
- (Optional, Beta)
Sets the behavior when a task has reached the defined wait duration while waiting for task resources to become available in the specified persistent resource.
Possible values are:
TASK_RESOURCE_UNAVAILABLE_TIMEOUT_BEHAVIOR_UNSPECIFIED,FAIL,FALL_BACK_TO_ON_DEMAND. - String
- (Optional, Beta) The maxWaitTime for the task if the persistent resource is unavailable.
AiPipelineJobRuntimeConfigInputArtifact, AiPipelineJobRuntimeConfigInputArtifactArgs
- Artifact
Id string - Artifact resource id from MLMD. Which is the last portion of an artifact resource name:
projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}. The artifact must be within the same project, location and default metadatastore as the pipeline. - Artifact
Key string - The identifier for this object. Format specified above.
- Artifact
Id string - Artifact resource id from MLMD. Which is the last portion of an artifact resource name:
projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}. The artifact must be within the same project, location and default metadatastore as the pipeline. - Artifact
Key string - The identifier for this object. Format specified above.
- artifact_
id string - Artifact resource id from MLMD. Which is the last portion of an artifact resource name:
projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}. The artifact must be within the same project, location and default metadatastore as the pipeline. - artifact_
key string - The identifier for this object. Format specified above.
- artifact
Id String - Artifact resource id from MLMD. Which is the last portion of an artifact resource name:
projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}. The artifact must be within the same project, location and default metadatastore as the pipeline. - artifact
Key String - The identifier for this object. Format specified above.
- artifact
Id string - Artifact resource id from MLMD. Which is the last portion of an artifact resource name:
projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}. The artifact must be within the same project, location and default metadatastore as the pipeline. - artifact
Key string - The identifier for this object. Format specified above.
- artifact_
id str - Artifact resource id from MLMD. Which is the last portion of an artifact resource name:
projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}. The artifact must be within the same project, location and default metadatastore as the pipeline. - artifact_
key str - The identifier for this object. Format specified above.
- artifact
Id String - Artifact resource id from MLMD. Which is the last portion of an artifact resource name:
projects/{project}/locations/{location}/metadataStores/default/artifacts/{artifact_id}. The artifact must be within the same project, location and default metadatastore as the pipeline. - artifact
Key String - The identifier for this object. Format specified above.
AiPipelineJobTemplateMetadata, AiPipelineJobTemplateMetadataArgs
- Version string
- (Output) The versionName in artifact registry.
- Version string
- (Output) The versionName in artifact registry.
- version string
- (Output) The versionName in artifact registry.
- version String
- (Output) The versionName in artifact registry.
- version string
- (Output) The versionName in artifact registry.
- version str
- (Output) The versionName in artifact registry.
- version String
- (Output) The versionName in artifact registry.
Import
PipelineJob can be imported using any of these accepted formats:
projects/{{project}}/locations/{{region}}/pipelineJobs/{{name}}{{project}}/{{region}}/{{name}}{{region}}/{{name}}{{name}}
When using the pulumi import command, PipelineJob can be imported using one of the formats above. For example:
$ pulumi import gcp:vertex/aiPipelineJob:AiPipelineJob default projects/{{project}}/locations/{{region}}/pipelineJobs/{{name}}
$ pulumi import gcp:vertex/aiPipelineJob:AiPipelineJob default {{project}}/{{region}}/{{name}}
$ pulumi import gcp:vertex/aiPipelineJob:AiPipelineJob default {{region}}/{{name}}
$ pulumi import gcp:vertex/aiPipelineJob:AiPipelineJob default {{name}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.
published on Wednesday, Nov 18, 2026 by Pulumi