published on Wednesday, Nov 18, 2026 by Pulumi
published on Wednesday, Nov 18, 2026 by Pulumi
Represents a job that runs custom workloads such as a Docker container or a Python package. A CustomJob can have multiple worker pools and each worker pool can have its own machine and input spec. A CustomJob will be cleaned up once the job enters terminal state (failed or succeeded).
To get more information about CustomJob, see:
Example Usage
Vertex Ai Custom Job Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const jobBucket = new gcp.storage.Bucket("job_bucket", {
name: "example-custom-job-bucket",
location: "US-CENTRAL1",
forceDestroy: true,
uniformBucketLevelAccess: true,
});
const customJob = new gcp.vertex.AiCustomJob("custom_job", {
displayName: "example-custom-job",
region: "us-central1",
labels: {
env: "test",
},
jobSpec: {
persistentResourceId: "example-persistent-resource",
experiment: "example-experiment",
experimentRun: "example-experiment-run",
workerPoolSpecs: [{
replicaCount: 1,
machineSpec: {
machineType: "n1-standard-4",
},
diskSpec: {
bootDiskType: "pd-ssd",
bootDiskSizeGb: 100,
},
containerSpec: {
imageUri: "us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-12.py310:latest",
commands: [
"echo",
"test",
],
args: ["--epochs=1"],
envs: [{
name: "TEST_ENV",
value: "test_val",
}],
},
}],
scheduling: {
timeout: "86400s",
restartJobOnWorkerRestart: false,
strategy: "STANDARD",
},
baseOutputDirectory: {
outputUriPrefix: pulumi.interpolate`gs://${jobBucket.name}/custom-job-output`,
},
},
});
import pulumi
import pulumi_gcp as gcp
job_bucket = gcp.storage.Bucket("job_bucket",
name="example-custom-job-bucket",
location="US-CENTRAL1",
force_destroy=True,
uniform_bucket_level_access=True)
custom_job = gcp.vertex.AiCustomJob("custom_job",
display_name="example-custom-job",
region="us-central1",
labels={
"env": "test",
},
job_spec={
"persistent_resource_id": "example-persistent-resource",
"experiment": "example-experiment",
"experiment_run": "example-experiment-run",
"worker_pool_specs": [{
"replica_count": 1,
"machine_spec": {
"machine_type": "n1-standard-4",
},
"disk_spec": {
"boot_disk_type": "pd-ssd",
"boot_disk_size_gb": 100,
},
"container_spec": {
"image_uri": "us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-12.py310:latest",
"commands": [
"echo",
"test",
],
"args": ["--epochs=1"],
"envs": [{
"name": "TEST_ENV",
"value": "test_val",
}],
},
}],
"scheduling": {
"timeout": "86400s",
"restart_job_on_worker_restart": False,
"strategy": "STANDARD",
},
"base_output_directory": {
"output_uri_prefix": job_bucket.name.apply(lambda name: f"gs://{name}/custom-job-output"),
},
})
package main
import (
"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 {
jobBucket, err := storage.NewBucket(ctx, "job_bucket", &storage.BucketArgs{
Name: pulumi.String("example-custom-job-bucket"),
Location: pulumi.String("US-CENTRAL1"),
ForceDestroy: pulumi.Bool(true),
UniformBucketLevelAccess: pulumi.Bool(true),
})
if err != nil {
return err
}
_, err = vertex.NewAiCustomJob(ctx, "custom_job", &vertex.AiCustomJobArgs{
DisplayName: pulumi.String("example-custom-job"),
Region: pulumi.String("us-central1"),
Labels: pulumi.StringMap{
"env": pulumi.String("test"),
},
JobSpec: &vertex.AiCustomJobJobSpecArgs{
PersistentResourceId: pulumi.String("example-persistent-resource"),
Experiment: pulumi.String("example-experiment"),
ExperimentRun: pulumi.String("example-experiment-run"),
WorkerPoolSpecs: vertex.AiCustomJobJobSpecWorkerPoolSpecArray{
&vertex.AiCustomJobJobSpecWorkerPoolSpecArgs{
ReplicaCount: pulumi.Int(1),
MachineSpec: &vertex.AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs{
MachineType: pulumi.String("n1-standard-4"),
},
DiskSpec: &vertex.AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs{
BootDiskType: pulumi.String("pd-ssd"),
BootDiskSizeGb: pulumi.Int(100),
},
ContainerSpec: &vertex.AiCustomJobJobSpecWorkerPoolSpecContainerSpecArgs{
ImageUri: pulumi.String("us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-12.py310:latest"),
Commands: pulumi.StringArray{
pulumi.String("echo"),
pulumi.String("test"),
},
Args: pulumi.StringArray{
pulumi.String("--epochs=1"),
},
Envs: vertex.AiCustomJobJobSpecWorkerPoolSpecContainerSpecEnvArray{
&vertex.AiCustomJobJobSpecWorkerPoolSpecContainerSpecEnvArgs{
Name: pulumi.String("TEST_ENV"),
Value: pulumi.String("test_val"),
},
},
},
},
},
Scheduling: &vertex.AiCustomJobJobSpecSchedulingArgs{
Timeout: pulumi.String("86400s"),
RestartJobOnWorkerRestart: pulumi.Bool(false),
Strategy: pulumi.String("STANDARD"),
},
BaseOutputDirectory: &vertex.AiCustomJobJobSpecBaseOutputDirectoryArgs{
OutputUriPrefix: jobBucket.Name.ApplyT(func(name string) (string, error) {
return fmt.Sprintf("gs://%v/custom-job-output", name), nil
}).(pulumi.StringOutput),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var jobBucket = new Gcp.Storage.Bucket("job_bucket", new()
{
Name = "example-custom-job-bucket",
Location = "US-CENTRAL1",
ForceDestroy = true,
UniformBucketLevelAccess = true,
});
var customJob = new Gcp.Vertex.AiCustomJob("custom_job", new()
{
DisplayName = "example-custom-job",
Region = "us-central1",
Labels =
{
{ "env", "test" },
},
JobSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecArgs
{
PersistentResourceId = "example-persistent-resource",
Experiment = "example-experiment",
ExperimentRun = "example-experiment-run",
WorkerPoolSpecs = new[]
{
new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecArgs
{
ReplicaCount = 1,
MachineSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs
{
MachineType = "n1-standard-4",
},
DiskSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs
{
BootDiskType = "pd-ssd",
BootDiskSizeGb = 100,
},
ContainerSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecContainerSpecArgs
{
ImageUri = "us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-12.py310:latest",
Commands = new[]
{
"echo",
"test",
},
Args = new[]
{
"--epochs=1",
},
Envs = new[]
{
new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecContainerSpecEnvArgs
{
Name = "TEST_ENV",
Value = "test_val",
},
},
},
},
},
Scheduling = new Gcp.Vertex.Inputs.AiCustomJobJobSpecSchedulingArgs
{
Timeout = "86400s",
RestartJobOnWorkerRestart = false,
Strategy = "STANDARD",
},
BaseOutputDirectory = new Gcp.Vertex.Inputs.AiCustomJobJobSpecBaseOutputDirectoryArgs
{
OutputUriPrefix = jobBucket.Name.Apply(name => $"gs://{name}/custom-job-output"),
},
},
});
});
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.AiCustomJob;
import com.pulumi.gcp.vertex.AiCustomJobArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecContainerSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecContainerSpecEnvArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecSchedulingArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecBaseOutputDirectoryArgs;
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 jobBucket = new Bucket("jobBucket", BucketArgs.builder()
.name("example-custom-job-bucket")
.location("US-CENTRAL1")
.forceDestroy(true)
.uniformBucketLevelAccess(true)
.build());
var customJob = new AiCustomJob("customJob", AiCustomJobArgs.builder()
.displayName("example-custom-job")
.region("us-central1")
.labels(Map.of("env", "test"))
.jobSpec(AiCustomJobJobSpecArgs.builder()
.persistentResourceId("example-persistent-resource")
.experiment("example-experiment")
.experimentRun("example-experiment-run")
.workerPoolSpecs(AiCustomJobJobSpecWorkerPoolSpecArgs.builder()
.replicaCount(1)
.machineSpec(AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs.builder()
.machineType("n1-standard-4")
.build())
.diskSpec(AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs.builder()
.bootDiskType("pd-ssd")
.bootDiskSizeGb(100)
.build())
.containerSpec(AiCustomJobJobSpecWorkerPoolSpecContainerSpecArgs.builder()
.imageUri("us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-12.py310:latest")
.commands(
"echo",
"test")
.args("--epochs=1")
.envs(AiCustomJobJobSpecWorkerPoolSpecContainerSpecEnvArgs.builder()
.name("TEST_ENV")
.value("test_val")
.build())
.build())
.build())
.scheduling(AiCustomJobJobSpecSchedulingArgs.builder()
.timeout("86400s")
.restartJobOnWorkerRestart(false)
.strategy("STANDARD")
.build())
.baseOutputDirectory(AiCustomJobJobSpecBaseOutputDirectoryArgs.builder()
.outputUriPrefix(jobBucket.name().applyValue(_name -> String.format("gs://%s/custom-job-output", _name)))
.build())
.build())
.build());
}
}
resources:
customJob:
type: gcp:vertex:AiCustomJob
name: custom_job
properties:
displayName: example-custom-job
region: us-central1
labels:
env: test
jobSpec:
persistentResourceId: example-persistent-resource
experiment: example-experiment
experimentRun: example-experiment-run
workerPoolSpecs:
- replicaCount: 1
machineSpec:
machineType: n1-standard-4
diskSpec:
bootDiskType: pd-ssd
bootDiskSizeGb: 100
containerSpec:
imageUri: us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-12.py310:latest
commands:
- echo
- test
args:
- --epochs=1
envs:
- name: TEST_ENV
value: test_val
scheduling:
timeout: 86400s
restartJobOnWorkerRestart: false
strategy: STANDARD
baseOutputDirectory:
outputUriPrefix: gs://${jobBucket.name}/custom-job-output
jobBucket:
type: gcp:storage:Bucket
name: job_bucket
properties:
name: example-custom-job-bucket
location: US-CENTRAL1
forceDestroy: true
uniformBucketLevelAccess: true
terraform {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
resource "gcp_vertex_ai_custom_job" "custom_job" {
lifecycle {
create_before_destroy = true
}
display_name = "example-custom-job"
region = "us-central1"
labels = {
"env" = "test"
}
job_spec = {
persistent_resource_id = "example-persistent-resource"
experiment = "example-experiment"
experiment_run = "example-experiment-run"
worker_pool_specs = [{
replica_count = 1
machine_spec = {
machine_type = "n1-standard-4"
}
disk_spec = {
boot_disk_type = "pd-ssd"
boot_disk_size_gb = 100
}
container_spec = {
image_uri = "us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-12.py310:latest"
commands = ["echo", "test"]
args = ["--epochs=1"]
envs = [{
name = "TEST_ENV"
value = "test_val"
}]
}
}]
scheduling = {
timeout = "86400s"
restart_job_on_worker_restart = false
strategy = "STANDARD"
}
base_output_directory = {
output_uri_prefix ="gs://${gcp_storage_bucket.job_bucket.name}/custom-job-output"
}
}
}
resource "gcp_storage_bucket" "job_bucket" {
lifecycle {
create_before_destroy = true
}
name = "example-custom-job-bucket"
location = "US-CENTRAL1"
force_destroy = true
uniform_bucket_level_access = true
}
Vertex Ai Custom Job Models
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const customJob = new gcp.vertex.AiCustomJob("custom_job", {
displayName: "example-custom-job-models",
region: "us-central1",
jobSpec: {
protectedArtifactLocationId: "us-central1",
models: ["example-model"],
workerPoolSpecs: [{
replicaCount: 1,
machineSpec: {
machineType: "n1-standard-4",
},
diskSpec: {
bootDiskType: "pd-ssd",
bootDiskSizeGb: 100,
},
containerSpec: {
imageUri: "us-docker.pkg.dev/vertex-ai-restricted/llm/llm-pets-cpu:latest",
},
}],
},
});
import pulumi
import pulumi_gcp as gcp
custom_job = gcp.vertex.AiCustomJob("custom_job",
display_name="example-custom-job-models",
region="us-central1",
job_spec={
"protected_artifact_location_id": "us-central1",
"models": ["example-model"],
"worker_pool_specs": [{
"replica_count": 1,
"machine_spec": {
"machine_type": "n1-standard-4",
},
"disk_spec": {
"boot_disk_type": "pd-ssd",
"boot_disk_size_gb": 100,
},
"container_spec": {
"image_uri": "us-docker.pkg.dev/vertex-ai-restricted/llm/llm-pets-cpu:latest",
},
}],
})
package main
import (
"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 {
_, err := vertex.NewAiCustomJob(ctx, "custom_job", &vertex.AiCustomJobArgs{
DisplayName: pulumi.String("example-custom-job-models"),
Region: pulumi.String("us-central1"),
JobSpec: &vertex.AiCustomJobJobSpecArgs{
ProtectedArtifactLocationId: pulumi.String("us-central1"),
Models: pulumi.StringArray{
pulumi.String("example-model"),
},
WorkerPoolSpecs: vertex.AiCustomJobJobSpecWorkerPoolSpecArray{
&vertex.AiCustomJobJobSpecWorkerPoolSpecArgs{
ReplicaCount: pulumi.Int(1),
MachineSpec: &vertex.AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs{
MachineType: pulumi.String("n1-standard-4"),
},
DiskSpec: &vertex.AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs{
BootDiskType: pulumi.String("pd-ssd"),
BootDiskSizeGb: pulumi.Int(100),
},
ContainerSpec: &vertex.AiCustomJobJobSpecWorkerPoolSpecContainerSpecArgs{
ImageUri: pulumi.String("us-docker.pkg.dev/vertex-ai-restricted/llm/llm-pets-cpu:latest"),
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var customJob = new Gcp.Vertex.AiCustomJob("custom_job", new()
{
DisplayName = "example-custom-job-models",
Region = "us-central1",
JobSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecArgs
{
ProtectedArtifactLocationId = "us-central1",
Models = new[]
{
"example-model",
},
WorkerPoolSpecs = new[]
{
new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecArgs
{
ReplicaCount = 1,
MachineSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs
{
MachineType = "n1-standard-4",
},
DiskSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs
{
BootDiskType = "pd-ssd",
BootDiskSizeGb = 100,
},
ContainerSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecContainerSpecArgs
{
ImageUri = "us-docker.pkg.dev/vertex-ai-restricted/llm/llm-pets-cpu:latest",
},
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.vertex.AiCustomJob;
import com.pulumi.gcp.vertex.AiCustomJobArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecContainerSpecArgs;
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 customJob = new AiCustomJob("customJob", AiCustomJobArgs.builder()
.displayName("example-custom-job-models")
.region("us-central1")
.jobSpec(AiCustomJobJobSpecArgs.builder()
.protectedArtifactLocationId("us-central1")
.models("example-model")
.workerPoolSpecs(AiCustomJobJobSpecWorkerPoolSpecArgs.builder()
.replicaCount(1)
.machineSpec(AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs.builder()
.machineType("n1-standard-4")
.build())
.diskSpec(AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs.builder()
.bootDiskType("pd-ssd")
.bootDiskSizeGb(100)
.build())
.containerSpec(AiCustomJobJobSpecWorkerPoolSpecContainerSpecArgs.builder()
.imageUri("us-docker.pkg.dev/vertex-ai-restricted/llm/llm-pets-cpu:latest")
.build())
.build())
.build())
.build());
}
}
resources:
customJob:
type: gcp:vertex:AiCustomJob
name: custom_job
properties:
displayName: example-custom-job-models
region: us-central1
jobSpec:
protectedArtifactLocationId: us-central1
models:
- example-model
workerPoolSpecs:
- replicaCount: 1
machineSpec:
machineType: n1-standard-4
diskSpec:
bootDiskType: pd-ssd
bootDiskSizeGb: 100
containerSpec:
imageUri: us-docker.pkg.dev/vertex-ai-restricted/llm/llm-pets-cpu:latest
terraform {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
resource "gcp_vertex_ai_custom_job" "custom_job" {
lifecycle {
create_before_destroy = true
}
display_name = "example-custom-job-models"
region = "us-central1"
job_spec = {
protected_artifact_location_id = "us-central1"
models = ["example-model"]
worker_pool_specs = [{
replica_count = 1
machine_spec = {
machine_type = "n1-standard-4"
}
disk_spec = {
boot_disk_type = "pd-ssd"
boot_disk_size_gb = 100
}
container_spec = {
image_uri = "us-docker.pkg.dev/vertex-ai-restricted/llm/llm-pets-cpu:latest"
}
}]
}
}
Vertex Ai Custom Job Python Package
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const customJobSa = new gcp.serviceaccount.Account("custom_job_sa", {
accountId: "job-sa",
displayName: "Custom Job Service Account",
});
const tensorboard = new gcp.vertex.AiTensorboard("tensorboard", {
displayName: "example-tensorboard",
region: "us-central1",
});
const jobBucket = new gcp.storage.Bucket("job_bucket", {
name: "example-custom-job-python-bucket",
location: "US-CENTRAL1",
forceDestroy: true,
uniformBucketLevelAccess: true,
});
const trainerPackage = new gcp.storage.BucketObject("trainer_package", {
name: "trainer-0.1.tar.gz",
bucket: jobBucket.name,
content: "placeholder",
});
const project = gcp.organizations.getProject({});
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 customJob = new gcp.vertex.AiCustomJob("custom_job", {
displayName: "example-custom-job-python",
region: "us-central1",
encryptionSpec: {
kmsKeyName: "example-key",
},
jobSpec: {
serviceAccount: customJobSa.email,
tensorboard: tensorboard.id,
experiment: "example-experiment",
enableWebAccess: true,
enableDashboardAccess: true,
baseOutputDirectory: {
outputUriPrefix: pulumi.interpolate`gs://${jobBucket.name}/custom-job-output`,
},
pscInterfaceConfig: {
networkAttachment: project.then(project => `projects/${project.projectId}/regions/us-central1/networkAttachments/example-attachment`),
dnsPeeringConfigs: [{
domain: "example.com.",
targetProject: project.then(project => project.projectId),
targetNetwork: "default",
}],
},
scheduling: {
timeout: "86400s",
restartJobOnWorkerRestart: false,
strategy: "FLEX_START",
disableRetries: true,
maxWaitDuration: "1800s",
},
workerPoolSpecs: [{
replicaCount: 1,
machineSpec: {
machineType: "g2-standard-4",
acceleratorType: "NVIDIA_L4",
acceleratorCount: 1,
},
diskSpec: {
bootDiskType: "pd-ssd",
bootDiskSizeGb: 100,
},
pythonPackageSpec: {
executorImageUri: "us-docker.pkg.dev/vertex-ai/training/tf-gpu.2-12.py310:latest",
packageUris: [pulumi.interpolate`gs://${jobBucket.name}/${trainerPackage.name}`],
pythonModule: "trainer.task",
args: ["--epochs=1"],
envs: [{
name: "PYTHON_ENV",
value: "test_val",
}],
},
nfsMounts: [{
server: "10.0.0.1",
path: "/nfs_share",
mountPoint: "nfs_mount",
}],
lustreMounts: [{
instanceIp: "10.0.0.1",
volumeHandle: "lustre-vol",
filesystem: "lustrefs",
mountPoint: "lustre_mount",
}],
}],
},
}, {
dependsOn: [cryptoKey],
});
import pulumi
import pulumi_gcp as gcp
custom_job_sa = gcp.serviceaccount.Account("custom_job_sa",
account_id="job-sa",
display_name="Custom Job Service Account")
tensorboard = gcp.vertex.AiTensorboard("tensorboard",
display_name="example-tensorboard",
region="us-central1")
job_bucket = gcp.storage.Bucket("job_bucket",
name="example-custom-job-python-bucket",
location="US-CENTRAL1",
force_destroy=True,
uniform_bucket_level_access=True)
trainer_package = gcp.storage.BucketObject("trainer_package",
name="trainer-0.1.tar.gz",
bucket=job_bucket.name,
content="placeholder")
project = gcp.organizations.get_project()
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")
custom_job = gcp.vertex.AiCustomJob("custom_job",
display_name="example-custom-job-python",
region="us-central1",
encryption_spec={
"kms_key_name": "example-key",
},
job_spec={
"service_account": custom_job_sa.email,
"tensorboard": tensorboard.id,
"experiment": "example-experiment",
"enable_web_access": True,
"enable_dashboard_access": True,
"base_output_directory": {
"output_uri_prefix": job_bucket.name.apply(lambda name: f"gs://{name}/custom-job-output"),
},
"psc_interface_config": {
"network_attachment": f"projects/{project.project_id}/regions/us-central1/networkAttachments/example-attachment",
"dns_peering_configs": [{
"domain": "example.com.",
"target_project": project.project_id,
"target_network": "default",
}],
},
"scheduling": {
"timeout": "86400s",
"restart_job_on_worker_restart": False,
"strategy": "FLEX_START",
"disable_retries": True,
"max_wait_duration": "1800s",
},
"worker_pool_specs": [{
"replica_count": 1,
"machine_spec": {
"machine_type": "g2-standard-4",
"accelerator_type": "NVIDIA_L4",
"accelerator_count": 1,
},
"disk_spec": {
"boot_disk_type": "pd-ssd",
"boot_disk_size_gb": 100,
},
"python_package_spec": {
"executor_image_uri": "us-docker.pkg.dev/vertex-ai/training/tf-gpu.2-12.py310:latest",
"package_uris": [pulumi.Output.all(
jobBucketName=job_bucket.name,
trainerPackageName=trainer_package.name
).apply(lambda resolved_outputs: f"gs://{resolved_outputs['jobBucketName']}/{resolved_outputs['trainerPackageName']}")
],
"python_module": "trainer.task",
"args": ["--epochs=1"],
"envs": [{
"name": "PYTHON_ENV",
"value": "test_val",
}],
},
"nfs_mounts": [{
"server": "10.0.0.1",
"path": "/nfs_share",
"mount_point": "nfs_mount",
}],
"lustre_mounts": [{
"instance_ip": "10.0.0.1",
"volume_handle": "lustre-vol",
"filesystem": "lustrefs",
"mount_point": "lustre_mount",
}],
}],
},
opts = pulumi.ResourceOptions(depends_on=[crypto_key]))
package main
import (
"fmt"
"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/serviceaccount"
"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 {
customJobSa, err := serviceaccount.NewAccount(ctx, "custom_job_sa", &serviceaccount.AccountArgs{
AccountId: pulumi.String("job-sa"),
DisplayName: pulumi.String("Custom Job Service Account"),
})
if err != nil {
return err
}
tensorboard, err := vertex.NewAiTensorboard(ctx, "tensorboard", &vertex.AiTensorboardArgs{
DisplayName: pulumi.String("example-tensorboard"),
Region: pulumi.String("us-central1"),
})
if err != nil {
return err
}
jobBucket, err := storage.NewBucket(ctx, "job_bucket", &storage.BucketArgs{
Name: pulumi.String("example-custom-job-python-bucket"),
Location: pulumi.String("US-CENTRAL1"),
ForceDestroy: pulumi.Bool(true),
UniformBucketLevelAccess: pulumi.Bool(true),
})
if err != nil {
return err
}
trainerPackage, err := storage.NewBucketObject(ctx, "trainer_package", &storage.BucketObjectArgs{
Name: pulumi.String("trainer-0.1.tar.gz"),
Bucket: jobBucket.Name,
Content: pulumi.String("placeholder"),
})
if err != nil {
return err
}
project, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{}, nil)
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
}
_, err = vertex.NewAiCustomJob(ctx, "custom_job", &vertex.AiCustomJobArgs{
DisplayName: pulumi.String("example-custom-job-python"),
Region: pulumi.String("us-central1"),
EncryptionSpec: &vertex.AiCustomJobEncryptionSpecArgs{
KmsKeyName: pulumi.String("example-key"),
},
JobSpec: &vertex.AiCustomJobJobSpecArgs{
ServiceAccount: customJobSa.Email,
Tensorboard: tensorboard.ID(),
Experiment: pulumi.String("example-experiment"),
EnableWebAccess: pulumi.Bool(true),
EnableDashboardAccess: pulumi.Bool(true),
BaseOutputDirectory: &vertex.AiCustomJobJobSpecBaseOutputDirectoryArgs{
OutputUriPrefix: jobBucket.Name.ApplyT(func(name string) (string, error) {
return fmt.Sprintf("gs://%v/custom-job-output", name), nil
}).(pulumi.StringOutput),
},
PscInterfaceConfig: &vertex.AiCustomJobJobSpecPscInterfaceConfigArgs{
NetworkAttachment: pulumi.Sprintf("projects/%v/regions/us-central1/networkAttachments/example-attachment", project.ProjectId),
DnsPeeringConfigs: vertex.AiCustomJobJobSpecPscInterfaceConfigDnsPeeringConfigArray{
&vertex.AiCustomJobJobSpecPscInterfaceConfigDnsPeeringConfigArgs{
Domain: pulumi.String("example.com."),
TargetProject: pulumi.String(project.ProjectId),
TargetNetwork: pulumi.String("default"),
},
},
},
Scheduling: &vertex.AiCustomJobJobSpecSchedulingArgs{
Timeout: pulumi.String("86400s"),
RestartJobOnWorkerRestart: pulumi.Bool(false),
Strategy: pulumi.String("FLEX_START"),
DisableRetries: pulumi.Bool(true),
MaxWaitDuration: pulumi.String("1800s"),
},
WorkerPoolSpecs: vertex.AiCustomJobJobSpecWorkerPoolSpecArray{
&vertex.AiCustomJobJobSpecWorkerPoolSpecArgs{
ReplicaCount: pulumi.Int(1),
MachineSpec: &vertex.AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs{
MachineType: pulumi.String("g2-standard-4"),
AcceleratorType: pulumi.String("NVIDIA_L4"),
AcceleratorCount: pulumi.Int(1),
},
DiskSpec: &vertex.AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs{
BootDiskType: pulumi.String("pd-ssd"),
BootDiskSizeGb: pulumi.Int(100),
},
PythonPackageSpec: &vertex.AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecArgs{
ExecutorImageUri: pulumi.String("us-docker.pkg.dev/vertex-ai/training/tf-gpu.2-12.py310:latest"),
PackageUris: pulumi.StringArray{
pulumi.All(jobBucket.Name, trainerPackage.Name).ApplyT(func(_args []interface{}) (string, error) {
jobBucketName := _args[0].(string)
trainerPackageName := _args[1].(string)
return fmt.Sprintf("gs://%v/%v", jobBucketName, trainerPackageName), nil
}).(pulumi.StringOutput),
},
PythonModule: pulumi.String("trainer.task"),
Args: pulumi.StringArray{
pulumi.String("--epochs=1"),
},
Envs: vertex.AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecEnvArray{
&vertex.AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecEnvArgs{
Name: pulumi.String("PYTHON_ENV"),
Value: pulumi.String("test_val"),
},
},
},
NfsMounts: vertex.AiCustomJobJobSpecWorkerPoolSpecNfsMountArray{
&vertex.AiCustomJobJobSpecWorkerPoolSpecNfsMountArgs{
Server: pulumi.String("10.0.0.1"),
Path: pulumi.String("/nfs_share"),
MountPoint: pulumi.String("nfs_mount"),
},
},
LustreMounts: vertex.AiCustomJobJobSpecWorkerPoolSpecLustreMountArray{
&vertex.AiCustomJobJobSpecWorkerPoolSpecLustreMountArgs{
InstanceIp: pulumi.String("10.0.0.1"),
VolumeHandle: pulumi.String("lustre-vol"),
Filesystem: pulumi.String("lustrefs"),
MountPoint: pulumi.String("lustre_mount"),
},
},
},
},
},
}, pulumi.DependsOn([]pulumi.Resource{
cryptoKey,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var customJobSa = new Gcp.ServiceAccount.Account("custom_job_sa", new()
{
AccountId = "job-sa",
DisplayName = "Custom Job Service Account",
});
var tensorboard = new Gcp.Vertex.AiTensorboard("tensorboard", new()
{
DisplayName = "example-tensorboard",
Region = "us-central1",
});
var jobBucket = new Gcp.Storage.Bucket("job_bucket", new()
{
Name = "example-custom-job-python-bucket",
Location = "US-CENTRAL1",
ForceDestroy = true,
UniformBucketLevelAccess = true,
});
var trainerPackage = new Gcp.Storage.BucketObject("trainer_package", new()
{
Name = "trainer-0.1.tar.gz",
Bucket = jobBucket.Name,
Content = "placeholder",
});
var project = Gcp.Organizations.GetProject.Invoke();
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 customJob = new Gcp.Vertex.AiCustomJob("custom_job", new()
{
DisplayName = "example-custom-job-python",
Region = "us-central1",
EncryptionSpec = new Gcp.Vertex.Inputs.AiCustomJobEncryptionSpecArgs
{
KmsKeyName = "example-key",
},
JobSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecArgs
{
ServiceAccount = customJobSa.Email,
Tensorboard = tensorboard.Id,
Experiment = "example-experiment",
EnableWebAccess = true,
EnableDashboardAccess = true,
BaseOutputDirectory = new Gcp.Vertex.Inputs.AiCustomJobJobSpecBaseOutputDirectoryArgs
{
OutputUriPrefix = jobBucket.Name.Apply(name => $"gs://{name}/custom-job-output"),
},
PscInterfaceConfig = new Gcp.Vertex.Inputs.AiCustomJobJobSpecPscInterfaceConfigArgs
{
NetworkAttachment = $"projects/{project.Apply(getProjectResult => getProjectResult.ProjectId)}/regions/us-central1/networkAttachments/example-attachment",
DnsPeeringConfigs = new[]
{
new Gcp.Vertex.Inputs.AiCustomJobJobSpecPscInterfaceConfigDnsPeeringConfigArgs
{
Domain = "example.com.",
TargetProject = project.Apply(getProjectResult => getProjectResult.ProjectId),
TargetNetwork = "default",
},
},
},
Scheduling = new Gcp.Vertex.Inputs.AiCustomJobJobSpecSchedulingArgs
{
Timeout = "86400s",
RestartJobOnWorkerRestart = false,
Strategy = "FLEX_START",
DisableRetries = true,
MaxWaitDuration = "1800s",
},
WorkerPoolSpecs = new[]
{
new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecArgs
{
ReplicaCount = 1,
MachineSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs
{
MachineType = "g2-standard-4",
AcceleratorType = "NVIDIA_L4",
AcceleratorCount = 1,
},
DiskSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs
{
BootDiskType = "pd-ssd",
BootDiskSizeGb = 100,
},
PythonPackageSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecArgs
{
ExecutorImageUri = "us-docker.pkg.dev/vertex-ai/training/tf-gpu.2-12.py310:latest",
PackageUris = new[]
{
Output.Tuple(jobBucket.Name, trainerPackage.Name).Apply(values =>
{
var jobBucketName = values.Item1;
var trainerPackageName = values.Item2;
return $"gs://{jobBucketName}/{trainerPackageName}";
}),
},
PythonModule = "trainer.task",
Args = new[]
{
"--epochs=1",
},
Envs = new[]
{
new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecEnvArgs
{
Name = "PYTHON_ENV",
Value = "test_val",
},
},
},
NfsMounts = new[]
{
new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecNfsMountArgs
{
Server = "10.0.0.1",
Path = "/nfs_share",
MountPoint = "nfs_mount",
},
},
LustreMounts = new[]
{
new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecLustreMountArgs
{
InstanceIp = "10.0.0.1",
VolumeHandle = "lustre-vol",
Filesystem = "lustrefs",
MountPoint = "lustre_mount",
},
},
},
},
},
}, new CustomResourceOptions
{
DependsOn =
{
cryptoKey,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.serviceaccount.Account;
import com.pulumi.gcp.serviceaccount.AccountArgs;
import com.pulumi.gcp.vertex.AiTensorboard;
import com.pulumi.gcp.vertex.AiTensorboardArgs;
import com.pulumi.gcp.storage.Bucket;
import com.pulumi.gcp.storage.BucketArgs;
import com.pulumi.gcp.storage.BucketObject;
import com.pulumi.gcp.storage.BucketObjectArgs;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.kms.CryptoKeyIAMMember;
import com.pulumi.gcp.kms.CryptoKeyIAMMemberArgs;
import com.pulumi.gcp.vertex.AiCustomJob;
import com.pulumi.gcp.vertex.AiCustomJobArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobEncryptionSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecBaseOutputDirectoryArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecPscInterfaceConfigArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecPscInterfaceConfigDnsPeeringConfigArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecSchedulingArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecEnvArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecNfsMountArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecLustreMountArgs;
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) {
var customJobSa = new Account("customJobSa", AccountArgs.builder()
.accountId("job-sa")
.displayName("Custom Job Service Account")
.build());
var tensorboard = new AiTensorboard("tensorboard", AiTensorboardArgs.builder()
.displayName("example-tensorboard")
.region("us-central1")
.build());
var jobBucket = new Bucket("jobBucket", BucketArgs.builder()
.name("example-custom-job-python-bucket")
.location("US-CENTRAL1")
.forceDestroy(true)
.uniformBucketLevelAccess(true)
.build());
var trainerPackage = new BucketObject("trainerPackage", BucketObjectArgs.builder()
.name("trainer-0.1.tar.gz")
.bucket(jobBucket.name())
.content("placeholder")
.build());
final var project = OrganizationsFunctions.getProject(GetProjectArgs.builder()
.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 customJob = new AiCustomJob("customJob", AiCustomJobArgs.builder()
.displayName("example-custom-job-python")
.region("us-central1")
.encryptionSpec(AiCustomJobEncryptionSpecArgs.builder()
.kmsKeyName("example-key")
.build())
.jobSpec(AiCustomJobJobSpecArgs.builder()
.serviceAccount(customJobSa.email())
.tensorboard(tensorboard.id())
.experiment("example-experiment")
.enableWebAccess(true)
.enableDashboardAccess(true)
.baseOutputDirectory(AiCustomJobJobSpecBaseOutputDirectoryArgs.builder()
.outputUriPrefix(jobBucket.name().applyValue(_name -> String.format("gs://%s/custom-job-output", _name)))
.build())
.pscInterfaceConfig(AiCustomJobJobSpecPscInterfaceConfigArgs.builder()
.networkAttachment(String.format("projects/%s/regions/us-central1/networkAttachments/example-attachment", project.projectId()))
.dnsPeeringConfigs(AiCustomJobJobSpecPscInterfaceConfigDnsPeeringConfigArgs.builder()
.domain("example.com.")
.targetProject(project.projectId())
.targetNetwork("default")
.build())
.build())
.scheduling(AiCustomJobJobSpecSchedulingArgs.builder()
.timeout("86400s")
.restartJobOnWorkerRestart(false)
.strategy("FLEX_START")
.disableRetries(true)
.maxWaitDuration("1800s")
.build())
.workerPoolSpecs(AiCustomJobJobSpecWorkerPoolSpecArgs.builder()
.replicaCount(1)
.machineSpec(AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs.builder()
.machineType("g2-standard-4")
.acceleratorType("NVIDIA_L4")
.acceleratorCount(1)
.build())
.diskSpec(AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs.builder()
.bootDiskType("pd-ssd")
.bootDiskSizeGb(100)
.build())
.pythonPackageSpec(AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecArgs.builder()
.executorImageUri("us-docker.pkg.dev/vertex-ai/training/tf-gpu.2-12.py310:latest")
.packageUris(Output.tuple(jobBucket.name(), trainerPackage.name()).applyValue(values -> {
var jobBucketName = values.t1;
var trainerPackageName = values.t2;
return String.format("gs://%s/%s", jobBucketName,trainerPackageName);
}))
.pythonModule("trainer.task")
.args("--epochs=1")
.envs(AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecEnvArgs.builder()
.name("PYTHON_ENV")
.value("test_val")
.build())
.build())
.nfsMounts(AiCustomJobJobSpecWorkerPoolSpecNfsMountArgs.builder()
.server("10.0.0.1")
.path("/nfs_share")
.mountPoint("nfs_mount")
.build())
.lustreMounts(AiCustomJobJobSpecWorkerPoolSpecLustreMountArgs.builder()
.instanceIp("10.0.0.1")
.volumeHandle("lustre-vol")
.filesystem("lustrefs")
.mountPoint("lustre_mount")
.build())
.build())
.build())
.build(), CustomResourceOptions.builder()
.dependsOn(cryptoKey)
.build());
}
}
resources:
customJob:
type: gcp:vertex:AiCustomJob
name: custom_job
properties:
displayName: example-custom-job-python
region: us-central1
encryptionSpec:
kmsKeyName: example-key
jobSpec:
serviceAccount: ${customJobSa.email}
tensorboard: ${tensorboard.id}
experiment: example-experiment
enableWebAccess: true
enableDashboardAccess: true
baseOutputDirectory:
outputUriPrefix: gs://${jobBucket.name}/custom-job-output
pscInterfaceConfig:
networkAttachment: projects/${project.projectId}/regions/us-central1/networkAttachments/example-attachment
dnsPeeringConfigs:
- domain: example.com.
targetProject: ${project.projectId}
targetNetwork: default
scheduling:
timeout: 86400s
restartJobOnWorkerRestart: false
strategy: FLEX_START
disableRetries: true
maxWaitDuration: 1800s
workerPoolSpecs:
- replicaCount: 1
machineSpec:
machineType: g2-standard-4
acceleratorType: NVIDIA_L4
acceleratorCount: 1
diskSpec:
bootDiskType: pd-ssd
bootDiskSizeGb: 100
pythonPackageSpec:
executorImageUri: us-docker.pkg.dev/vertex-ai/training/tf-gpu.2-12.py310:latest
packageUris:
- gs://${jobBucket.name}/${trainerPackage.name}
pythonModule: trainer.task
args:
- --epochs=1
envs:
- name: PYTHON_ENV
value: test_val
nfsMounts:
- server: 10.0.0.1
path: /nfs_share
mountPoint: nfs_mount
lustreMounts:
- instanceIp: 10.0.0.1
volumeHandle: lustre-vol
filesystem: lustrefs
mountPoint: lustre_mount
options:
dependsOn:
- ${cryptoKey}
customJobSa:
type: gcp:serviceaccount:Account
name: custom_job_sa
properties:
accountId: job-sa
displayName: Custom Job Service Account
tensorboard:
type: gcp:vertex:AiTensorboard
properties:
displayName: example-tensorboard
region: us-central1
jobBucket:
type: gcp:storage:Bucket
name: job_bucket
properties:
name: example-custom-job-python-bucket
location: US-CENTRAL1
forceDestroy: true
uniformBucketLevelAccess: true
trainerPackage:
type: gcp:storage:BucketObject
name: trainer_package
properties:
name: trainer-0.1.tar.gz
bucket: ${jobBucket.name}
content: placeholder
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
variables:
project:
fn::invoke:
function: gcp:organizations:getProject
arguments: {}
terraform {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
data "gcp_organizations_project" "project" {
}
resource "gcp_vertex_ai_custom_job" "custom_job" {
depends_on = [gcp_kms_crypto_key_i_a_m_member.crypto_key]
lifecycle {
create_before_destroy = true
}
display_name = "example-custom-job-python"
region = "us-central1"
encryption_spec = {
kms_key_name = "example-key"
}
job_spec = {
service_account = gcp_serviceaccount_account.custom_job_sa.email
tensorboard = gcp_vertex_ai_tensorboard.tensorboard.id
experiment = "example-experiment"
enable_web_access = true
enable_dashboard_access = true
base_output_directory = {
output_uri_prefix ="gs://${gcp_storage_bucket.job_bucket.name}/custom-job-output"
}
psc_interface_config = {
network_attachment ="projects/${data.gcp_organizations_project.project.project_id}/regions/us-central1/networkAttachments/example-attachment"
dns_peering_configs = [{
domain = "example.com."
target_project = data.gcp_organizations_project.project.project_id
target_network = "default"
}]
}
scheduling = {
timeout = "86400s"
restart_job_on_worker_restart = false
strategy = "FLEX_START"
disable_retries = true
max_wait_duration = "1800s"
}
worker_pool_specs = [{
replica_count = 1
machine_spec = {
machine_type = "g2-standard-4"
accelerator_type = "NVIDIA_L4"
accelerator_count = 1
}
disk_spec = {
boot_disk_type = "pd-ssd"
boot_disk_size_gb = 100
}
python_package_spec = {
executor_image_uri = "us-docker.pkg.dev/vertex-ai/training/tf-gpu.2-12.py310:latest"
package_uris = ["gs://${gcp_storage_bucket.job_bucket.name}/${gcp_storage_bucket_object.trainer_package.name}"]
python_module = "trainer.task"
args = ["--epochs=1"]
envs = [{
name = "PYTHON_ENV"
value = "test_val"
}]
}
nfs_mounts = [{
server = "10.0.0.1"
path = "/nfs_share"
mount_point = "nfs_mount"
}]
lustre_mounts = [{
instance_ip = "10.0.0.1"
volume_handle = "lustre-vol"
filesystem = "lustrefs"
mount_point = "lustre_mount"
}]
}]
}
}
resource "gcp_serviceaccount_account" "custom_job_sa" {
lifecycle {
create_before_destroy = true
}
account_id = "job-sa"
display_name = "Custom Job Service Account"
}
resource "gcp_vertex_ai_tensorboard" "tensorboard" {
lifecycle {
create_before_destroy = true
}
display_name = "example-tensorboard"
region = "us-central1"
}
resource "gcp_storage_bucket" "job_bucket" {
lifecycle {
create_before_destroy = true
}
name = "example-custom-job-python-bucket"
location = "US-CENTRAL1"
force_destroy = true
uniform_bucket_level_access = true
}
resource "gcp_storage_bucket_object" "trainer_package" {
lifecycle {
create_before_destroy = true
}
name = "trainer-0.1.tar.gz"
bucket = gcp_storage_bucket.job_bucket.name
content = "placeholder"
}
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"
}
Vertex Ai Custom Job Tpu Network
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const vertexNetwork = new gcp.compute.Network("vertex_network", {
name: "custom-job-vpc-net",
autoCreateSubnetworks: false,
});
const vertexRange = new gcp.compute.GlobalAddress("vertex_range", {
name: "custom-job-vpc-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 project = gcp.organizations.getProject({});
const customJob = new gcp.vertex.AiCustomJob("custom_job", {
displayName: "example-custom-job-tpu",
region: "us-central1",
jobSpec: {
network: pulumi.all([project, vertexNetwork.name]).apply(([project, name]) => `projects/${project.number}/global/networks/${name}`),
reservedIpRanges: [vertexRange.name],
workerPoolSpecs: [{
replicaCount: 1,
machineSpec: {
machineType: "n1-standard-4",
tpuTopology: "2x2",
reservationAffinity: {
reservationAffinityType: "SPECIFIC_RESERVATION",
key: "compute.googleapis.com/reservation-name",
values: [project.then(project => `projects/${project.number}/zones/us-central1-z/reservations/example-reservation`)],
},
},
diskSpec: {
bootDiskType: "pd-ssd",
bootDiskSizeGb: 100,
},
containerSpec: {
imageUri: "us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-12.py310:latest",
commands: [
"echo",
"test",
],
},
}],
},
}, {
dependsOn: [vertexVpcConnection],
});
import pulumi
import pulumi_gcp as gcp
vertex_network = gcp.compute.Network("vertex_network",
name="custom-job-vpc-net",
auto_create_subnetworks=False)
vertex_range = gcp.compute.GlobalAddress("vertex_range",
name="custom-job-vpc-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])
project = gcp.organizations.get_project()
custom_job = gcp.vertex.AiCustomJob("custom_job",
display_name="example-custom-job-tpu",
region="us-central1",
job_spec={
"network": vertex_network.name.apply(lambda name: f"projects/{project.number}/global/networks/{name}"),
"reserved_ip_ranges": [vertex_range.name],
"worker_pool_specs": [{
"replica_count": 1,
"machine_spec": {
"machine_type": "n1-standard-4",
"tpu_topology": "2x2",
"reservation_affinity": {
"reservation_affinity_type": "SPECIFIC_RESERVATION",
"key": "compute.googleapis.com/reservation-name",
"values": [f"projects/{project.number}/zones/us-central1-z/reservations/example-reservation"],
},
},
"disk_spec": {
"boot_disk_type": "pd-ssd",
"boot_disk_size_gb": 100,
},
"container_spec": {
"image_uri": "us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-12.py310:latest",
"commands": [
"echo",
"test",
],
},
}],
},
opts = pulumi.ResourceOptions(depends_on=[vertex_vpc_connection]))
package main
import (
"fmt"
"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/compute"
"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/vertex"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
vertexNetwork, err := compute.NewNetwork(ctx, "vertex_network", &compute.NetworkArgs{
Name: pulumi.String("custom-job-vpc-net"),
AutoCreateSubnetworks: pulumi.Bool(false),
})
if err != nil {
return err
}
vertexRange, err := compute.NewGlobalAddress(ctx, "vertex_range", &compute.GlobalAddressArgs{
Name: pulumi.String("custom-job-vpc-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
}
project, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{}, nil)
if err != nil {
return err
}
_, err = vertex.NewAiCustomJob(ctx, "custom_job", &vertex.AiCustomJobArgs{
DisplayName: pulumi.String("example-custom-job-tpu"),
Region: pulumi.String("us-central1"),
JobSpec: &vertex.AiCustomJobJobSpecArgs{
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,
},
WorkerPoolSpecs: vertex.AiCustomJobJobSpecWorkerPoolSpecArray{
&vertex.AiCustomJobJobSpecWorkerPoolSpecArgs{
ReplicaCount: pulumi.Int(1),
MachineSpec: &vertex.AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs{
MachineType: pulumi.String("n1-standard-4"),
TpuTopology: pulumi.String("2x2"),
ReservationAffinity: &vertex.AiCustomJobJobSpecWorkerPoolSpecMachineSpecReservationAffinityArgs{
ReservationAffinityType: pulumi.String("SPECIFIC_RESERVATION"),
Key: pulumi.String("compute.googleapis.com/reservation-name"),
Values: pulumi.StringArray{
pulumi.Sprintf("projects/%v/zones/us-central1-z/reservations/example-reservation", project.Number),
},
},
},
DiskSpec: &vertex.AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs{
BootDiskType: pulumi.String("pd-ssd"),
BootDiskSizeGb: pulumi.Int(100),
},
ContainerSpec: &vertex.AiCustomJobJobSpecWorkerPoolSpecContainerSpecArgs{
ImageUri: pulumi.String("us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-12.py310:latest"),
Commands: pulumi.StringArray{
pulumi.String("echo"),
pulumi.String("test"),
},
},
},
},
},
}, pulumi.DependsOn([]pulumi.Resource{
vertexVpcConnection,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var vertexNetwork = new Gcp.Compute.Network("vertex_network", new()
{
Name = "custom-job-vpc-net",
AutoCreateSubnetworks = false,
});
var vertexRange = new Gcp.Compute.GlobalAddress("vertex_range", new()
{
Name = "custom-job-vpc-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 project = Gcp.Organizations.GetProject.Invoke();
var customJob = new Gcp.Vertex.AiCustomJob("custom_job", new()
{
DisplayName = "example-custom-job-tpu",
Region = "us-central1",
JobSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecArgs
{
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,
},
WorkerPoolSpecs = new[]
{
new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecArgs
{
ReplicaCount = 1,
MachineSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs
{
MachineType = "n1-standard-4",
TpuTopology = "2x2",
ReservationAffinity = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecMachineSpecReservationAffinityArgs
{
ReservationAffinityType = "SPECIFIC_RESERVATION",
Key = "compute.googleapis.com/reservation-name",
Values = new[]
{
$"projects/{project.Apply(getProjectResult => getProjectResult.Number)}/zones/us-central1-z/reservations/example-reservation",
},
},
},
DiskSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs
{
BootDiskType = "pd-ssd",
BootDiskSizeGb = 100,
},
ContainerSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecContainerSpecArgs
{
ImageUri = "us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-12.py310:latest",
Commands = new[]
{
"echo",
"test",
},
},
},
},
},
}, new CustomResourceOptions
{
DependsOn =
{
vertexVpcConnection,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.vertex.AiCustomJob;
import com.pulumi.gcp.vertex.AiCustomJobArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecMachineSpecReservationAffinityArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs;
import com.pulumi.gcp.vertex.inputs.AiCustomJobJobSpecWorkerPoolSpecContainerSpecArgs;
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) {
var vertexNetwork = new Network("vertexNetwork", NetworkArgs.builder()
.name("custom-job-vpc-net")
.autoCreateSubnetworks(false)
.build());
var vertexRange = new GlobalAddress("vertexRange", GlobalAddressArgs.builder()
.name("custom-job-vpc-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());
final var project = OrganizationsFunctions.getProject(GetProjectArgs.builder()
.build());
var customJob = new AiCustomJob("customJob", AiCustomJobArgs.builder()
.displayName("example-custom-job-tpu")
.region("us-central1")
.jobSpec(AiCustomJobJobSpecArgs.builder()
.network(vertexNetwork.name().applyValue(_name -> String.format("projects/%s/global/networks/%s", project.number(),_name)))
.reservedIpRanges(vertexRange.name())
.workerPoolSpecs(AiCustomJobJobSpecWorkerPoolSpecArgs.builder()
.replicaCount(1)
.machineSpec(AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs.builder()
.machineType("n1-standard-4")
.tpuTopology("2x2")
.reservationAffinity(AiCustomJobJobSpecWorkerPoolSpecMachineSpecReservationAffinityArgs.builder()
.reservationAffinityType("SPECIFIC_RESERVATION")
.key("compute.googleapis.com/reservation-name")
.values(String.format("projects/%s/zones/us-central1-z/reservations/example-reservation", project.number()))
.build())
.build())
.diskSpec(AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs.builder()
.bootDiskType("pd-ssd")
.bootDiskSizeGb(100)
.build())
.containerSpec(AiCustomJobJobSpecWorkerPoolSpecContainerSpecArgs.builder()
.imageUri("us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-12.py310:latest")
.commands(
"echo",
"test")
.build())
.build())
.build())
.build(), CustomResourceOptions.builder()
.dependsOn(vertexVpcConnection)
.build());
}
}
resources:
customJob:
type: gcp:vertex:AiCustomJob
name: custom_job
properties:
displayName: example-custom-job-tpu
region: us-central1
jobSpec:
network: projects/${project.number}/global/networks/${vertexNetwork.name}
reservedIpRanges:
- ${vertexRange.name}
workerPoolSpecs:
- replicaCount: 1
machineSpec:
machineType: n1-standard-4
tpuTopology: 2x2
reservationAffinity:
reservationAffinityType: SPECIFIC_RESERVATION
key: compute.googleapis.com/reservation-name
values:
- projects/${project.number}/zones/us-central1-z/reservations/example-reservation
diskSpec:
bootDiskType: pd-ssd
bootDiskSizeGb: 100
containerSpec:
imageUri: us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-12.py310:latest
commands:
- echo
- test
options:
dependsOn:
- ${vertexVpcConnection}
vertexNetwork:
type: gcp:compute:Network
name: vertex_network
properties:
name: custom-job-vpc-net
autoCreateSubnetworks: false
vertexRange:
type: gcp:compute:GlobalAddress
name: vertex_range
properties:
name: custom-job-vpc-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}
variables:
project:
fn::invoke:
function: gcp:organizations:getProject
arguments: {}
terraform {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
data "gcp_organizations_project" "project" {
}
resource "gcp_vertex_ai_custom_job" "custom_job" {
depends_on = [gcp_servicenetworking_connection.vertex_vpc_connection]
lifecycle {
create_before_destroy = true
}
display_name = "example-custom-job-tpu"
region = "us-central1"
job_spec = {
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]
worker_pool_specs = [{
replica_count = 1
machine_spec = {
machine_type = "n1-standard-4"
tpu_topology = "2x2"
reservation_affinity = {
reservation_affinity_type = "SPECIFIC_RESERVATION"
key = "compute.googleapis.com/reservation-name"
values = ["projects/${data.gcp_organizations_project.project.number}/zones/us-central1-z/reservations/example-reservation"]
}
}
disk_spec = {
boot_disk_type = "pd-ssd"
boot_disk_size_gb = 100
}
container_spec = {
image_uri = "us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-12.py310:latest"
commands = ["echo", "test"]
}
}]
}
}
resource "gcp_compute_network" "vertex_network" {
lifecycle {
create_before_destroy = true
}
name = "custom-job-vpc-net"
auto_create_subnetworks = false
}
resource "gcp_compute_global_address" "vertex_range" {
lifecycle {
create_before_destroy = true
}
name = "custom-job-vpc-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]
}
Create AiCustomJob Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AiCustomJob(name: string, args: AiCustomJobArgs, opts?: CustomResourceOptions);@overload
def AiCustomJob(resource_name: str,
args: AiCustomJobArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AiCustomJob(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
job_spec: Optional[AiCustomJobJobSpecArgs] = None,
region: Optional[str] = None,
deletion_policy: Optional[str] = None,
encryption_spec: Optional[AiCustomJobEncryptionSpecArgs] = None,
labels: Optional[Mapping[str, str]] = None,
project: Optional[str] = None)func NewAiCustomJob(ctx *Context, name string, args AiCustomJobArgs, opts ...ResourceOption) (*AiCustomJob, error)public AiCustomJob(string name, AiCustomJobArgs args, CustomResourceOptions? opts = null)
public AiCustomJob(String name, AiCustomJobArgs args)
public AiCustomJob(String name, AiCustomJobArgs args, CustomResourceOptions options)
type: gcp:vertex:AiCustomJob
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "gcp_vertex_ai_custom_job" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args AiCustomJobArgs
- 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 AiCustomJobArgs
- 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 AiCustomJobArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AiCustomJobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AiCustomJobArgs
- 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 aiCustomJobResource = new Gcp.Vertex.AiCustomJob("aiCustomJobResource", new()
{
DisplayName = "string",
JobSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecArgs
{
WorkerPoolSpecs = new[]
{
new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecArgs
{
ContainerSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecContainerSpecArgs
{
ImageUri = "string",
Args = new[]
{
"string",
},
Commands = new[]
{
"string",
},
Envs = new[]
{
new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecContainerSpecEnvArgs
{
Name = "string",
Value = "string",
},
},
},
DiskSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs
{
BootDiskSizeGb = 0,
BootDiskType = "string",
},
LustreMounts = new[]
{
new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecLustreMountArgs
{
Filesystem = "string",
InstanceIp = "string",
MountPoint = "string",
VolumeHandle = "string",
},
},
MachineSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs
{
AcceleratorCount = 0,
AcceleratorType = "string",
MachineType = "string",
ReservationAffinity = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecMachineSpecReservationAffinityArgs
{
ReservationAffinityType = "string",
Key = "string",
Values = new[]
{
"string",
},
},
TpuTopology = "string",
},
NfsMounts = new[]
{
new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecNfsMountArgs
{
MountPoint = "string",
Path = "string",
Server = "string",
},
},
PythonPackageSpec = new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecArgs
{
ExecutorImageUri = "string",
PackageUris = new[]
{
"string",
},
PythonModule = "string",
Args = new[]
{
"string",
},
Envs = new[]
{
new Gcp.Vertex.Inputs.AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecEnvArgs
{
Name = "string",
Value = "string",
},
},
},
ReplicaCount = 0,
},
},
Network = "string",
ProtectedArtifactLocationId = "string",
Experiment = "string",
ExperimentRun = "string",
Models = new[]
{
"string",
},
BaseOutputDirectory = new Gcp.Vertex.Inputs.AiCustomJobJobSpecBaseOutputDirectoryArgs
{
OutputUriPrefix = "string",
},
PersistentResourceId = "string",
EnableWebAccess = false,
PscInterfaceConfig = new Gcp.Vertex.Inputs.AiCustomJobJobSpecPscInterfaceConfigArgs
{
DnsPeeringConfigs = new[]
{
new Gcp.Vertex.Inputs.AiCustomJobJobSpecPscInterfaceConfigDnsPeeringConfigArgs
{
Domain = "string",
TargetNetwork = "string",
TargetProject = "string",
},
},
NetworkAttachment = "string",
},
ReservedIpRanges = new[]
{
"string",
},
Scheduling = new Gcp.Vertex.Inputs.AiCustomJobJobSpecSchedulingArgs
{
DisableRetries = false,
MaxWaitDuration = "string",
RestartJobOnWorkerRestart = false,
Strategy = "string",
Timeout = "string",
},
ServiceAccount = "string",
Tensorboard = "string",
EnableDashboardAccess = false,
},
Region = "string",
DeletionPolicy = "string",
EncryptionSpec = new Gcp.Vertex.Inputs.AiCustomJobEncryptionSpecArgs
{
KmsKeyName = "string",
},
Labels =
{
{ "string", "string" },
},
Project = "string",
});
example, err := vertex.NewAiCustomJob(ctx, "aiCustomJobResource", &vertex.AiCustomJobArgs{
DisplayName: pulumi.String("string"),
JobSpec: &vertex.AiCustomJobJobSpecArgs{
WorkerPoolSpecs: vertex.AiCustomJobJobSpecWorkerPoolSpecArray{
&vertex.AiCustomJobJobSpecWorkerPoolSpecArgs{
ContainerSpec: &vertex.AiCustomJobJobSpecWorkerPoolSpecContainerSpecArgs{
ImageUri: pulumi.String("string"),
Args: pulumi.StringArray{
pulumi.String("string"),
},
Commands: pulumi.StringArray{
pulumi.String("string"),
},
Envs: vertex.AiCustomJobJobSpecWorkerPoolSpecContainerSpecEnvArray{
&vertex.AiCustomJobJobSpecWorkerPoolSpecContainerSpecEnvArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
DiskSpec: &vertex.AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs{
BootDiskSizeGb: pulumi.Int(0),
BootDiskType: pulumi.String("string"),
},
LustreMounts: vertex.AiCustomJobJobSpecWorkerPoolSpecLustreMountArray{
&vertex.AiCustomJobJobSpecWorkerPoolSpecLustreMountArgs{
Filesystem: pulumi.String("string"),
InstanceIp: pulumi.String("string"),
MountPoint: pulumi.String("string"),
VolumeHandle: pulumi.String("string"),
},
},
MachineSpec: &vertex.AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs{
AcceleratorCount: pulumi.Int(0),
AcceleratorType: pulumi.String("string"),
MachineType: pulumi.String("string"),
ReservationAffinity: &vertex.AiCustomJobJobSpecWorkerPoolSpecMachineSpecReservationAffinityArgs{
ReservationAffinityType: pulumi.String("string"),
Key: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
TpuTopology: pulumi.String("string"),
},
NfsMounts: vertex.AiCustomJobJobSpecWorkerPoolSpecNfsMountArray{
&vertex.AiCustomJobJobSpecWorkerPoolSpecNfsMountArgs{
MountPoint: pulumi.String("string"),
Path: pulumi.String("string"),
Server: pulumi.String("string"),
},
},
PythonPackageSpec: &vertex.AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecArgs{
ExecutorImageUri: pulumi.String("string"),
PackageUris: pulumi.StringArray{
pulumi.String("string"),
},
PythonModule: pulumi.String("string"),
Args: pulumi.StringArray{
pulumi.String("string"),
},
Envs: vertex.AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecEnvArray{
&vertex.AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecEnvArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
ReplicaCount: pulumi.Int(0),
},
},
Network: pulumi.String("string"),
ProtectedArtifactLocationId: pulumi.String("string"),
Experiment: pulumi.String("string"),
ExperimentRun: pulumi.String("string"),
Models: pulumi.StringArray{
pulumi.String("string"),
},
BaseOutputDirectory: &vertex.AiCustomJobJobSpecBaseOutputDirectoryArgs{
OutputUriPrefix: pulumi.String("string"),
},
PersistentResourceId: pulumi.String("string"),
EnableWebAccess: pulumi.Bool(false),
PscInterfaceConfig: &vertex.AiCustomJobJobSpecPscInterfaceConfigArgs{
DnsPeeringConfigs: vertex.AiCustomJobJobSpecPscInterfaceConfigDnsPeeringConfigArray{
&vertex.AiCustomJobJobSpecPscInterfaceConfigDnsPeeringConfigArgs{
Domain: pulumi.String("string"),
TargetNetwork: pulumi.String("string"),
TargetProject: pulumi.String("string"),
},
},
NetworkAttachment: pulumi.String("string"),
},
ReservedIpRanges: pulumi.StringArray{
pulumi.String("string"),
},
Scheduling: &vertex.AiCustomJobJobSpecSchedulingArgs{
DisableRetries: pulumi.Bool(false),
MaxWaitDuration: pulumi.String("string"),
RestartJobOnWorkerRestart: pulumi.Bool(false),
Strategy: pulumi.String("string"),
Timeout: pulumi.String("string"),
},
ServiceAccount: pulumi.String("string"),
Tensorboard: pulumi.String("string"),
EnableDashboardAccess: pulumi.Bool(false),
},
Region: pulumi.String("string"),
DeletionPolicy: pulumi.String("string"),
EncryptionSpec: &vertex.AiCustomJobEncryptionSpecArgs{
KmsKeyName: pulumi.String("string"),
},
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Project: pulumi.String("string"),
})
resource "gcp_vertex_ai_custom_job" "aiCustomJobResource" {
lifecycle {
create_before_destroy = true
}
display_name = "string"
job_spec = {
worker_pool_specs = [{
container_spec = {
image_uri = "string"
args = ["string"]
commands = ["string"]
envs = [{
name = "string"
value = "string"
}]
}
disk_spec = {
boot_disk_size_gb = 0
boot_disk_type = "string"
}
lustre_mounts = [{
filesystem = "string"
instance_ip = "string"
mount_point = "string"
volume_handle = "string"
}]
machine_spec = {
accelerator_count = 0
accelerator_type = "string"
machine_type = "string"
reservation_affinity = {
reservation_affinity_type = "string"
key = "string"
values = ["string"]
}
tpu_topology = "string"
}
nfs_mounts = [{
mount_point = "string"
path = "string"
server = "string"
}]
python_package_spec = {
executor_image_uri = "string"
package_uris = ["string"]
python_module = "string"
args = ["string"]
envs = [{
name = "string"
value = "string"
}]
}
replica_count = 0
}]
network = "string"
protected_artifact_location_id = "string"
experiment = "string"
experiment_run = "string"
models = ["string"]
base_output_directory = {
output_uri_prefix = "string"
}
persistent_resource_id = "string"
enable_web_access = false
psc_interface_config = {
dns_peering_configs = [{
domain = "string"
target_network = "string"
target_project = "string"
}]
network_attachment = "string"
}
reserved_ip_ranges = ["string"]
scheduling = {
disable_retries = false
max_wait_duration = "string"
restart_job_on_worker_restart = false
strategy = "string"
timeout = "string"
}
service_account = "string"
tensorboard = "string"
enable_dashboard_access = false
}
region = "string"
deletion_policy = "string"
encryption_spec = {
kms_key_name = "string"
}
labels = {
"string" = "string"
}
project = "string"
}
var aiCustomJobResource = new AiCustomJob("aiCustomJobResource", AiCustomJobArgs.builder()
.displayName("string")
.jobSpec(AiCustomJobJobSpecArgs.builder()
.workerPoolSpecs(AiCustomJobJobSpecWorkerPoolSpecArgs.builder()
.containerSpec(AiCustomJobJobSpecWorkerPoolSpecContainerSpecArgs.builder()
.imageUri("string")
.args("string")
.commands("string")
.envs(AiCustomJobJobSpecWorkerPoolSpecContainerSpecEnvArgs.builder()
.name("string")
.value("string")
.build())
.build())
.diskSpec(AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs.builder()
.bootDiskSizeGb(0)
.bootDiskType("string")
.build())
.lustreMounts(AiCustomJobJobSpecWorkerPoolSpecLustreMountArgs.builder()
.filesystem("string")
.instanceIp("string")
.mountPoint("string")
.volumeHandle("string")
.build())
.machineSpec(AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs.builder()
.acceleratorCount(0)
.acceleratorType("string")
.machineType("string")
.reservationAffinity(AiCustomJobJobSpecWorkerPoolSpecMachineSpecReservationAffinityArgs.builder()
.reservationAffinityType("string")
.key("string")
.values("string")
.build())
.tpuTopology("string")
.build())
.nfsMounts(AiCustomJobJobSpecWorkerPoolSpecNfsMountArgs.builder()
.mountPoint("string")
.path("string")
.server("string")
.build())
.pythonPackageSpec(AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecArgs.builder()
.executorImageUri("string")
.packageUris("string")
.pythonModule("string")
.args("string")
.envs(AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecEnvArgs.builder()
.name("string")
.value("string")
.build())
.build())
.replicaCount(0)
.build())
.network("string")
.protectedArtifactLocationId("string")
.experiment("string")
.experimentRun("string")
.models("string")
.baseOutputDirectory(AiCustomJobJobSpecBaseOutputDirectoryArgs.builder()
.outputUriPrefix("string")
.build())
.persistentResourceId("string")
.enableWebAccess(false)
.pscInterfaceConfig(AiCustomJobJobSpecPscInterfaceConfigArgs.builder()
.dnsPeeringConfigs(AiCustomJobJobSpecPscInterfaceConfigDnsPeeringConfigArgs.builder()
.domain("string")
.targetNetwork("string")
.targetProject("string")
.build())
.networkAttachment("string")
.build())
.reservedIpRanges("string")
.scheduling(AiCustomJobJobSpecSchedulingArgs.builder()
.disableRetries(false)
.maxWaitDuration("string")
.restartJobOnWorkerRestart(false)
.strategy("string")
.timeout("string")
.build())
.serviceAccount("string")
.tensorboard("string")
.enableDashboardAccess(false)
.build())
.region("string")
.deletionPolicy("string")
.encryptionSpec(AiCustomJobEncryptionSpecArgs.builder()
.kmsKeyName("string")
.build())
.labels(Map.of("string", "string"))
.project("string")
.build());
ai_custom_job_resource = gcp.vertex.AiCustomJob("aiCustomJobResource",
display_name="string",
job_spec={
"worker_pool_specs": [{
"container_spec": {
"image_uri": "string",
"args": ["string"],
"commands": ["string"],
"envs": [{
"name": "string",
"value": "string",
}],
},
"disk_spec": {
"boot_disk_size_gb": 0,
"boot_disk_type": "string",
},
"lustre_mounts": [{
"filesystem": "string",
"instance_ip": "string",
"mount_point": "string",
"volume_handle": "string",
}],
"machine_spec": {
"accelerator_count": 0,
"accelerator_type": "string",
"machine_type": "string",
"reservation_affinity": {
"reservation_affinity_type": "string",
"key": "string",
"values": ["string"],
},
"tpu_topology": "string",
},
"nfs_mounts": [{
"mount_point": "string",
"path": "string",
"server": "string",
}],
"python_package_spec": {
"executor_image_uri": "string",
"package_uris": ["string"],
"python_module": "string",
"args": ["string"],
"envs": [{
"name": "string",
"value": "string",
}],
},
"replica_count": 0,
}],
"network": "string",
"protected_artifact_location_id": "string",
"experiment": "string",
"experiment_run": "string",
"models": ["string"],
"base_output_directory": {
"output_uri_prefix": "string",
},
"persistent_resource_id": "string",
"enable_web_access": False,
"psc_interface_config": {
"dns_peering_configs": [{
"domain": "string",
"target_network": "string",
"target_project": "string",
}],
"network_attachment": "string",
},
"reserved_ip_ranges": ["string"],
"scheduling": {
"disable_retries": False,
"max_wait_duration": "string",
"restart_job_on_worker_restart": False,
"strategy": "string",
"timeout": "string",
},
"service_account": "string",
"tensorboard": "string",
"enable_dashboard_access": False,
},
region="string",
deletion_policy="string",
encryption_spec={
"kms_key_name": "string",
},
labels={
"string": "string",
},
project="string")
const aiCustomJobResource = new gcp.vertex.AiCustomJob("aiCustomJobResource", {
displayName: "string",
jobSpec: {
workerPoolSpecs: [{
containerSpec: {
imageUri: "string",
args: ["string"],
commands: ["string"],
envs: [{
name: "string",
value: "string",
}],
},
diskSpec: {
bootDiskSizeGb: 0,
bootDiskType: "string",
},
lustreMounts: [{
filesystem: "string",
instanceIp: "string",
mountPoint: "string",
volumeHandle: "string",
}],
machineSpec: {
acceleratorCount: 0,
acceleratorType: "string",
machineType: "string",
reservationAffinity: {
reservationAffinityType: "string",
key: "string",
values: ["string"],
},
tpuTopology: "string",
},
nfsMounts: [{
mountPoint: "string",
path: "string",
server: "string",
}],
pythonPackageSpec: {
executorImageUri: "string",
packageUris: ["string"],
pythonModule: "string",
args: ["string"],
envs: [{
name: "string",
value: "string",
}],
},
replicaCount: 0,
}],
network: "string",
protectedArtifactLocationId: "string",
experiment: "string",
experimentRun: "string",
models: ["string"],
baseOutputDirectory: {
outputUriPrefix: "string",
},
persistentResourceId: "string",
enableWebAccess: false,
pscInterfaceConfig: {
dnsPeeringConfigs: [{
domain: "string",
targetNetwork: "string",
targetProject: "string",
}],
networkAttachment: "string",
},
reservedIpRanges: ["string"],
scheduling: {
disableRetries: false,
maxWaitDuration: "string",
restartJobOnWorkerRestart: false,
strategy: "string",
timeout: "string",
},
serviceAccount: "string",
tensorboard: "string",
enableDashboardAccess: false,
},
region: "string",
deletionPolicy: "string",
encryptionSpec: {
kmsKeyName: "string",
},
labels: {
string: "string",
},
project: "string",
});
type: gcp:vertex:AiCustomJob
properties:
deletionPolicy: string
displayName: string
encryptionSpec:
kmsKeyName: string
jobSpec:
baseOutputDirectory:
outputUriPrefix: string
enableDashboardAccess: false
enableWebAccess: false
experiment: string
experimentRun: string
models:
- string
network: string
persistentResourceId: string
protectedArtifactLocationId: string
pscInterfaceConfig:
dnsPeeringConfigs:
- domain: string
targetNetwork: string
targetProject: string
networkAttachment: string
reservedIpRanges:
- string
scheduling:
disableRetries: false
maxWaitDuration: string
restartJobOnWorkerRestart: false
strategy: string
timeout: string
serviceAccount: string
tensorboard: string
workerPoolSpecs:
- containerSpec:
args:
- string
commands:
- string
envs:
- name: string
value: string
imageUri: string
diskSpec:
bootDiskSizeGb: 0
bootDiskType: string
lustreMounts:
- filesystem: string
instanceIp: string
mountPoint: string
volumeHandle: string
machineSpec:
acceleratorCount: 0
acceleratorType: string
machineType: string
reservationAffinity:
key: string
reservationAffinityType: string
values:
- string
tpuTopology: string
nfsMounts:
- mountPoint: string
path: string
server: string
pythonPackageSpec:
args:
- string
envs:
- name: string
value: string
executorImageUri: string
packageUris:
- string
pythonModule: string
replicaCount: 0
labels:
string: string
project: string
region: string
AiCustomJob 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 AiCustomJob resource accepts the following input properties:
- Display
Name string - The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- Job
Spec AiCustom Job Job Spec - Job spec. Structure is documented below.
- Region string
- The Google Cloud region to run the custom job in.
- Deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. 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", deleting the resource is allowed.
- Encryption
Spec AiCustom Job Encryption Spec - Customer-managed encryption key options for a CustomJob. Structure is documented below.
- Labels Dictionary<string, string>
- The labels with user-defined metadata to organize CustomJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
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. - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Display
Name string - The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- Job
Spec AiCustom Job Job Spec Args - Job spec. Structure is documented below.
- Region string
- The Google Cloud region to run the custom job in.
- Deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. 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", deleting the resource is allowed.
- Encryption
Spec AiCustom Job Encryption Spec Args - Customer-managed encryption key options for a CustomJob. Structure is documented below.
- Labels map[string]string
- The labels with user-defined metadata to organize CustomJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
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. - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- display_
name string - The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- job_
spec object - Job spec. Structure is documented below.
- region string
- The Google Cloud region to run the custom job in.
- deletion_
policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. 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", deleting the resource is allowed.
- encryption_
spec object - Customer-managed encryption key options for a CustomJob. Structure is documented below.
- labels map(string)
- The labels with user-defined metadata to organize CustomJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
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. - project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- display
Name String - The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- job
Spec AiCustom Job Job Spec - Job spec. Structure is documented below.
- region String
- The Google Cloud region to run the custom job in.
- deletion
Policy String - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. 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", deleting the resource is allowed.
- encryption
Spec AiCustom Job Encryption Spec - Customer-managed encryption key options for a CustomJob. Structure is documented below.
- labels Map<String,String>
- The labels with user-defined metadata to organize CustomJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
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. - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- display
Name string - The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- job
Spec AiCustom Job Job Spec - Job spec. Structure is documented below.
- region string
- The Google Cloud region to run the custom job in.
- deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. 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", deleting the resource is allowed.
- encryption
Spec AiCustom Job Encryption Spec - Customer-managed encryption key options for a CustomJob. Structure is documented below.
- labels {[key: string]: string}
- The labels with user-defined metadata to organize CustomJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
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. - project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- display_
name str - The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- job_
spec AiCustom Job Job Spec Args - Job spec. Structure is documented below.
- region str
- The Google Cloud region to run the custom job in.
- deletion_
policy str - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. 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", deleting the resource is allowed.
- encryption_
spec AiCustom Job Encryption Spec Args - Customer-managed encryption key options for a CustomJob. Structure is documented below.
- labels Mapping[str, str]
- The labels with user-defined metadata to organize CustomJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
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. - project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- display
Name String - The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- job
Spec Property Map - Job spec. Structure is documented below.
- region String
- The Google Cloud region to run the custom job in.
- deletion
Policy String - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. 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", deleting the resource is allowed.
- encryption
Spec Property Map - Customer-managed encryption key options for a CustomJob. Structure is documented below.
- labels Map<String>
- The labels with user-defined metadata to organize CustomJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
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. - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Outputs
All input properties are implicitly available as output properties. Additionally, the AiCustomJob resource produces the following output properties:
- Create
Time string - Time when the CustomJob was created.
- 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 - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED,JOB_STATE_FAILED,JOB_STATE_CANCELLED. - Errors
List<Ai
Custom Job Error> - Only populated when job's state is
JOB_STATE_FAILEDorJOB_STATE_CANCELLED. Structure is documented below. - Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The resource name of the CustomJob.
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Start
Time string - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNINGstate. - State string
- The detailed state of the job.
- Update
Time string - Time when the CustomJob was most recently updated.
- Web
Access Dictionary<string, string>Uris - URIs for accessing interactive shells (one URI for each training node).
- Create
Time string - Time when the CustomJob was created.
- 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 - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED,JOB_STATE_FAILED,JOB_STATE_CANCELLED. - Errors
[]Ai
Custom Job Error - Only populated when job's state is
JOB_STATE_FAILEDorJOB_STATE_CANCELLED. Structure is documented below. - Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The resource name of the CustomJob.
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Start
Time string - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNINGstate. - State string
- The detailed state of the job.
- Update
Time string - Time when the CustomJob was most recently updated.
- Web
Access map[string]stringUris - URIs for accessing interactive shells (one URI for each training node).
- create_
time string - Time when the CustomJob was created.
- 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 - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED,JOB_STATE_FAILED,JOB_STATE_CANCELLED. - errors list(object)
- Only populated when job's state is
JOB_STATE_FAILEDorJOB_STATE_CANCELLED. Structure is documented below. - id string
- The provider-assigned unique ID for this managed resource.
- name string
- The resource name of the CustomJob.
- pulumi_
labels map(string) - The combination of labels configured directly on the resource and default labels configured on the provider.
- start_
time string - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNINGstate. - state string
- The detailed state of the job.
- update_
time string - Time when the CustomJob was most recently updated.
- web_
access_ map(string)uris - URIs for accessing interactive shells (one URI for each training node).
- create
Time String - Time when the CustomJob was created.
- 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 - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED,JOB_STATE_FAILED,JOB_STATE_CANCELLED. - errors
List<Ai
Custom Job Error> - Only populated when job's state is
JOB_STATE_FAILEDorJOB_STATE_CANCELLED. Structure is documented below. - id String
- The provider-assigned unique ID for this managed resource.
- name String
- The resource name of the CustomJob.
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- start
Time String - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNINGstate. - state String
- The detailed state of the job.
- update
Time String - Time when the CustomJob was most recently updated.
- web
Access Map<String,String>Uris - URIs for accessing interactive shells (one URI for each training node).
- create
Time string - Time when the CustomJob was created.
- 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 - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED,JOB_STATE_FAILED,JOB_STATE_CANCELLED. - errors
Ai
Custom Job Error[] - Only populated when job's state is
JOB_STATE_FAILEDorJOB_STATE_CANCELLED. Structure is documented below. - id string
- The provider-assigned unique ID for this managed resource.
- name string
- The resource name of the CustomJob.
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- start
Time string - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNINGstate. - state string
- The detailed state of the job.
- update
Time string - Time when the CustomJob was most recently updated.
- web
Access {[key: string]: string}Uris - URIs for accessing interactive shells (one URI for each training node).
- create_
time str - Time when the CustomJob was created.
- 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 - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED,JOB_STATE_FAILED,JOB_STATE_CANCELLED. - errors
Sequence[Ai
Custom Job Error] - Only populated when job's state is
JOB_STATE_FAILEDorJOB_STATE_CANCELLED. Structure is documented below. - id str
- The provider-assigned unique ID for this managed resource.
- name str
- The resource name of the CustomJob.
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- start_
time str - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNINGstate. - state str
- The detailed state of the job.
- update_
time str - Time when the CustomJob was most recently updated.
- web_
access_ Mapping[str, str]uris - URIs for accessing interactive shells (one URI for each training node).
- create
Time String - Time when the CustomJob was created.
- 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 - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED,JOB_STATE_FAILED,JOB_STATE_CANCELLED. - errors List<Property Map>
- Only populated when job's state is
JOB_STATE_FAILEDorJOB_STATE_CANCELLED. Structure is documented below. - id String
- The provider-assigned unique ID for this managed resource.
- name String
- The resource name of the CustomJob.
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- start
Time String - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNINGstate. - state String
- The detailed state of the job.
- update
Time String - Time when the CustomJob was most recently updated.
- web
Access Map<String>Uris - URIs for accessing interactive shells (one URI for each training node).
Look up Existing AiCustomJob Resource
Get an existing AiCustomJob 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?: AiCustomJobState, opts?: CustomResourceOptions): AiCustomJob@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[AiCustomJobEncryptionSpecArgs] = None,
end_time: Optional[str] = None,
errors: Optional[Sequence[AiCustomJobErrorArgs]] = None,
job_spec: Optional[AiCustomJobJobSpecArgs] = None,
labels: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
project: Optional[str] = None,
pulumi_labels: Optional[Mapping[str, str]] = None,
region: Optional[str] = None,
start_time: Optional[str] = None,
state: Optional[str] = None,
update_time: Optional[str] = None,
web_access_uris: Optional[Mapping[str, str]] = None) -> AiCustomJobfunc GetAiCustomJob(ctx *Context, name string, id IDInput, state *AiCustomJobState, opts ...ResourceOption) (*AiCustomJob, error)public static AiCustomJob Get(string name, Input<string> id, AiCustomJobState? state, CustomResourceOptions? opts = null)public static AiCustomJob get(String name, Output<String> id, AiCustomJobState state, CustomResourceOptions options)resources: existingAiCustomJob: type: gcp:vertex:AiCustomJob get: id: ${id}import {
to = gcp_vertex_ai_custom_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 AiCustomJobState
- 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 AiCustomJobState
- 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 AiCustomJobState
- 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 AiCustomJobState
- 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 - Time when the CustomJob was created.
- Deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. 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", deleting the resource is allowed.
- Display
Name string - The display name of the CustomJob. 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 AiCustom Job Encryption Spec - Customer-managed encryption key options for a CustomJob. Structure is documented below.
- End
Time string - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED,JOB_STATE_FAILED,JOB_STATE_CANCELLED. - Errors
List<Ai
Custom Job Error> - Only populated when job's state is
JOB_STATE_FAILEDorJOB_STATE_CANCELLED. Structure is documented below. - Job
Spec AiCustom Job Job Spec - Job spec. Structure is documented below.
- Labels Dictionary<string, string>
- The labels with user-defined metadata to organize CustomJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
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
- The resource name of the CustomJob.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Region string
- The Google Cloud region to run the custom job in.
- Start
Time string - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNINGstate. - State string
- The detailed state of the job.
- Update
Time string - Time when the CustomJob was most recently updated.
- Web
Access Dictionary<string, string>Uris - URIs for accessing interactive shells (one URI for each training node).
- Create
Time string - Time when the CustomJob was created.
- Deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. 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", deleting the resource is allowed.
- Display
Name string - The display name of the CustomJob. 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 AiCustom Job Encryption Spec Args - Customer-managed encryption key options for a CustomJob. Structure is documented below.
- End
Time string - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED,JOB_STATE_FAILED,JOB_STATE_CANCELLED. - Errors
[]Ai
Custom Job Error Args - Only populated when job's state is
JOB_STATE_FAILEDorJOB_STATE_CANCELLED. Structure is documented below. - Job
Spec AiCustom Job Job Spec Args - Job spec. Structure is documented below.
- Labels map[string]string
- The labels with user-defined metadata to organize CustomJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
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
- The resource name of the CustomJob.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Region string
- The Google Cloud region to run the custom job in.
- Start
Time string - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNINGstate. - State string
- The detailed state of the job.
- Update
Time string - Time when the CustomJob was most recently updated.
- Web
Access map[string]stringUris - URIs for accessing interactive shells (one URI for each training node).
- create_
time string - Time when the CustomJob was created.
- deletion_
policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. 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", deleting the resource is allowed.
- display_
name string - The display name of the CustomJob. 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 CustomJob. Structure is documented below.
- end_
time string - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED,JOB_STATE_FAILED,JOB_STATE_CANCELLED. - errors list(object)
- Only populated when job's state is
JOB_STATE_FAILEDorJOB_STATE_CANCELLED. Structure is documented below. - job_
spec object - Job spec. Structure is documented below.
- labels map(string)
- The labels with user-defined metadata to organize CustomJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
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
- The resource name of the CustomJob.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi_
labels map(string) - The combination of labels configured directly on the resource and default labels configured on the provider.
- region string
- The Google Cloud region to run the custom job in.
- start_
time string - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNINGstate. - state string
- The detailed state of the job.
- update_
time string - Time when the CustomJob was most recently updated.
- web_
access_ map(string)uris - URIs for accessing interactive shells (one URI for each training node).
- create
Time String - Time when the CustomJob was created.
- deletion
Policy String - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. 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", deleting the resource is allowed.
- display
Name String - The display name of the CustomJob. 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 AiCustom Job Encryption Spec - Customer-managed encryption key options for a CustomJob. Structure is documented below.
- end
Time String - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED,JOB_STATE_FAILED,JOB_STATE_CANCELLED. - errors
List<Ai
Custom Job Error> - Only populated when job's state is
JOB_STATE_FAILEDorJOB_STATE_CANCELLED. Structure is documented below. - job
Spec AiCustom Job Job Spec - Job spec. Structure is documented below.
- labels Map<String,String>
- The labels with user-defined metadata to organize CustomJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
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
- The resource name of the CustomJob.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- region String
- The Google Cloud region to run the custom job in.
- start
Time String - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNINGstate. - state String
- The detailed state of the job.
- update
Time String - Time when the CustomJob was most recently updated.
- web
Access Map<String,String>Uris - URIs for accessing interactive shells (one URI for each training node).
- create
Time string - Time when the CustomJob was created.
- deletion
Policy string - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. 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", deleting the resource is allowed.
- display
Name string - The display name of the CustomJob. 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 AiCustom Job Encryption Spec - Customer-managed encryption key options for a CustomJob. Structure is documented below.
- end
Time string - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED,JOB_STATE_FAILED,JOB_STATE_CANCELLED. - errors
Ai
Custom Job Error[] - Only populated when job's state is
JOB_STATE_FAILEDorJOB_STATE_CANCELLED. Structure is documented below. - job
Spec AiCustom Job Job Spec - Job spec. Structure is documented below.
- labels {[key: string]: string}
- The labels with user-defined metadata to organize CustomJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
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
- The resource name of the CustomJob.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- region string
- The Google Cloud region to run the custom job in.
- start
Time string - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNINGstate. - state string
- The detailed state of the job.
- update
Time string - Time when the CustomJob was most recently updated.
- web
Access {[key: string]: string}Uris - URIs for accessing interactive shells (one URI for each training node).
- create_
time str - Time when the CustomJob was created.
- deletion_
policy str - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. 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", deleting the resource is allowed.
- display_
name str - The display name of the CustomJob. 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 AiCustom Job Encryption Spec Args - Customer-managed encryption key options for a CustomJob. Structure is documented below.
- end_
time str - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED,JOB_STATE_FAILED,JOB_STATE_CANCELLED. - errors
Sequence[Ai
Custom Job Error Args] - Only populated when job's state is
JOB_STATE_FAILEDorJOB_STATE_CANCELLED. Structure is documented below. - job_
spec AiCustom Job Job Spec Args - Job spec. Structure is documented below.
- labels Mapping[str, str]
- The labels with user-defined metadata to organize CustomJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
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
- The resource name of the CustomJob.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- region str
- The Google Cloud region to run the custom job in.
- start_
time str - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNINGstate. - state str
- The detailed state of the job.
- update_
time str - Time when the CustomJob was most recently updated.
- web_
access_ Mapping[str, str]uris - URIs for accessing interactive shells (one URI for each training node).
- create
Time String - Time when the CustomJob was created.
- deletion
Policy String - Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. 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", deleting the resource is allowed.
- display
Name String - The display name of the CustomJob. 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 CustomJob. Structure is documented below.
- end
Time String - Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED,JOB_STATE_FAILED,JOB_STATE_CANCELLED. - errors List<Property Map>
- Only populated when job's state is
JOB_STATE_FAILEDorJOB_STATE_CANCELLED. Structure is documented below. - job
Spec Property Map - Job spec. Structure is documented below.
- labels Map<String>
- The labels with user-defined metadata to organize CustomJobs.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.
See https://goo.gl/xmQnxf for more information and examples of labels.
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
- The resource name of the CustomJob.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- region String
- The Google Cloud region to run the custom job in.
- start
Time String - Time when the CustomJob for the first time entered the
JOB_STATE_RUNNINGstate. - state String
- The detailed state of the job.
- update
Time String - Time when the CustomJob was most recently updated.
- web
Access Map<String>Uris - URIs for accessing interactive shells (one URI for each training node).
Supporting Types
AiCustomJobEncryptionSpec, AiCustomJobEncryptionSpecArgs
- Kms
Key stringName - Resource name of the Cloud KMS key used to protect the resource.
The Cloud KMS key must be in the same region as the resource. It must have the format
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
- Kms
Key stringName - Resource name of the Cloud KMS key used to protect the resource.
The Cloud KMS key must be in the same region as the resource. It must have the format
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
- kms_
key_ stringname - Resource name of the Cloud KMS key used to protect the resource.
The Cloud KMS key must be in the same region as the resource. It must have the format
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
- kms
Key StringName - Resource name of the Cloud KMS key used to protect the resource.
The Cloud KMS key must be in the same region as the resource. It must have the format
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
- kms
Key stringName - Resource name of the Cloud KMS key used to protect the resource.
The Cloud KMS key must be in the same region as the resource. It must have the format
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
- kms_
key_ strname - Resource name of the Cloud KMS key used to protect the resource.
The Cloud KMS key must be in the same region as the resource. It must have the format
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
- kms
Key StringName - Resource name of the Cloud KMS key used to protect the resource.
The Cloud KMS key must be in the same region as the resource. It must have the format
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
AiCustomJobError, AiCustomJobErrorArgs
AiCustomJobJobSpec, AiCustomJobJobSpecArgs
- Worker
Pool List<AiSpecs Custom Job Job Spec Worker Pool Spec> - The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value. Structure is documented below.
- Base
Output AiDirectory Custom Job Job Spec Base Output Directory - The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. Structure is documented below.
- Enable
Dashboard boolAccess - Whether you want Vertex AI to enable access to the customized dashboard in training chief container.
- Enable
Web boolAccess - Whether you want Vertex AI to enable interactive shell access to training containers.
- Experiment string
- The Experiment associated with this job.
Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name} - Experiment
Run string - The Experiment Run associated with this job.
Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name} - Models List<string>
- The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs.
Format:
projects/{project}/locations/{location}/models/{model}In order to retrieve a specific version of the model, also provide the version ID or version alias. Example:projects/{project}/locations/{location}/models/{model}@2orprojects/{project}/locations/{location}/models/{model}@goldenIf no version ID or alias is specified, the "default" version will be returned. - Network string
- The full name of the Compute Engine network to which the Job should be peered.
- Persistent
Resource stringId - The ID of the PersistentResource in the same Project and Location which to run. If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
- Protected
Artifact stringLocation Id - The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location.
- Psc
Interface AiConfig Custom Job Job Spec Psc Interface Config - Configuration for PSC-I for CustomJob. Structure is documented below.
- Reserved
Ip List<string>Ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this job.
- Scheduling
Ai
Custom Job Job Spec Scheduling - Scheduling options for a CustomJob. Structure is documented below.
- Service
Account string - Specifies the service account for workload run-as account.
- Tensorboard string
- The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs.
- Worker
Pool []AiSpecs Custom Job Job Spec Worker Pool Spec - The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value. Structure is documented below.
- Base
Output AiDirectory Custom Job Job Spec Base Output Directory - The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. Structure is documented below.
- Enable
Dashboard boolAccess - Whether you want Vertex AI to enable access to the customized dashboard in training chief container.
- Enable
Web boolAccess - Whether you want Vertex AI to enable interactive shell access to training containers.
- Experiment string
- The Experiment associated with this job.
Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name} - Experiment
Run string - The Experiment Run associated with this job.
Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name} - Models []string
- The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs.
Format:
projects/{project}/locations/{location}/models/{model}In order to retrieve a specific version of the model, also provide the version ID or version alias. Example:projects/{project}/locations/{location}/models/{model}@2orprojects/{project}/locations/{location}/models/{model}@goldenIf no version ID or alias is specified, the "default" version will be returned. - Network string
- The full name of the Compute Engine network to which the Job should be peered.
- Persistent
Resource stringId - The ID of the PersistentResource in the same Project and Location which to run. If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
- Protected
Artifact stringLocation Id - The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location.
- Psc
Interface AiConfig Custom Job Job Spec Psc Interface Config - Configuration for PSC-I for CustomJob. Structure is documented below.
- Reserved
Ip []stringRanges - A list of names for the reserved ip ranges under the VPC network that can be used for this job.
- Scheduling
Ai
Custom Job Job Spec Scheduling - Scheduling options for a CustomJob. Structure is documented below.
- Service
Account string - Specifies the service account for workload run-as account.
- Tensorboard string
- The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs.
- worker_
pool_ list(object)specs - The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value. Structure is documented below.
- base_
output_ objectdirectory - The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. Structure is documented below.
- enable_
dashboard_ boolaccess - Whether you want Vertex AI to enable access to the customized dashboard in training chief container.
- enable_
web_ boolaccess - Whether you want Vertex AI to enable interactive shell access to training containers.
- experiment string
- The Experiment associated with this job.
Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name} - experiment_
run string - The Experiment Run associated with this job.
Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name} - models list(string)
- The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs.
Format:
projects/{project}/locations/{location}/models/{model}In order to retrieve a specific version of the model, also provide the version ID or version alias. Example:projects/{project}/locations/{location}/models/{model}@2orprojects/{project}/locations/{location}/models/{model}@goldenIf no version ID or alias is specified, the "default" version will be returned. - network string
- The full name of the Compute Engine network to which the Job should be peered.
- persistent_
resource_ stringid - The ID of the PersistentResource in the same Project and Location which to run. If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
- protected_
artifact_ stringlocation_ id - The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location.
- psc_
interface_ objectconfig - Configuration for PSC-I for CustomJob. Structure is documented below.
- reserved_
ip_ list(string)ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this job.
- scheduling object
- Scheduling options for a CustomJob. Structure is documented below.
- service_
account string - Specifies the service account for workload run-as account.
- tensorboard string
- The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs.
- worker
Pool List<AiSpecs Custom Job Job Spec Worker Pool Spec> - The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value. Structure is documented below.
- base
Output AiDirectory Custom Job Job Spec Base Output Directory - The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. Structure is documented below.
- enable
Dashboard BooleanAccess - Whether you want Vertex AI to enable access to the customized dashboard in training chief container.
- enable
Web BooleanAccess - Whether you want Vertex AI to enable interactive shell access to training containers.
- experiment String
- The Experiment associated with this job.
Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name} - experiment
Run String - The Experiment Run associated with this job.
Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name} - models List<String>
- The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs.
Format:
projects/{project}/locations/{location}/models/{model}In order to retrieve a specific version of the model, also provide the version ID or version alias. Example:projects/{project}/locations/{location}/models/{model}@2orprojects/{project}/locations/{location}/models/{model}@goldenIf no version ID or alias is specified, the "default" version will be returned. - network String
- The full name of the Compute Engine network to which the Job should be peered.
- persistent
Resource StringId - The ID of the PersistentResource in the same Project and Location which to run. If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
- protected
Artifact StringLocation Id - The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location.
- psc
Interface AiConfig Custom Job Job Spec Psc Interface Config - Configuration for PSC-I for CustomJob. Structure is documented below.
- reserved
Ip List<String>Ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this job.
- scheduling
Ai
Custom Job Job Spec Scheduling - Scheduling options for a CustomJob. Structure is documented below.
- service
Account String - Specifies the service account for workload run-as account.
- tensorboard String
- The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs.
- worker
Pool AiSpecs Custom Job Job Spec Worker Pool Spec[] - The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value. Structure is documented below.
- base
Output AiDirectory Custom Job Job Spec Base Output Directory - The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. Structure is documented below.
- enable
Dashboard booleanAccess - Whether you want Vertex AI to enable access to the customized dashboard in training chief container.
- enable
Web booleanAccess - Whether you want Vertex AI to enable interactive shell access to training containers.
- experiment string
- The Experiment associated with this job.
Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name} - experiment
Run string - The Experiment Run associated with this job.
Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name} - models string[]
- The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs.
Format:
projects/{project}/locations/{location}/models/{model}In order to retrieve a specific version of the model, also provide the version ID or version alias. Example:projects/{project}/locations/{location}/models/{model}@2orprojects/{project}/locations/{location}/models/{model}@goldenIf no version ID or alias is specified, the "default" version will be returned. - network string
- The full name of the Compute Engine network to which the Job should be peered.
- persistent
Resource stringId - The ID of the PersistentResource in the same Project and Location which to run. If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
- protected
Artifact stringLocation Id - The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location.
- psc
Interface AiConfig Custom Job Job Spec Psc Interface Config - Configuration for PSC-I for CustomJob. Structure is documented below.
- reserved
Ip string[]Ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this job.
- scheduling
Ai
Custom Job Job Spec Scheduling - Scheduling options for a CustomJob. Structure is documented below.
- service
Account string - Specifies the service account for workload run-as account.
- tensorboard string
- The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs.
- worker_
pool_ Sequence[Aispecs Custom Job Job Spec Worker Pool Spec] - The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value. Structure is documented below.
- base_
output_ Aidirectory Custom Job Job Spec Base Output Directory - The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. Structure is documented below.
- enable_
dashboard_ boolaccess - Whether you want Vertex AI to enable access to the customized dashboard in training chief container.
- enable_
web_ boolaccess - Whether you want Vertex AI to enable interactive shell access to training containers.
- experiment str
- The Experiment associated with this job.
Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name} - experiment_
run str - The Experiment Run associated with this job.
Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name} - models Sequence[str]
- The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs.
Format:
projects/{project}/locations/{location}/models/{model}In order to retrieve a specific version of the model, also provide the version ID or version alias. Example:projects/{project}/locations/{location}/models/{model}@2orprojects/{project}/locations/{location}/models/{model}@goldenIf no version ID or alias is specified, the "default" version will be returned. - network str
- The full name of the Compute Engine network to which the Job should be peered.
- persistent_
resource_ strid - The ID of the PersistentResource in the same Project and Location which to run. If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
- protected_
artifact_ strlocation_ id - The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location.
- psc_
interface_ Aiconfig Custom Job Job Spec Psc Interface Config - Configuration for PSC-I for CustomJob. Structure is documented below.
- reserved_
ip_ Sequence[str]ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this job.
- scheduling
Ai
Custom Job Job Spec Scheduling - Scheduling options for a CustomJob. Structure is documented below.
- service_
account str - Specifies the service account for workload run-as account.
- tensorboard str
- The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs.
- worker
Pool List<Property Map>Specs - The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value. Structure is documented below.
- base
Output Property MapDirectory - The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. Structure is documented below.
- enable
Dashboard BooleanAccess - Whether you want Vertex AI to enable access to the customized dashboard in training chief container.
- enable
Web BooleanAccess - Whether you want Vertex AI to enable interactive shell access to training containers.
- experiment String
- The Experiment associated with this job.
Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name} - experiment
Run String - The Experiment Run associated with this job.
Format:
projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name} - models List<String>
- The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs.
Format:
projects/{project}/locations/{location}/models/{model}In order to retrieve a specific version of the model, also provide the version ID or version alias. Example:projects/{project}/locations/{location}/models/{model}@2orprojects/{project}/locations/{location}/models/{model}@goldenIf no version ID or alias is specified, the "default" version will be returned. - network String
- The full name of the Compute Engine network to which the Job should be peered.
- persistent
Resource StringId - The ID of the PersistentResource in the same Project and Location which to run. If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.
- protected
Artifact StringLocation Id - The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location.
- psc
Interface Property MapConfig - Configuration for PSC-I for CustomJob. Structure is documented below.
- reserved
Ip List<String>Ranges - A list of names for the reserved ip ranges under the VPC network that can be used for this job.
- scheduling Property Map
- Scheduling options for a CustomJob. Structure is documented below.
- service
Account String - Specifies the service account for workload run-as account.
- tensorboard String
- The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs.
AiCustomJobJobSpecBaseOutputDirectory, AiCustomJobJobSpecBaseOutputDirectoryArgs
- Output
Uri stringPrefix - Cloud Storage folder URL to store the output.
- Output
Uri stringPrefix - Cloud Storage folder URL to store the output.
- output_
uri_ stringprefix - Cloud Storage folder URL to store the output.
- output
Uri StringPrefix - Cloud Storage folder URL to store the output.
- output
Uri stringPrefix - Cloud Storage folder URL to store the output.
- output_
uri_ strprefix - Cloud Storage folder URL to store the output.
- output
Uri StringPrefix - Cloud Storage folder URL to store the output.
AiCustomJobJobSpecPscInterfaceConfig, AiCustomJobJobSpecPscInterfaceConfigArgs
- Dns
Peering List<AiConfigs Custom Job Job Spec Psc Interface Config Dns Peering Config> - DNS peering config for the PSC interface. Structure is documented below.
- Network
Attachment string - The name of the attachment to connect to.
- Dns
Peering []AiConfigs Custom Job Job Spec Psc Interface Config Dns Peering Config - DNS peering config for the PSC interface. Structure is documented below.
- Network
Attachment string - The name of the attachment to connect to.
- dns_
peering_ list(object)configs - DNS peering config for the PSC interface. Structure is documented below.
- network_
attachment string - The name of the attachment to connect to.
- dns
Peering List<AiConfigs Custom Job Job Spec Psc Interface Config Dns Peering Config> - DNS peering config for the PSC interface. Structure is documented below.
- network
Attachment String - The name of the attachment to connect to.
- dns
Peering AiConfigs Custom Job Job Spec Psc Interface Config Dns Peering Config[] - DNS peering config for the PSC interface. Structure is documented below.
- network
Attachment string - The name of the attachment to connect to.
- dns_
peering_ Sequence[Aiconfigs Custom Job Job Spec Psc Interface Config Dns Peering Config] - DNS peering config for the PSC interface. Structure is documented below.
- network_
attachment str - The name of the attachment to connect to.
- dns
Peering List<Property Map>Configs - DNS peering config for the PSC interface. Structure is documented below.
- network
Attachment String - The name of the attachment to connect to.
AiCustomJobJobSpecPscInterfaceConfigDnsPeeringConfig, AiCustomJobJobSpecPscInterfaceConfigDnsPeeringConfigArgs
- 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 'domain'. The Vertex AI Service Agent requires 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 'domain'. The Vertex AI Service Agent requires 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 'domain'. The Vertex AI Service Agent requires 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 'domain'. The Vertex AI Service Agent requires 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 'domain'. The Vertex AI Service Agent requires 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 'domain'. The Vertex AI Service Agent requires 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 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
AiCustomJobJobSpecScheduling, AiCustomJobJobSpecSchedulingArgs
- Disable
Retries bool - Indicates if the job should retry for internal errors after the job starts running.
- Max
Wait stringDuration - The maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to FLEX_START.
- Restart
Job boolOn Worker Restart - Restarts the entire CustomJob if a worker gets restarted.
- Strategy string
- This determines which type of scheduling strategy to use. Possible values: ["STANDARD", "SPOT", "FLEX_START"]
- Timeout string
- The maximum job running time. The default is 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
- Disable
Retries bool - Indicates if the job should retry for internal errors after the job starts running.
- Max
Wait stringDuration - The maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to FLEX_START.
- Restart
Job boolOn Worker Restart - Restarts the entire CustomJob if a worker gets restarted.
- Strategy string
- This determines which type of scheduling strategy to use. Possible values: ["STANDARD", "SPOT", "FLEX_START"]
- Timeout string
- The maximum job running time. The default is 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
- disable_
retries bool - Indicates if the job should retry for internal errors after the job starts running.
- max_
wait_ stringduration - The maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to FLEX_START.
- restart_
job_ boolon_ worker_ restart - Restarts the entire CustomJob if a worker gets restarted.
- strategy string
- This determines which type of scheduling strategy to use. Possible values: ["STANDARD", "SPOT", "FLEX_START"]
- timeout string
- The maximum job running time. The default is 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
- disable
Retries Boolean - Indicates if the job should retry for internal errors after the job starts running.
- max
Wait StringDuration - The maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to FLEX_START.
- restart
Job BooleanOn Worker Restart - Restarts the entire CustomJob if a worker gets restarted.
- strategy String
- This determines which type of scheduling strategy to use. Possible values: ["STANDARD", "SPOT", "FLEX_START"]
- timeout String
- The maximum job running time. The default is 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
- disable
Retries boolean - Indicates if the job should retry for internal errors after the job starts running.
- max
Wait stringDuration - The maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to FLEX_START.
- restart
Job booleanOn Worker Restart - Restarts the entire CustomJob if a worker gets restarted.
- strategy string
- This determines which type of scheduling strategy to use. Possible values: ["STANDARD", "SPOT", "FLEX_START"]
- timeout string
- The maximum job running time. The default is 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
- disable_
retries bool - Indicates if the job should retry for internal errors after the job starts running.
- max_
wait_ strduration - The maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to FLEX_START.
- restart_
job_ boolon_ worker_ restart - Restarts the entire CustomJob if a worker gets restarted.
- strategy str
- This determines which type of scheduling strategy to use. Possible values: ["STANDARD", "SPOT", "FLEX_START"]
- timeout str
- The maximum job running time. The default is 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
- disable
Retries Boolean - Indicates if the job should retry for internal errors after the job starts running.
- max
Wait StringDuration - The maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to FLEX_START.
- restart
Job BooleanOn Worker Restart - Restarts the entire CustomJob if a worker gets restarted.
- strategy String
- This determines which type of scheduling strategy to use. Possible values: ["STANDARD", "SPOT", "FLEX_START"]
- timeout String
- The maximum job running time. The default is 7 days. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
AiCustomJobJobSpecWorkerPoolSpec, AiCustomJobJobSpecWorkerPoolSpecArgs
- Container
Spec AiCustom Job Job Spec Worker Pool Spec Container Spec - The custom container task. Either
containerSpecorpythonPackageSpeccan be provided, but not both. Structure is documented below. - Disk
Spec AiCustom Job Job Spec Worker Pool Spec Disk Spec - Disk spec. Structure is documented below.
- Lustre
Mounts List<AiCustom Job Job Spec Worker Pool Spec Lustre Mount> - List of Lustre mounts. Structure is documented below.
- Machine
Spec AiCustom Job Job Spec Worker Pool Spec Machine Spec - Specification of a single machine. Structure is documented below.
- Nfs
Mounts List<AiCustom Job Job Spec Worker Pool Spec Nfs Mount> - List of NFS mount spec. Structure is documented below.
- Python
Package AiSpec Custom Job Job Spec Worker Pool Spec Python Package Spec - The Python packaged task. Either
containerSpecorpythonPackageSpeccan be provided, but not both. Structure is documented below. - Replica
Count int - The number of worker replicas to use for this worker pool.
- Container
Spec AiCustom Job Job Spec Worker Pool Spec Container Spec - The custom container task. Either
containerSpecorpythonPackageSpeccan be provided, but not both. Structure is documented below. - Disk
Spec AiCustom Job Job Spec Worker Pool Spec Disk Spec - Disk spec. Structure is documented below.
- Lustre
Mounts []AiCustom Job Job Spec Worker Pool Spec Lustre Mount - List of Lustre mounts. Structure is documented below.
- Machine
Spec AiCustom Job Job Spec Worker Pool Spec Machine Spec - Specification of a single machine. Structure is documented below.
- Nfs
Mounts []AiCustom Job Job Spec Worker Pool Spec Nfs Mount - List of NFS mount spec. Structure is documented below.
- Python
Package AiSpec Custom Job Job Spec Worker Pool Spec Python Package Spec - The Python packaged task. Either
containerSpecorpythonPackageSpeccan be provided, but not both. Structure is documented below. - Replica
Count int - The number of worker replicas to use for this worker pool.
- container_
spec object - The custom container task. Either
containerSpecorpythonPackageSpeccan be provided, but not both. Structure is documented below. - disk_
spec object - Disk spec. Structure is documented below.
- lustre_
mounts list(object) - List of Lustre mounts. Structure is documented below.
- machine_
spec object - Specification of a single machine. Structure is documented below.
- nfs_
mounts list(object) - List of NFS mount spec. Structure is documented below.
- python_
package_ objectspec - The Python packaged task. Either
containerSpecorpythonPackageSpeccan be provided, but not both. Structure is documented below. - replica_
count number - The number of worker replicas to use for this worker pool.
- container
Spec AiCustom Job Job Spec Worker Pool Spec Container Spec - The custom container task. Either
containerSpecorpythonPackageSpeccan be provided, but not both. Structure is documented below. - disk
Spec AiCustom Job Job Spec Worker Pool Spec Disk Spec - Disk spec. Structure is documented below.
- lustre
Mounts List<AiCustom Job Job Spec Worker Pool Spec Lustre Mount> - List of Lustre mounts. Structure is documented below.
- machine
Spec AiCustom Job Job Spec Worker Pool Spec Machine Spec - Specification of a single machine. Structure is documented below.
- nfs
Mounts List<AiCustom Job Job Spec Worker Pool Spec Nfs Mount> - List of NFS mount spec. Structure is documented below.
- python
Package AiSpec Custom Job Job Spec Worker Pool Spec Python Package Spec - The Python packaged task. Either
containerSpecorpythonPackageSpeccan be provided, but not both. Structure is documented below. - replica
Count Integer - The number of worker replicas to use for this worker pool.
- container
Spec AiCustom Job Job Spec Worker Pool Spec Container Spec - The custom container task. Either
containerSpecorpythonPackageSpeccan be provided, but not both. Structure is documented below. - disk
Spec AiCustom Job Job Spec Worker Pool Spec Disk Spec - Disk spec. Structure is documented below.
- lustre
Mounts AiCustom Job Job Spec Worker Pool Spec Lustre Mount[] - List of Lustre mounts. Structure is documented below.
- machine
Spec AiCustom Job Job Spec Worker Pool Spec Machine Spec - Specification of a single machine. Structure is documented below.
- nfs
Mounts AiCustom Job Job Spec Worker Pool Spec Nfs Mount[] - List of NFS mount spec. Structure is documented below.
- python
Package AiSpec Custom Job Job Spec Worker Pool Spec Python Package Spec - The Python packaged task. Either
containerSpecorpythonPackageSpeccan be provided, but not both. Structure is documented below. - replica
Count number - The number of worker replicas to use for this worker pool.
- container_
spec AiCustom Job Job Spec Worker Pool Spec Container Spec - The custom container task. Either
containerSpecorpythonPackageSpeccan be provided, but not both. Structure is documented below. - disk_
spec AiCustom Job Job Spec Worker Pool Spec Disk Spec - Disk spec. Structure is documented below.
- lustre_
mounts Sequence[AiCustom Job Job Spec Worker Pool Spec Lustre Mount] - List of Lustre mounts. Structure is documented below.
- machine_
spec AiCustom Job Job Spec Worker Pool Spec Machine Spec - Specification of a single machine. Structure is documented below.
- nfs_
mounts Sequence[AiCustom Job Job Spec Worker Pool Spec Nfs Mount] - List of NFS mount spec. Structure is documented below.
- python_
package_ Aispec Custom Job Job Spec Worker Pool Spec Python Package Spec - The Python packaged task. Either
containerSpecorpythonPackageSpeccan be provided, but not both. Structure is documented below. - replica_
count int - The number of worker replicas to use for this worker pool.
- container
Spec Property Map - The custom container task. Either
containerSpecorpythonPackageSpeccan be provided, but not both. Structure is documented below. - disk
Spec Property Map - Disk spec. Structure is documented below.
- lustre
Mounts List<Property Map> - List of Lustre mounts. Structure is documented below.
- machine
Spec Property Map - Specification of a single machine. Structure is documented below.
- nfs
Mounts List<Property Map> - List of NFS mount spec. Structure is documented below.
- python
Package Property MapSpec - The Python packaged task. Either
containerSpecorpythonPackageSpeccan be provided, but not both. Structure is documented below. - replica
Count Number - The number of worker replicas to use for this worker pool.
AiCustomJobJobSpecWorkerPoolSpecContainerSpec, AiCustomJobJobSpecWorkerPoolSpecContainerSpecArgs
- Image
Uri string - The URI of a container image in the Container Registry that is to be run on each worker replica.
- Args List<string>
- The arguments to be passed when starting the container.
- Commands List<string>
- The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
- Envs
List<Ai
Custom Job Job Spec Worker Pool Spec Container Spec Env> - Environment variables to be passed to the container. Maximum limit is 100. Structure is documented below.
- Image
Uri string - The URI of a container image in the Container Registry that is to be run on each worker replica.
- Args []string
- The arguments to be passed when starting the container.
- Commands []string
- The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
- Envs
[]Ai
Custom Job Job Spec Worker Pool Spec Container Spec Env - Environment variables to be passed to the container. Maximum limit is 100. Structure is documented below.
- image_
uri string - The URI of a container image in the Container Registry that is to be run on each worker replica.
- args list(string)
- The arguments to be passed when starting the container.
- commands list(string)
- The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
- envs list(object)
- Environment variables to be passed to the container. Maximum limit is 100. Structure is documented below.
- image
Uri String - The URI of a container image in the Container Registry that is to be run on each worker replica.
- args List<String>
- The arguments to be passed when starting the container.
- commands List<String>
- The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
- envs
List<Ai
Custom Job Job Spec Worker Pool Spec Container Spec Env> - Environment variables to be passed to the container. Maximum limit is 100. Structure is documented below.
- image
Uri string - The URI of a container image in the Container Registry that is to be run on each worker replica.
- args string[]
- The arguments to be passed when starting the container.
- commands string[]
- The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
- envs
Ai
Custom Job Job Spec Worker Pool Spec Container Spec Env[] - Environment variables to be passed to the container. Maximum limit is 100. Structure is documented below.
- image_
uri str - The URI of a container image in the Container Registry that is to be run on each worker replica.
- args Sequence[str]
- The arguments to be passed when starting the container.
- commands Sequence[str]
- The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
- envs
Sequence[Ai
Custom Job Job Spec Worker Pool Spec Container Spec Env] - Environment variables to be passed to the container. Maximum limit is 100. Structure is documented below.
- image
Uri String - The URI of a container image in the Container Registry that is to be run on each worker replica.
- args List<String>
- The arguments to be passed when starting the container.
- commands List<String>
- The command to be invoked when the container is started. It overrides the entrypoint instruction in Dockerfile when provided.
- envs List<Property Map>
- Environment variables to be passed to the container. Maximum limit is 100. Structure is documented below.
AiCustomJobJobSpecWorkerPoolSpecContainerSpecEnv, AiCustomJobJobSpecWorkerPoolSpecContainerSpecEnvArgs
AiCustomJobJobSpecWorkerPoolSpecDiskSpec, AiCustomJobJobSpecWorkerPoolSpecDiskSpecArgs
- Boot
Disk intSize Gb - Size in GB of the boot disk (default is 100GB).
- Boot
Disk stringType - Type of the disk. The default value depends on the machine type. Valid values include: "pd-ssd", "pd-standard", "pd-balanced", and "hyperdisk-balanced".
- Boot
Disk intSize Gb - Size in GB of the boot disk (default is 100GB).
- Boot
Disk stringType - Type of the disk. The default value depends on the machine type. Valid values include: "pd-ssd", "pd-standard", "pd-balanced", and "hyperdisk-balanced".
- boot_
disk_ numbersize_ gb - Size in GB of the boot disk (default is 100GB).
- boot_
disk_ stringtype - Type of the disk. The default value depends on the machine type. Valid values include: "pd-ssd", "pd-standard", "pd-balanced", and "hyperdisk-balanced".
- boot
Disk IntegerSize Gb - Size in GB of the boot disk (default is 100GB).
- boot
Disk StringType - Type of the disk. The default value depends on the machine type. Valid values include: "pd-ssd", "pd-standard", "pd-balanced", and "hyperdisk-balanced".
- boot
Disk numberSize Gb - Size in GB of the boot disk (default is 100GB).
- boot
Disk stringType - Type of the disk. The default value depends on the machine type. Valid values include: "pd-ssd", "pd-standard", "pd-balanced", and "hyperdisk-balanced".
- boot_
disk_ intsize_ gb - Size in GB of the boot disk (default is 100GB).
- boot_
disk_ strtype - Type of the disk. The default value depends on the machine type. Valid values include: "pd-ssd", "pd-standard", "pd-balanced", and "hyperdisk-balanced".
- boot
Disk NumberSize Gb - Size in GB of the boot disk (default is 100GB).
- boot
Disk StringType - Type of the disk. The default value depends on the machine type. Valid values include: "pd-ssd", "pd-standard", "pd-balanced", and "hyperdisk-balanced".
AiCustomJobJobSpecWorkerPoolSpecLustreMount, AiCustomJobJobSpecWorkerPoolSpecLustreMountArgs
- Filesystem string
- The name of the Lustre filesystem.
- Instance
Ip string - IP address of the Lustre instance.
- Mount
Point string - Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/<mount_point>.
- Volume
Handle string - The unique identifier of the Lustre volume.
- Filesystem string
- The name of the Lustre filesystem.
- Instance
Ip string - IP address of the Lustre instance.
- Mount
Point string - Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/<mount_point>.
- Volume
Handle string - The unique identifier of the Lustre volume.
- filesystem string
- The name of the Lustre filesystem.
- instance_
ip string - IP address of the Lustre instance.
- mount_
point string - Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/<mount_point>.
- volume_
handle string - The unique identifier of the Lustre volume.
- filesystem String
- The name of the Lustre filesystem.
- instance
Ip String - IP address of the Lustre instance.
- mount
Point String - Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/<mount_point>.
- volume
Handle String - The unique identifier of the Lustre volume.
- filesystem string
- The name of the Lustre filesystem.
- instance
Ip string - IP address of the Lustre instance.
- mount
Point string - Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/<mount_point>.
- volume
Handle string - The unique identifier of the Lustre volume.
- filesystem str
- The name of the Lustre filesystem.
- instance_
ip str - IP address of the Lustre instance.
- mount_
point str - Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/<mount_point>.
- volume_
handle str - The unique identifier of the Lustre volume.
- filesystem String
- The name of the Lustre filesystem.
- instance
Ip String - IP address of the Lustre instance.
- mount
Point String - Destination mount path. The Lustre file system will be mounted for the user under /mnt/lustre/<mount_point>.
- volume
Handle String - The unique identifier of the Lustre volume.
AiCustomJobJobSpecWorkerPoolSpecMachineSpec, AiCustomJobJobSpecWorkerPoolSpecMachineSpecArgs
- Accelerator
Count int - The number of accelerators to attach to the machine.
- Accelerator
Type string - The type of accelerator(s) that may be attached to the machine.
- Machine
Type string - The type of the machine.
- Reservation
Affinity AiCustom Job Job Spec Worker Pool Spec Machine Spec Reservation Affinity - Configuration for using robust to failure reservation. Structure is documented below.
- Tpu
Topology string - The topology of the TPUs.
- Accelerator
Count int - The number of accelerators to attach to the machine.
- Accelerator
Type string - The type of accelerator(s) that may be attached to the machine.
- Machine
Type string - The type of the machine.
- Reservation
Affinity AiCustom Job Job Spec Worker Pool Spec Machine Spec Reservation Affinity - Configuration for using robust to failure reservation. Structure is documented below.
- Tpu
Topology string - The topology of the TPUs.
- accelerator_
count number - The number of accelerators to attach to the machine.
- accelerator_
type string - The type of accelerator(s) that may be attached to the machine.
- machine_
type string - The type of the machine.
- reservation_
affinity object - Configuration for using robust to failure reservation. Structure is documented below.
- tpu_
topology string - The topology of the TPUs.
- accelerator
Count Integer - The number of accelerators to attach to the machine.
- accelerator
Type String - The type of accelerator(s) that may be attached to the machine.
- machine
Type String - The type of the machine.
- reservation
Affinity AiCustom Job Job Spec Worker Pool Spec Machine Spec Reservation Affinity - Configuration for using robust to failure reservation. Structure is documented below.
- tpu
Topology String - The topology of the TPUs.
- accelerator
Count number - The number of accelerators to attach to the machine.
- accelerator
Type string - The type of accelerator(s) that may be attached to the machine.
- machine
Type string - The type of the machine.
- reservation
Affinity AiCustom Job Job Spec Worker Pool Spec Machine Spec Reservation Affinity - Configuration for using robust to failure reservation. Structure is documented below.
- tpu
Topology string - The topology of the TPUs.
- accelerator_
count int - The number of accelerators to attach to the machine.
- accelerator_
type str - The type of accelerator(s) that may be attached to the machine.
- machine_
type str - The type of the machine.
- reservation_
affinity AiCustom Job Job Spec Worker Pool Spec Machine Spec Reservation Affinity - Configuration for using robust to failure reservation. Structure is documented below.
- tpu_
topology str - The topology of the TPUs.
- accelerator
Count Number - The number of accelerators to attach to the machine.
- accelerator
Type String - The type of accelerator(s) that may be attached to the machine.
- machine
Type String - The type of the machine.
- reservation
Affinity Property Map - Configuration for using robust to failure reservation. Structure is documented below.
- tpu
Topology String - The topology of the TPUs.
AiCustomJobJobSpecWorkerPoolSpecMachineSpecReservationAffinity, AiCustomJobJobSpecWorkerPoolSpecMachineSpecReservationAffinityArgs
- Reservation
Affinity stringType - Specifies the reservation affinity type. Possible values: "NO_RESERVATION", "ANY_RESERVATION", and "SPECIFIC_RESERVATION"
- Key string
- Corresponds to the label key of a reservation resource.
- Values List<string>
- Corresponds to the label values of a reservation resource.
- Reservation
Affinity stringType - Specifies the reservation affinity type. Possible values: "NO_RESERVATION", "ANY_RESERVATION", and "SPECIFIC_RESERVATION"
- Key string
- Corresponds to the label key of a reservation resource.
- Values []string
- Corresponds to the label values of a reservation resource.
- reservation_
affinity_ stringtype - Specifies the reservation affinity type. Possible values: "NO_RESERVATION", "ANY_RESERVATION", and "SPECIFIC_RESERVATION"
- key string
- Corresponds to the label key of a reservation resource.
- values list(string)
- Corresponds to the label values of a reservation resource.
- reservation
Affinity StringType - Specifies the reservation affinity type. Possible values: "NO_RESERVATION", "ANY_RESERVATION", and "SPECIFIC_RESERVATION"
- key String
- Corresponds to the label key of a reservation resource.
- values List<String>
- Corresponds to the label values of a reservation resource.
- reservation
Affinity stringType - Specifies the reservation affinity type. Possible values: "NO_RESERVATION", "ANY_RESERVATION", and "SPECIFIC_RESERVATION"
- key string
- Corresponds to the label key of a reservation resource.
- values string[]
- Corresponds to the label values of a reservation resource.
- reservation_
affinity_ strtype - Specifies the reservation affinity type. Possible values: "NO_RESERVATION", "ANY_RESERVATION", and "SPECIFIC_RESERVATION"
- key str
- Corresponds to the label key of a reservation resource.
- values Sequence[str]
- Corresponds to the label values of a reservation resource.
- reservation
Affinity StringType - Specifies the reservation affinity type. Possible values: "NO_RESERVATION", "ANY_RESERVATION", and "SPECIFIC_RESERVATION"
- key String
- Corresponds to the label key of a reservation resource.
- values List<String>
- Corresponds to the label values of a reservation resource.
AiCustomJobJobSpecWorkerPoolSpecNfsMount, AiCustomJobJobSpecWorkerPoolSpecNfsMountArgs
- Mount
Point string - Destination mount path. The path must be absolute.
- Path string
- Source path exported from NFS database.
- Server string
- IP address of the NFS server.
- Mount
Point string - Destination mount path. The path must be absolute.
- Path string
- Source path exported from NFS database.
- Server string
- IP address of the NFS server.
- mount_
point string - Destination mount path. The path must be absolute.
- path string
- Source path exported from NFS database.
- server string
- IP address of the NFS server.
- mount
Point String - Destination mount path. The path must be absolute.
- path String
- Source path exported from NFS database.
- server String
- IP address of the NFS server.
- mount
Point string - Destination mount path. The path must be absolute.
- path string
- Source path exported from NFS database.
- server string
- IP address of the NFS server.
- mount_
point str - Destination mount path. The path must be absolute.
- path str
- Source path exported from NFS database.
- server str
- IP address of the NFS server.
- mount
Point String - Destination mount path. The path must be absolute.
- path String
- Source path exported from NFS database.
- server String
- IP address of the NFS server.
AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpec, AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecArgs
- Executor
Image stringUri - The URI of a container image in Artifact Registry that will run the provided Python package.
- Package
Uris List<string> - The Google Cloud Storage location of the Python package files which are the training program and its dependent packages.
- Python
Module string - The Python module name to run after installing the packages.
- Args List<string>
- Command line arguments to be passed to the Python task.
- Envs
List<Ai
Custom Job Job Spec Worker Pool Spec Python Package Spec Env> - Environment variables to be passed to the python module. Maximum limit is 100. Structure is documented below.
- Executor
Image stringUri - The URI of a container image in Artifact Registry that will run the provided Python package.
- Package
Uris []string - The Google Cloud Storage location of the Python package files which are the training program and its dependent packages.
- Python
Module string - The Python module name to run after installing the packages.
- Args []string
- Command line arguments to be passed to the Python task.
- Envs
[]Ai
Custom Job Job Spec Worker Pool Spec Python Package Spec Env - Environment variables to be passed to the python module. Maximum limit is 100. Structure is documented below.
- executor_
image_ stringuri - The URI of a container image in Artifact Registry that will run the provided Python package.
- package_
uris list(string) - The Google Cloud Storage location of the Python package files which are the training program and its dependent packages.
- python_
module string - The Python module name to run after installing the packages.
- args list(string)
- Command line arguments to be passed to the Python task.
- envs list(object)
- Environment variables to be passed to the python module. Maximum limit is 100. Structure is documented below.
- executor
Image StringUri - The URI of a container image in Artifact Registry that will run the provided Python package.
- package
Uris List<String> - The Google Cloud Storage location of the Python package files which are the training program and its dependent packages.
- python
Module String - The Python module name to run after installing the packages.
- args List<String>
- Command line arguments to be passed to the Python task.
- envs
List<Ai
Custom Job Job Spec Worker Pool Spec Python Package Spec Env> - Environment variables to be passed to the python module. Maximum limit is 100. Structure is documented below.
- executor
Image stringUri - The URI of a container image in Artifact Registry that will run the provided Python package.
- package
Uris string[] - The Google Cloud Storage location of the Python package files which are the training program and its dependent packages.
- python
Module string - The Python module name to run after installing the packages.
- args string[]
- Command line arguments to be passed to the Python task.
- envs
Ai
Custom Job Job Spec Worker Pool Spec Python Package Spec Env[] - Environment variables to be passed to the python module. Maximum limit is 100. Structure is documented below.
- executor_
image_ struri - The URI of a container image in Artifact Registry that will run the provided Python package.
- package_
uris Sequence[str] - The Google Cloud Storage location of the Python package files which are the training program and its dependent packages.
- python_
module str - The Python module name to run after installing the packages.
- args Sequence[str]
- Command line arguments to be passed to the Python task.
- envs
Sequence[Ai
Custom Job Job Spec Worker Pool Spec Python Package Spec Env] - Environment variables to be passed to the python module. Maximum limit is 100. Structure is documented below.
- executor
Image StringUri - The URI of a container image in Artifact Registry that will run the provided Python package.
- package
Uris List<String> - The Google Cloud Storage location of the Python package files which are the training program and its dependent packages.
- python
Module String - The Python module name to run after installing the packages.
- args List<String>
- Command line arguments to be passed to the Python task.
- envs List<Property Map>
- Environment variables to be passed to the python module. Maximum limit is 100. Structure is documented below.
AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecEnv, AiCustomJobJobSpecWorkerPoolSpecPythonPackageSpecEnvArgs
Import
CustomJob can be imported using any of these accepted formats:
projects/{{project}}/locations/{{region}}/customJobs/{{name}}{{project}}/{{region}}/{{name}}{{region}}/{{name}}{{name}}
When using the pulumi import command, CustomJob can be imported using one of the formats above. For example:
$ pulumi import gcp:vertex/aiCustomJob:AiCustomJob default projects/{{project}}/locations/{{region}}/customJobs/{{name}}
$ pulumi import gcp:vertex/aiCustomJob:AiCustomJob default {{project}}/{{region}}/{{name}}
$ pulumi import gcp:vertex/aiCustomJob:AiCustomJob default {{region}}/{{name}}
$ pulumi import gcp:vertex/aiCustomJob:AiCustomJob 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