1. Packages
  2. Google Cloud Native
  3. API Docs
  4. batch
  5. batch/v1
  6. getJob

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

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.batch/v1.getJob

Explore with Pulumi AI

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

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Get a Job specified by its resource name.

Using getJob

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getJob(args: GetJobArgs, opts?: InvokeOptions): Promise<GetJobResult>
function getJobOutput(args: GetJobOutputArgs, opts?: InvokeOptions): Output<GetJobResult>
Copy
def get_job(job_id: Optional[str] = None,
            location: Optional[str] = None,
            project: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetJobResult
def get_job_output(job_id: Optional[pulumi.Input[str]] = None,
            location: Optional[pulumi.Input[str]] = None,
            project: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetJobResult]
Copy
func LookupJob(ctx *Context, args *LookupJobArgs, opts ...InvokeOption) (*LookupJobResult, error)
func LookupJobOutput(ctx *Context, args *LookupJobOutputArgs, opts ...InvokeOption) LookupJobResultOutput
Copy

> Note: This function is named LookupJob in the Go SDK.

public static class GetJob 
{
    public static Task<GetJobResult> InvokeAsync(GetJobArgs args, InvokeOptions? opts = null)
    public static Output<GetJobResult> Invoke(GetJobInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetJobResult> getJob(GetJobArgs args, InvokeOptions options)
public static Output<GetJobResult> getJob(GetJobArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:batch/v1:getJob
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

JobId This property is required. string
Location This property is required. string
Project string
JobId This property is required. string
Location This property is required. string
Project string
jobId This property is required. String
location This property is required. String
project String
jobId This property is required. string
location This property is required. string
project string
job_id This property is required. str
location This property is required. str
project str
jobId This property is required. String
location This property is required. String
project String

getJob Result

The following output properties are available:

AllocationPolicy Pulumi.GoogleNative.Batch.V1.Outputs.AllocationPolicyResponse
Compute resource allocation for all TaskGroups in the Job.
CreateTime string
When the Job was created.
Labels Dictionary<string, string>
Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
LogsPolicy Pulumi.GoogleNative.Batch.V1.Outputs.LogsPolicyResponse
Log preservation policy for the Job.
Name string
Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
Notifications List<Pulumi.GoogleNative.Batch.V1.Outputs.JobNotificationResponse>
Notification configurations.
Priority string
Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
Status Pulumi.GoogleNative.Batch.V1.Outputs.JobStatusResponse
Job status. It is read only for users.
TaskGroups List<Pulumi.GoogleNative.Batch.V1.Outputs.TaskGroupResponse>
TaskGroups in the Job. Only one TaskGroup is supported now.
Uid string
A system generated unique ID (in UUID4 format) for the Job.
UpdateTime string
The last time the Job was updated.
AllocationPolicy AllocationPolicyResponse
Compute resource allocation for all TaskGroups in the Job.
CreateTime string
When the Job was created.
Labels map[string]string
Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
LogsPolicy LogsPolicyResponse
Log preservation policy for the Job.
Name string
Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
Notifications []JobNotificationResponse
Notification configurations.
Priority string
Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
Status JobStatusResponse
Job status. It is read only for users.
TaskGroups []TaskGroupResponse
TaskGroups in the Job. Only one TaskGroup is supported now.
Uid string
A system generated unique ID (in UUID4 format) for the Job.
UpdateTime string
The last time the Job was updated.
allocationPolicy AllocationPolicyResponse
Compute resource allocation for all TaskGroups in the Job.
createTime String
When the Job was created.
labels Map<String,String>
Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
logsPolicy LogsPolicyResponse
Log preservation policy for the Job.
name String
Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
notifications List<JobNotificationResponse>
Notification configurations.
priority String
Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
status JobStatusResponse
Job status. It is read only for users.
taskGroups List<TaskGroupResponse>
TaskGroups in the Job. Only one TaskGroup is supported now.
uid String
A system generated unique ID (in UUID4 format) for the Job.
updateTime String
The last time the Job was updated.
allocationPolicy AllocationPolicyResponse
Compute resource allocation for all TaskGroups in the Job.
createTime string
When the Job was created.
labels {[key: string]: string}
Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
logsPolicy LogsPolicyResponse
Log preservation policy for the Job.
name string
Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
notifications JobNotificationResponse[]
Notification configurations.
priority string
Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
status JobStatusResponse
Job status. It is read only for users.
taskGroups TaskGroupResponse[]
TaskGroups in the Job. Only one TaskGroup is supported now.
uid string
A system generated unique ID (in UUID4 format) for the Job.
updateTime string
The last time the Job was updated.
allocation_policy AllocationPolicyResponse
Compute resource allocation for all TaskGroups in the Job.
create_time str
When the Job was created.
labels Mapping[str, str]
Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
logs_policy LogsPolicyResponse
Log preservation policy for the Job.
name str
Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
notifications Sequence[JobNotificationResponse]
Notification configurations.
priority str
Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
status JobStatusResponse
Job status. It is read only for users.
task_groups Sequence[TaskGroupResponse]
TaskGroups in the Job. Only one TaskGroup is supported now.
uid str
A system generated unique ID (in UUID4 format) for the Job.
update_time str
The last time the Job was updated.
allocationPolicy Property Map
Compute resource allocation for all TaskGroups in the Job.
createTime String
When the Job was created.
labels Map<String>
Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
logsPolicy Property Map
Log preservation policy for the Job.
name String
Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
notifications List<Property Map>
Notification configurations.
priority String
Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied.
status Property Map
Job status. It is read only for users.
taskGroups List<Property Map>
TaskGroups in the Job. Only one TaskGroup is supported now.
uid String
A system generated unique ID (in UUID4 format) for the Job.
updateTime String
The last time the Job was updated.

Supporting Types

AcceleratorResponse

Count This property is required. string
The number of accelerators of this type.
DriverVersion This property is required. string
Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. Batch will install the specific accelerator driver if qualified.
InstallGpuDrivers This property is required. bool
Deprecated: please use instances[0].install_gpu_drivers instead.

Deprecated: Deprecated: please use instances[0].install_gpu_drivers instead.

Type This property is required. string
The accelerator type. For example, "nvidia-tesla-t4". See gcloud compute accelerator-types list.
Count This property is required. string
The number of accelerators of this type.
DriverVersion This property is required. string
Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. Batch will install the specific accelerator driver if qualified.
InstallGpuDrivers This property is required. bool
Deprecated: please use instances[0].install_gpu_drivers instead.

Deprecated: Deprecated: please use instances[0].install_gpu_drivers instead.

Type This property is required. string
The accelerator type. For example, "nvidia-tesla-t4". See gcloud compute accelerator-types list.
count This property is required. String
The number of accelerators of this type.
driverVersion This property is required. String
Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. Batch will install the specific accelerator driver if qualified.
installGpuDrivers This property is required. Boolean
Deprecated: please use instances[0].install_gpu_drivers instead.

Deprecated: Deprecated: please use instances[0].install_gpu_drivers instead.

type This property is required. String
The accelerator type. For example, "nvidia-tesla-t4". See gcloud compute accelerator-types list.
count This property is required. string
The number of accelerators of this type.
driverVersion This property is required. string
Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. Batch will install the specific accelerator driver if qualified.
installGpuDrivers This property is required. boolean
Deprecated: please use instances[0].install_gpu_drivers instead.

Deprecated: Deprecated: please use instances[0].install_gpu_drivers instead.

type This property is required. string
The accelerator type. For example, "nvidia-tesla-t4". See gcloud compute accelerator-types list.
count This property is required. str
The number of accelerators of this type.
driver_version This property is required. str
Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. Batch will install the specific accelerator driver if qualified.
install_gpu_drivers This property is required. bool
Deprecated: please use instances[0].install_gpu_drivers instead.

Deprecated: Deprecated: please use instances[0].install_gpu_drivers instead.

type This property is required. str
The accelerator type. For example, "nvidia-tesla-t4". See gcloud compute accelerator-types list.
count This property is required. String
The number of accelerators of this type.
driverVersion This property is required. String
Optional. The NVIDIA GPU driver version that should be installed for this type. You can define the specific driver version such as "470.103.01", following the driver version requirements in https://cloud.google.com/compute/docs/gpus/install-drivers-gpu#minimum-driver. Batch will install the specific accelerator driver if qualified.
installGpuDrivers This property is required. Boolean
Deprecated: please use instances[0].install_gpu_drivers instead.

Deprecated: Deprecated: please use instances[0].install_gpu_drivers instead.

type This property is required. String
The accelerator type. For example, "nvidia-tesla-t4". See gcloud compute accelerator-types list.

ActionConditionResponse

ExitCodes This property is required. List<int>
Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
ExitCodes This property is required. []int
Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
exitCodes This property is required. List<Integer>
Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
exitCodes This property is required. number[]
Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
exit_codes This property is required. Sequence[int]
Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.
exitCodes This property is required. List<Number>
Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed.

AllocationPolicyResponse

Instances This property is required. List<Pulumi.GoogleNative.Batch.V1.Inputs.InstancePolicyOrTemplateResponse>
Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
Labels This property is required. Dictionary<string, string>
Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
Location This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.LocationPolicyResponse
Location where compute resources should be allocated for the Job.
Network This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.NetworkPolicyResponse
The network policy. If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.
Placement This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.PlacementPolicyResponse
The placement policy.
ServiceAccount This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.ServiceAccountResponse
Service account that VMs will run as.
Instances This property is required. []InstancePolicyOrTemplateResponse
Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
Labels This property is required. map[string]string
Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
Location This property is required. LocationPolicyResponse
Location where compute resources should be allocated for the Job.
Network This property is required. NetworkPolicyResponse
The network policy. If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.
Placement This property is required. PlacementPolicyResponse
The placement policy.
ServiceAccount This property is required. ServiceAccountResponse
Service account that VMs will run as.
instances This property is required. List<InstancePolicyOrTemplateResponse>
Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
labels This property is required. Map<String,String>
Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
location This property is required. LocationPolicyResponse
Location where compute resources should be allocated for the Job.
network This property is required. NetworkPolicyResponse
The network policy. If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.
placement This property is required. PlacementPolicyResponse
The placement policy.
serviceAccount This property is required. ServiceAccountResponse
Service account that VMs will run as.
instances This property is required. InstancePolicyOrTemplateResponse[]
Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
labels This property is required. {[key: string]: string}
Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
location This property is required. LocationPolicyResponse
Location where compute resources should be allocated for the Job.
network This property is required. NetworkPolicyResponse
The network policy. If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.
placement This property is required. PlacementPolicyResponse
The placement policy.
serviceAccount This property is required. ServiceAccountResponse
Service account that VMs will run as.
instances This property is required. Sequence[InstancePolicyOrTemplateResponse]
Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
labels This property is required. Mapping[str, str]
Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
location This property is required. LocationPolicyResponse
Location where compute resources should be allocated for the Job.
network This property is required. NetworkPolicyResponse
The network policy. If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.
placement This property is required. PlacementPolicyResponse
The placement policy.
service_account This property is required. ServiceAccountResponse
Service account that VMs will run as.
instances This property is required. List<Property Map>
Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now.
labels This property is required. Map<String>
Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.
location This property is required. Property Map
Location where compute resources should be allocated for the Job.
network This property is required. Property Map
The network policy. If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field.
placement This property is required. Property Map
The placement policy.
serviceAccount This property is required. Property Map
Service account that VMs will run as.

AttachedDiskResponse

DeviceName This property is required. string
Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the disk, and it should match the device_name field in volumes.
ExistingDisk This property is required. string
Name of an existing PD.
NewDisk This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.DiskResponse
DeviceName This property is required. string
Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the disk, and it should match the device_name field in volumes.
ExistingDisk This property is required. string
Name of an existing PD.
NewDisk This property is required. DiskResponse
deviceName This property is required. String
Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the disk, and it should match the device_name field in volumes.
existingDisk This property is required. String
Name of an existing PD.
newDisk This property is required. DiskResponse
deviceName This property is required. string
Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the disk, and it should match the device_name field in volumes.
existingDisk This property is required. string
Name of an existing PD.
newDisk This property is required. DiskResponse
device_name This property is required. str
Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the disk, and it should match the device_name field in volumes.
existing_disk This property is required. str
Name of an existing PD.
new_disk This property is required. DiskResponse
deviceName This property is required. String
Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the disk, and it should match the device_name field in volumes.
existingDisk This property is required. String
Name of an existing PD.
newDisk This property is required. Property Map

BarrierResponse

Name This property is required. string
Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
Name This property is required. string
Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
name This property is required. String
Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
name This property is required. string
Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
name This property is required. str
Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.
name This property is required. String
Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier.

ComputeResourceResponse

BootDiskMib This property is required. string
Extra boot disk size in MiB for each task.
CpuMilli This property is required. string
The milliCPU count. cpuMilli defines the amount of CPU resources per task in milliCPU units. For example, 1000 corresponds to 1 vCPU per task. If undefined, the default value is 2000. If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the n2-standard-2 machine type, which has 2 vCPUs each, you are recommended to set cpuMilli no more than 2000, or you are recommended to run two tasks on the same VM if you set cpuMilli to 1000 or less.
MemoryMib This property is required. string
Memory in MiB. memoryMib defines the amount of memory per task in MiB units. If undefined, the default value is 2000. If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the n2-standard-2 machine type, which has 8 GiB each, you are recommended to set memoryMib to no more than 8192, or you are recommended to run two tasks on the same VM if you set memoryMib to 4096 or less.
BootDiskMib This property is required. string
Extra boot disk size in MiB for each task.
CpuMilli This property is required. string
The milliCPU count. cpuMilli defines the amount of CPU resources per task in milliCPU units. For example, 1000 corresponds to 1 vCPU per task. If undefined, the default value is 2000. If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the n2-standard-2 machine type, which has 2 vCPUs each, you are recommended to set cpuMilli no more than 2000, or you are recommended to run two tasks on the same VM if you set cpuMilli to 1000 or less.
MemoryMib This property is required. string
Memory in MiB. memoryMib defines the amount of memory per task in MiB units. If undefined, the default value is 2000. If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the n2-standard-2 machine type, which has 8 GiB each, you are recommended to set memoryMib to no more than 8192, or you are recommended to run two tasks on the same VM if you set memoryMib to 4096 or less.
bootDiskMib This property is required. String
Extra boot disk size in MiB for each task.
cpuMilli This property is required. String
The milliCPU count. cpuMilli defines the amount of CPU resources per task in milliCPU units. For example, 1000 corresponds to 1 vCPU per task. If undefined, the default value is 2000. If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the n2-standard-2 machine type, which has 2 vCPUs each, you are recommended to set cpuMilli no more than 2000, or you are recommended to run two tasks on the same VM if you set cpuMilli to 1000 or less.
memoryMib This property is required. String
Memory in MiB. memoryMib defines the amount of memory per task in MiB units. If undefined, the default value is 2000. If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the n2-standard-2 machine type, which has 8 GiB each, you are recommended to set memoryMib to no more than 8192, or you are recommended to run two tasks on the same VM if you set memoryMib to 4096 or less.
bootDiskMib This property is required. string
Extra boot disk size in MiB for each task.
cpuMilli This property is required. string
The milliCPU count. cpuMilli defines the amount of CPU resources per task in milliCPU units. For example, 1000 corresponds to 1 vCPU per task. If undefined, the default value is 2000. If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the n2-standard-2 machine type, which has 2 vCPUs each, you are recommended to set cpuMilli no more than 2000, or you are recommended to run two tasks on the same VM if you set cpuMilli to 1000 or less.
memoryMib This property is required. string
Memory in MiB. memoryMib defines the amount of memory per task in MiB units. If undefined, the default value is 2000. If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the n2-standard-2 machine type, which has 8 GiB each, you are recommended to set memoryMib to no more than 8192, or you are recommended to run two tasks on the same VM if you set memoryMib to 4096 or less.
boot_disk_mib This property is required. str
Extra boot disk size in MiB for each task.
cpu_milli This property is required. str
The milliCPU count. cpuMilli defines the amount of CPU resources per task in milliCPU units. For example, 1000 corresponds to 1 vCPU per task. If undefined, the default value is 2000. If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the n2-standard-2 machine type, which has 2 vCPUs each, you are recommended to set cpuMilli no more than 2000, or you are recommended to run two tasks on the same VM if you set cpuMilli to 1000 or less.
memory_mib This property is required. str
Memory in MiB. memoryMib defines the amount of memory per task in MiB units. If undefined, the default value is 2000. If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the n2-standard-2 machine type, which has 8 GiB each, you are recommended to set memoryMib to no more than 8192, or you are recommended to run two tasks on the same VM if you set memoryMib to 4096 or less.
bootDiskMib This property is required. String
Extra boot disk size in MiB for each task.
cpuMilli This property is required. String
The milliCPU count. cpuMilli defines the amount of CPU resources per task in milliCPU units. For example, 1000 corresponds to 1 vCPU per task. If undefined, the default value is 2000. If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the CPU resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the n2-standard-2 machine type, which has 2 vCPUs each, you are recommended to set cpuMilli no more than 2000, or you are recommended to run two tasks on the same VM if you set cpuMilli to 1000 or less.
memoryMib This property is required. String
Memory in MiB. memoryMib defines the amount of memory per task in MiB units. If undefined, the default value is 2000. If you also define the VM's machine type using the machineType in InstancePolicy field or inside the instanceTemplate in the InstancePolicyOrTemplate field, make sure the memory resources for both fields are compatible with each other and with how many tasks you want to allow to run on the same VM at the same time. For example, if you specify the n2-standard-2 machine type, which has 8 GiB each, you are recommended to set memoryMib to no more than 8192, or you are recommended to run two tasks on the same VM if you set memoryMib to 4096 or less.

ContainerResponse

BlockExternalNetwork This property is required. bool
If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the container.options field.
Commands This property is required. List<string>
Overrides the CMD specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.
Entrypoint This property is required. string
Overrides the ENTRYPOINT specified in the container.
ImageUri This property is required. string
The URI to pull the container image from.
Options This property is required. string
Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
Password This property is required. string
Optional password for logging in to a docker registry. If password matches projects/*/secrets/*/versions/* then Batch will read the password from the Secret Manager;
Username This property is required. string
Optional username for logging in to a docker registry. If username matches projects/*/secrets/*/versions/* then Batch will read the username from the Secret Manager.
Volumes This property is required. List<string>
Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro If the TaskSpec.Volumes field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified in TaskSpec.Volumes. If you need different mount settings, you can explicitly configure them in this field.
BlockExternalNetwork This property is required. bool
If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the container.options field.
Commands This property is required. []string
Overrides the CMD specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.
Entrypoint This property is required. string
Overrides the ENTRYPOINT specified in the container.
ImageUri This property is required. string
The URI to pull the container image from.
Options This property is required. string
Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
Password This property is required. string
Optional password for logging in to a docker registry. If password matches projects/*/secrets/*/versions/* then Batch will read the password from the Secret Manager;
Username This property is required. string
Optional username for logging in to a docker registry. If username matches projects/*/secrets/*/versions/* then Batch will read the username from the Secret Manager.
Volumes This property is required. []string
Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro If the TaskSpec.Volumes field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified in TaskSpec.Volumes. If you need different mount settings, you can explicitly configure them in this field.
blockExternalNetwork This property is required. Boolean
If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the container.options field.
commands This property is required. List<String>
Overrides the CMD specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.
entrypoint This property is required. String
Overrides the ENTRYPOINT specified in the container.
imageUri This property is required. String
The URI to pull the container image from.
options This property is required. String
Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
password This property is required. String
Optional password for logging in to a docker registry. If password matches projects/*/secrets/*/versions/* then Batch will read the password from the Secret Manager;
username This property is required. String
Optional username for logging in to a docker registry. If username matches projects/*/secrets/*/versions/* then Batch will read the username from the Secret Manager.
volumes This property is required. List<String>
Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro If the TaskSpec.Volumes field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified in TaskSpec.Volumes. If you need different mount settings, you can explicitly configure them in this field.
blockExternalNetwork This property is required. boolean
If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the container.options field.
commands This property is required. string[]
Overrides the CMD specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.
entrypoint This property is required. string
Overrides the ENTRYPOINT specified in the container.
imageUri This property is required. string
The URI to pull the container image from.
options This property is required. string
Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
password This property is required. string
Optional password for logging in to a docker registry. If password matches projects/*/secrets/*/versions/* then Batch will read the password from the Secret Manager;
username This property is required. string
Optional username for logging in to a docker registry. If username matches projects/*/secrets/*/versions/* then Batch will read the username from the Secret Manager.
volumes This property is required. string[]
Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro If the TaskSpec.Volumes field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified in TaskSpec.Volumes. If you need different mount settings, you can explicitly configure them in this field.
block_external_network This property is required. bool
If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the container.options field.
commands This property is required. Sequence[str]
Overrides the CMD specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.
entrypoint This property is required. str
Overrides the ENTRYPOINT specified in the container.
image_uri This property is required. str
The URI to pull the container image from.
options This property is required. str
Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
password This property is required. str
Optional password for logging in to a docker registry. If password matches projects/*/secrets/*/versions/* then Batch will read the password from the Secret Manager;
username This property is required. str
Optional username for logging in to a docker registry. If username matches projects/*/secrets/*/versions/* then Batch will read the username from the Secret Manager.
volumes This property is required. Sequence[str]
Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro If the TaskSpec.Volumes field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified in TaskSpec.Volumes. If you need different mount settings, you can explicitly configure them in this field.
blockExternalNetwork This property is required. Boolean
If set to true, external network access to and from container will be blocked, containers that are with block_external_network as true can still communicate with each other, network cannot be specified in the container.options field.
commands This property is required. List<String>
Overrides the CMD specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.
entrypoint This property is required. String
Overrides the ENTRYPOINT specified in the container.
imageUri This property is required. String
The URI to pull the container image from.
options This property is required. String
Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host".
password This property is required. String
Optional password for logging in to a docker registry. If password matches projects/*/secrets/*/versions/* then Batch will read the password from the Secret Manager;
username This property is required. String
Optional username for logging in to a docker registry. If username matches projects/*/secrets/*/versions/* then Batch will read the username from the Secret Manager.
volumes This property is required. List<String>
Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro If the TaskSpec.Volumes field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified in TaskSpec.Volumes. If you need different mount settings, you can explicitly configure them in this field.

DiskResponse

DiskInterface This property is required. string
Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.
Image This property is required. string
URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs: * Specify the image by its family name: projects/{project}/global/images/family/{image_family} * Specify the image version: projects/{project}/global/images/{image_version} You can also use Batch customized image in short names. The following image values are supported for a boot disk: * batch-debian: use Batch Debian images. * batch-centos: use Batch CentOS images. * batch-cos: use Batch Container-Optimized images. * batch-hpc-centos: use Batch HPC CentOS images. * batch-hpc-rocky: use Batch HPC Rocky Linux images.
SizeGb This property is required. string
Disk size in GB. Non-Boot Disk: If the type specifies a persistent disk, this field is ignored if data_source is set as image or snapshot. If the type specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB. Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and the boot_disk_mib field in task spec's compute_resource are defined, Batch will only honor this field. Also, this field should be no smaller than the source disk's size when the data_source is set as snapshot or image. For example, if you set an image as the data_source field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB.
Snapshot This property is required. string
Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
Type This property is required. string
Disk type as shown in gcloud compute disk-types list. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".
DiskInterface This property is required. string
Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.
Image This property is required. string
URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs: * Specify the image by its family name: projects/{project}/global/images/family/{image_family} * Specify the image version: projects/{project}/global/images/{image_version} You can also use Batch customized image in short names. The following image values are supported for a boot disk: * batch-debian: use Batch Debian images. * batch-centos: use Batch CentOS images. * batch-cos: use Batch Container-Optimized images. * batch-hpc-centos: use Batch HPC CentOS images. * batch-hpc-rocky: use Batch HPC Rocky Linux images.
SizeGb This property is required. string
Disk size in GB. Non-Boot Disk: If the type specifies a persistent disk, this field is ignored if data_source is set as image or snapshot. If the type specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB. Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and the boot_disk_mib field in task spec's compute_resource are defined, Batch will only honor this field. Also, this field should be no smaller than the source disk's size when the data_source is set as snapshot or image. For example, if you set an image as the data_source field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB.
Snapshot This property is required. string
Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
Type This property is required. string
Disk type as shown in gcloud compute disk-types list. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".
diskInterface This property is required. String
Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.
image This property is required. String
URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs: * Specify the image by its family name: projects/{project}/global/images/family/{image_family} * Specify the image version: projects/{project}/global/images/{image_version} You can also use Batch customized image in short names. The following image values are supported for a boot disk: * batch-debian: use Batch Debian images. * batch-centos: use Batch CentOS images. * batch-cos: use Batch Container-Optimized images. * batch-hpc-centos: use Batch HPC CentOS images. * batch-hpc-rocky: use Batch HPC Rocky Linux images.
sizeGb This property is required. String
Disk size in GB. Non-Boot Disk: If the type specifies a persistent disk, this field is ignored if data_source is set as image or snapshot. If the type specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB. Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and the boot_disk_mib field in task spec's compute_resource are defined, Batch will only honor this field. Also, this field should be no smaller than the source disk's size when the data_source is set as snapshot or image. For example, if you set an image as the data_source field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB.
snapshot This property is required. String
Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
type This property is required. String
Disk type as shown in gcloud compute disk-types list. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".
diskInterface This property is required. string
Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.
image This property is required. string
URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs: * Specify the image by its family name: projects/{project}/global/images/family/{image_family} * Specify the image version: projects/{project}/global/images/{image_version} You can also use Batch customized image in short names. The following image values are supported for a boot disk: * batch-debian: use Batch Debian images. * batch-centos: use Batch CentOS images. * batch-cos: use Batch Container-Optimized images. * batch-hpc-centos: use Batch HPC CentOS images. * batch-hpc-rocky: use Batch HPC Rocky Linux images.
sizeGb This property is required. string
Disk size in GB. Non-Boot Disk: If the type specifies a persistent disk, this field is ignored if data_source is set as image or snapshot. If the type specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB. Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and the boot_disk_mib field in task spec's compute_resource are defined, Batch will only honor this field. Also, this field should be no smaller than the source disk's size when the data_source is set as snapshot or image. For example, if you set an image as the data_source field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB.
snapshot This property is required. string
Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
type This property is required. string
Disk type as shown in gcloud compute disk-types list. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".
disk_interface This property is required. str
Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.
image This property is required. str
URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs: * Specify the image by its family name: projects/{project}/global/images/family/{image_family} * Specify the image version: projects/{project}/global/images/{image_version} You can also use Batch customized image in short names. The following image values are supported for a boot disk: * batch-debian: use Batch Debian images. * batch-centos: use Batch CentOS images. * batch-cos: use Batch Container-Optimized images. * batch-hpc-centos: use Batch HPC CentOS images. * batch-hpc-rocky: use Batch HPC Rocky Linux images.
size_gb This property is required. str
Disk size in GB. Non-Boot Disk: If the type specifies a persistent disk, this field is ignored if data_source is set as image or snapshot. If the type specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB. Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and the boot_disk_mib field in task spec's compute_resource are defined, Batch will only honor this field. Also, this field should be no smaller than the source disk's size when the data_source is set as snapshot or image. For example, if you set an image as the data_source field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB.
snapshot This property is required. str
Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
type This property is required. str
Disk type as shown in gcloud compute disk-types list. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".
diskInterface This property is required. String
Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. This field is ignored for persistent disks as the interface is chosen automatically. See https://cloud.google.com/compute/docs/disks/persistent-disks#choose_an_interface.
image This property is required. String
URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs: * Specify the image by its family name: projects/{project}/global/images/family/{image_family} * Specify the image version: projects/{project}/global/images/{image_version} You can also use Batch customized image in short names. The following image values are supported for a boot disk: * batch-debian: use Batch Debian images. * batch-centos: use Batch CentOS images. * batch-cos: use Batch Container-Optimized images. * batch-hpc-centos: use Batch HPC CentOS images. * batch-hpc-rocky: use Batch HPC Rocky Linux images.
sizeGb This property is required. String
Disk size in GB. Non-Boot Disk: If the type specifies a persistent disk, this field is ignored if data_source is set as image or snapshot. If the type specifies a local SSD, this field should be a multiple of 375 GB, otherwise, the final size will be the next greater multiple of 375 GB. Boot Disk: Batch will calculate the boot disk size based on source image and task requirements if you do not speicify the size. If both this field and the boot_disk_mib field in task spec's compute_resource are defined, Batch will only honor this field. Also, this field should be no smaller than the source disk's size when the data_source is set as snapshot or image. For example, if you set an image as the data_source field and the image's default disk size 30 GB, you can only use this field to make the disk larger or equal to 30 GB.
snapshot This property is required. String
Name of a snapshot used as the data source. Snapshot is not supported as boot disk now.
type This property is required. String
Disk type as shown in gcloud compute disk-types list. For example, local SSD uses type "local-ssd". Persistent disks and boot disks use "pd-balanced", "pd-extreme", "pd-ssd" or "pd-standard".

EnvironmentResponse

EncryptedVariables This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.KMSEnvMapResponse
An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
SecretVariables This property is required. Dictionary<string, string>
A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
Variables This property is required. Dictionary<string, string>
A map of environment variable names to values.
EncryptedVariables This property is required. KMSEnvMapResponse
An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
SecretVariables This property is required. map[string]string
A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
Variables This property is required. map[string]string
A map of environment variable names to values.
encryptedVariables This property is required. KMSEnvMapResponse
An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
secretVariables This property is required. Map<String,String>
A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
variables This property is required. Map<String,String>
A map of environment variable names to values.
encryptedVariables This property is required. KMSEnvMapResponse
An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
secretVariables This property is required. {[key: string]: string}
A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
variables This property is required. {[key: string]: string}
A map of environment variable names to values.
encrypted_variables This property is required. KMSEnvMapResponse
An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
secret_variables This property is required. Mapping[str, str]
A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
variables This property is required. Mapping[str, str]
A map of environment variable names to values.
encryptedVariables This property is required. Property Map
An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values.
secretVariables This property is required. Map<String>
A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable.
variables This property is required. Map<String>
A map of environment variable names to values.

GCSResponse

RemotePath This property is required. string
Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
RemotePath This property is required. string
Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
remotePath This property is required. String
Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
remotePath This property is required. string
Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
remote_path This property is required. str
Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/
remotePath This property is required. String
Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/

InstancePolicyOrTemplateResponse

InstallGpuDrivers This property is required. bool
Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.
InstanceTemplate This property is required. string
Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
Policy This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.InstancePolicyResponse
InstancePolicy.
InstallGpuDrivers This property is required. bool
Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.
InstanceTemplate This property is required. string
Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
Policy This property is required. InstancePolicyResponse
InstancePolicy.
installGpuDrivers This property is required. Boolean
Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.
instanceTemplate This property is required. String
Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
policy This property is required. InstancePolicyResponse
InstancePolicy.
installGpuDrivers This property is required. boolean
Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.
instanceTemplate This property is required. string
Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
policy This property is required. InstancePolicyResponse
InstancePolicy.
install_gpu_drivers This property is required. bool
Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.
instance_template This property is required. str
Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
policy This property is required. InstancePolicyResponse
InstancePolicy.
installGpuDrivers This property is required. Boolean
Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their behalf. Default is false. For Container-Optimized Image cases, Batch will install the accelerator driver following milestones of https://cloud.google.com/container-optimized-os/docs/release-notes. For non Container-Optimized Image cases, following https://github.com/GoogleCloudPlatform/compute-gpu-installation/blob/main/linux/install_gpu_driver.py.
instanceTemplate This property is required. String
Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.
policy This property is required. Property Map
InstancePolicy.

InstancePolicyResponse

Accelerators This property is required. List<Pulumi.GoogleNative.Batch.V1.Inputs.AcceleratorResponse>
The accelerators attached to each VM instance.
BootDisk This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.DiskResponse
Boot disk to be created and attached to each VM by this InstancePolicy. Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image.
Disks This property is required. List<Pulumi.GoogleNative.Batch.V1.Inputs.AttachedDiskResponse>
Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. A non-boot disk is a disk that can be of a device with a file system or a raw storage drive that is not ready for data storage and accessing.
MachineType This property is required. string
The Compute Engine machine type.
MinCpuPlatform This property is required. string
The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
ProvisioningModel This property is required. string
The provisioning model.
Reservation This property is required. string
Optional. If specified, VMs will consume only the specified reservation. If not specified (default), VMs will consume any applicable reservation.
Accelerators This property is required. []AcceleratorResponse
The accelerators attached to each VM instance.
BootDisk This property is required. DiskResponse
Boot disk to be created and attached to each VM by this InstancePolicy. Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image.
Disks This property is required. []AttachedDiskResponse
Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. A non-boot disk is a disk that can be of a device with a file system or a raw storage drive that is not ready for data storage and accessing.
MachineType This property is required. string
The Compute Engine machine type.
MinCpuPlatform This property is required. string
The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
ProvisioningModel This property is required. string
The provisioning model.
Reservation This property is required. string
Optional. If specified, VMs will consume only the specified reservation. If not specified (default), VMs will consume any applicable reservation.
accelerators This property is required. List<AcceleratorResponse>
The accelerators attached to each VM instance.
bootDisk This property is required. DiskResponse
Boot disk to be created and attached to each VM by this InstancePolicy. Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image.
disks This property is required. List<AttachedDiskResponse>
Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. A non-boot disk is a disk that can be of a device with a file system or a raw storage drive that is not ready for data storage and accessing.
machineType This property is required. String
The Compute Engine machine type.
minCpuPlatform This property is required. String
The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
provisioningModel This property is required. String
The provisioning model.
reservation This property is required. String
Optional. If specified, VMs will consume only the specified reservation. If not specified (default), VMs will consume any applicable reservation.
accelerators This property is required. AcceleratorResponse[]
The accelerators attached to each VM instance.
bootDisk This property is required. DiskResponse
Boot disk to be created and attached to each VM by this InstancePolicy. Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image.
disks This property is required. AttachedDiskResponse[]
Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. A non-boot disk is a disk that can be of a device with a file system or a raw storage drive that is not ready for data storage and accessing.
machineType This property is required. string
The Compute Engine machine type.
minCpuPlatform This property is required. string
The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
provisioningModel This property is required. string
The provisioning model.
reservation This property is required. string
Optional. If specified, VMs will consume only the specified reservation. If not specified (default), VMs will consume any applicable reservation.
accelerators This property is required. Sequence[AcceleratorResponse]
The accelerators attached to each VM instance.
boot_disk This property is required. DiskResponse
Boot disk to be created and attached to each VM by this InstancePolicy. Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image.
disks This property is required. Sequence[AttachedDiskResponse]
Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. A non-boot disk is a disk that can be of a device with a file system or a raw storage drive that is not ready for data storage and accessing.
machine_type This property is required. str
The Compute Engine machine type.
min_cpu_platform This property is required. str
The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
provisioning_model This property is required. str
The provisioning model.
reservation This property is required. str
Optional. If specified, VMs will consume only the specified reservation. If not specified (default), VMs will consume any applicable reservation.
accelerators This property is required. List<Property Map>
The accelerators attached to each VM instance.
bootDisk This property is required. Property Map
Boot disk to be created and attached to each VM by this InstancePolicy. Boot disk will be deleted when the VM is deleted. Batch API now only supports booting from image.
disks This property is required. List<Property Map>
Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. A non-boot disk is a disk that can be of a device with a file system or a raw storage drive that is not ready for data storage and accessing.
machineType This property is required. String
The Compute Engine machine type.
minCpuPlatform This property is required. String
The minimum CPU platform. See https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
provisioningModel This property is required. String
The provisioning model.
reservation This property is required. String
Optional. If specified, VMs will consume only the specified reservation. If not specified (default), VMs will consume any applicable reservation.

JobNotificationResponse

Message This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.MessageResponse
The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
PubsubTopic This property is required. string
The Pub/Sub topic where notifications like the job state changes will be published. The topic must exist in the same project as the job and billings will be charged to this project. If not specified, no Pub/Sub messages will be sent. Topic format: projects/{project}/topics/{topic}.
Message This property is required. MessageResponse
The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
PubsubTopic This property is required. string
The Pub/Sub topic where notifications like the job state changes will be published. The topic must exist in the same project as the job and billings will be charged to this project. If not specified, no Pub/Sub messages will be sent. Topic format: projects/{project}/topics/{topic}.
message This property is required. MessageResponse
The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
pubsubTopic This property is required. String
The Pub/Sub topic where notifications like the job state changes will be published. The topic must exist in the same project as the job and billings will be charged to this project. If not specified, no Pub/Sub messages will be sent. Topic format: projects/{project}/topics/{topic}.
message This property is required. MessageResponse
The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
pubsubTopic This property is required. string
The Pub/Sub topic where notifications like the job state changes will be published. The topic must exist in the same project as the job and billings will be charged to this project. If not specified, no Pub/Sub messages will be sent. Topic format: projects/{project}/topics/{topic}.
message This property is required. MessageResponse
The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
pubsub_topic This property is required. str
The Pub/Sub topic where notifications like the job state changes will be published. The topic must exist in the same project as the job and billings will be charged to this project. If not specified, no Pub/Sub messages will be sent. Topic format: projects/{project}/topics/{topic}.
message This property is required. Property Map
The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent.
pubsubTopic This property is required. String
The Pub/Sub topic where notifications like the job state changes will be published. The topic must exist in the same project as the job and billings will be charged to this project. If not specified, no Pub/Sub messages will be sent. Topic format: projects/{project}/topics/{topic}.

JobStatusResponse

RunDuration This property is required. string
The duration of time that the Job spent in status RUNNING.
State This property is required. string
Job state
StatusEvents This property is required. List<Pulumi.GoogleNative.Batch.V1.Inputs.StatusEventResponse>
Job status events
TaskGroups This property is required. Dictionary<string, string>
Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
RunDuration This property is required. string
The duration of time that the Job spent in status RUNNING.
State This property is required. string
Job state
StatusEvents This property is required. []StatusEventResponse
Job status events
TaskGroups This property is required. map[string]string
Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
runDuration This property is required. String
The duration of time that the Job spent in status RUNNING.
state This property is required. String
Job state
statusEvents This property is required. List<StatusEventResponse>
Job status events
taskGroups This property is required. Map<String,String>
Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
runDuration This property is required. string
The duration of time that the Job spent in status RUNNING.
state This property is required. string
Job state
statusEvents This property is required. StatusEventResponse[]
Job status events
taskGroups This property is required. {[key: string]: string}
Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
run_duration This property is required. str
The duration of time that the Job spent in status RUNNING.
state This property is required. str
Job state
status_events This property is required. Sequence[StatusEventResponse]
Job status events
task_groups This property is required. Mapping[str, str]
Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.
runDuration This property is required. String
The duration of time that the Job spent in status RUNNING.
state This property is required. String
Job state
statusEvents This property is required. List<Property Map>
Job status events
taskGroups This property is required. Map<String>
Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID.

KMSEnvMapResponse

CipherText This property is required. string
The value of the cipherText response from the encrypt method.
KeyName This property is required. string
The name of the KMS key that will be used to decrypt the cipher text.
CipherText This property is required. string
The value of the cipherText response from the encrypt method.
KeyName This property is required. string
The name of the KMS key that will be used to decrypt the cipher text.
cipherText This property is required. String
The value of the cipherText response from the encrypt method.
keyName This property is required. String
The name of the KMS key that will be used to decrypt the cipher text.
cipherText This property is required. string
The value of the cipherText response from the encrypt method.
keyName This property is required. string
The name of the KMS key that will be used to decrypt the cipher text.
cipher_text This property is required. str
The value of the cipherText response from the encrypt method.
key_name This property is required. str
The name of the KMS key that will be used to decrypt the cipher text.
cipherText This property is required. String
The value of the cipherText response from the encrypt method.
keyName This property is required. String
The name of the KMS key that will be used to decrypt the cipher text.

LifecyclePolicyResponse

Action This property is required. string
Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found.
ActionCondition This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.ActionConditionResponse
Conditions that decide why a task failure is dealt with a specific action.
Action This property is required. string
Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found.
ActionCondition This property is required. ActionConditionResponse
Conditions that decide why a task failure is dealt with a specific action.
action This property is required. String
Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found.
actionCondition This property is required. ActionConditionResponse
Conditions that decide why a task failure is dealt with a specific action.
action This property is required. string
Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found.
actionCondition This property is required. ActionConditionResponse
Conditions that decide why a task failure is dealt with a specific action.
action This property is required. str
Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found.
action_condition This property is required. ActionConditionResponse
Conditions that decide why a task failure is dealt with a specific action.
action This property is required. String
Action to execute when ActionCondition is true. When RETRY_TASK is specified, we will retry failed tasks if we notice any exit code match and fail tasks if no match is found. Likewise, when FAIL_TASK is specified, we will fail tasks if we notice any exit code match and retry tasks if no match is found.
actionCondition This property is required. Property Map
Conditions that decide why a task failure is dealt with a specific action.

LocationPolicyResponse

AllowedLocations This property is required. List<string>
A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
AllowedLocations This property is required. []string
A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
allowedLocations This property is required. List<String>
A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
allowedLocations This property is required. string[]
A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
allowed_locations This property is required. Sequence[str]
A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
allowedLocations This property is required. List<String>
A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"] contains 2 regions "us-central1" and "us-west1". An error is expected in this case.

LogsPolicyResponse

CloudLoggingOption This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.CloudLoggingOptionResponse
Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING.
Destination This property is required. string
Where logs should be saved.
LogsPath This property is required. string
The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.
CloudLoggingOption This property is required. CloudLoggingOptionResponse
Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING.
Destination This property is required. string
Where logs should be saved.
LogsPath This property is required. string
The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.
cloudLoggingOption This property is required. CloudLoggingOptionResponse
Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING.
destination This property is required. String
Where logs should be saved.
logsPath This property is required. String
The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.
cloudLoggingOption This property is required. CloudLoggingOptionResponse
Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING.
destination This property is required. string
Where logs should be saved.
logsPath This property is required. string
The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.
cloud_logging_option This property is required. CloudLoggingOptionResponse
Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING.
destination This property is required. str
Where logs should be saved.
logs_path This property is required. str
The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.
cloudLoggingOption This property is required. Property Map
Optional. Additional settings for Cloud Logging. It will only take effect when the destination of LogsPolicy is set to CLOUD_LOGGING.
destination This property is required. String
Where logs should be saved.
logsPath This property is required. String
The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path.

MessageResponse

NewJobState This property is required. string
The new job state.
NewTaskState This property is required. string
The new task state.
Type This property is required. string
The message type.
NewJobState This property is required. string
The new job state.
NewTaskState This property is required. string
The new task state.
Type This property is required. string
The message type.
newJobState This property is required. String
The new job state.
newTaskState This property is required. String
The new task state.
type This property is required. String
The message type.
newJobState This property is required. string
The new job state.
newTaskState This property is required. string
The new task state.
type This property is required. string
The message type.
new_job_state This property is required. str
The new job state.
new_task_state This property is required. str
The new task state.
type This property is required. str
The message type.
newJobState This property is required. String
The new job state.
newTaskState This property is required. String
The new task state.
type This property is required. String
The message type.

NFSResponse

RemotePath This property is required. string
Remote source path exported from the NFS, e.g., "/share".
Server This property is required. string
The IP address of the NFS.
RemotePath This property is required. string
Remote source path exported from the NFS, e.g., "/share".
Server This property is required. string
The IP address of the NFS.
remotePath This property is required. String
Remote source path exported from the NFS, e.g., "/share".
server This property is required. String
The IP address of the NFS.
remotePath This property is required. string
Remote source path exported from the NFS, e.g., "/share".
server This property is required. string
The IP address of the NFS.
remote_path This property is required. str
Remote source path exported from the NFS, e.g., "/share".
server This property is required. str
The IP address of the NFS.
remotePath This property is required. String
Remote source path exported from the NFS, e.g., "/share".
server This property is required. String
The IP address of the NFS.

NetworkInterfaceResponse

Network This property is required. string
The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network}
NoExternalIpAddress This property is required. bool
Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
Subnetwork This property is required. string
The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} * projects/{project}/regions/{region}/subnetworks/{subnetwork} * regions/{region}/subnetworks/{subnetwork}
Network This property is required. string
The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network}
NoExternalIpAddress This property is required. bool
Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
Subnetwork This property is required. string
The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} * projects/{project}/regions/{region}/subnetworks/{subnetwork} * regions/{region}/subnetworks/{subnetwork}
network This property is required. String
The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network}
noExternalIpAddress This property is required. Boolean
Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
subnetwork This property is required. String
The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} * projects/{project}/regions/{region}/subnetworks/{subnetwork} * regions/{region}/subnetworks/{subnetwork}
network This property is required. string
The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network}
noExternalIpAddress This property is required. boolean
Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
subnetwork This property is required. string
The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} * projects/{project}/regions/{region}/subnetworks/{subnetwork} * regions/{region}/subnetworks/{subnetwork}
network This property is required. str
The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network}
no_external_ip_address This property is required. bool
Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
subnetwork This property is required. str
The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} * projects/{project}/regions/{region}/subnetworks/{subnetwork} * regions/{region}/subnetworks/{subnetwork}
network This property is required. String
The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} * projects/{project}/global/networks/{network} * global/networks/{network}
noExternalIpAddress This property is required. Boolean
Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
subnetwork This property is required. String
The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: * https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} * projects/{project}/regions/{region}/subnetworks/{subnetwork} * regions/{region}/subnetworks/{subnetwork}

NetworkPolicyResponse

NetworkInterfaces This property is required. []NetworkInterfaceResponse
Network configurations.
networkInterfaces This property is required. List<NetworkInterfaceResponse>
Network configurations.
networkInterfaces This property is required. NetworkInterfaceResponse[]
Network configurations.
network_interfaces This property is required. Sequence[NetworkInterfaceResponse]
Network configurations.
networkInterfaces This property is required. List<Property Map>
Network configurations.

PlacementPolicyResponse

Collocation This property is required. string
UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.
MaxDistance This property is required. string
When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented
Collocation This property is required. string
UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.
MaxDistance This property is required. string
When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented
collocation This property is required. String
UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.
maxDistance This property is required. String
When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented
collocation This property is required. string
UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.
maxDistance This property is required. string
When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented
collocation This property is required. str
UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.
max_distance This property is required. str
When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented
collocation This property is required. String
UNSPECIFIED vs. COLLOCATED (default UNSPECIFIED). Use COLLOCATED when you want VMs to be located close to each other for low network latency between the VMs. No placement policy will be generated when collocation is UNSPECIFIED.
maxDistance This property is required. String
When specified, causes the job to fail if more than max_distance logical switches are required between VMs. Batch uses the most compact possible placement of VMs even when max_distance is not specified. An explicit max_distance makes that level of compactness a strict requirement. Not yet implemented

RunnableResponse

AlwaysRun This property is required. bool
By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
Background This property is required. bool
This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).
Barrier This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.BarrierResponse
Barrier runnable.
Container This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.ContainerResponse
Container runnable.
DisplayName This property is required. string
Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs.
Environment This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.EnvironmentResponse
Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
IgnoreExitStatus This property is required. bool
Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
Labels This property is required. Dictionary<string, string>
Labels for this Runnable.
Script This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.ScriptResponse
Script runnable.
Timeout This property is required. string
Timeout for this Runnable.
AlwaysRun This property is required. bool
By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
Background This property is required. bool
This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).
Barrier This property is required. BarrierResponse
Barrier runnable.
Container This property is required. ContainerResponse
Container runnable.
DisplayName This property is required. string
Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs.
Environment This property is required. EnvironmentResponse
Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
IgnoreExitStatus This property is required. bool
Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
Labels This property is required. map[string]string
Labels for this Runnable.
Script This property is required. ScriptResponse
Script runnable.
Timeout This property is required. string
Timeout for this Runnable.
alwaysRun This property is required. Boolean
By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
background This property is required. Boolean
This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).
barrier This property is required. BarrierResponse
Barrier runnable.
container This property is required. ContainerResponse
Container runnable.
displayName This property is required. String
Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs.
environment This property is required. EnvironmentResponse
Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
ignoreExitStatus This property is required. Boolean
Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
labels This property is required. Map<String,String>
Labels for this Runnable.
script This property is required. ScriptResponse
Script runnable.
timeout This property is required. String
Timeout for this Runnable.
alwaysRun This property is required. boolean
By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
background This property is required. boolean
This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).
barrier This property is required. BarrierResponse
Barrier runnable.
container This property is required. ContainerResponse
Container runnable.
displayName This property is required. string
Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs.
environment This property is required. EnvironmentResponse
Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
ignoreExitStatus This property is required. boolean
Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
labels This property is required. {[key: string]: string}
Labels for this Runnable.
script This property is required. ScriptResponse
Script runnable.
timeout This property is required. string
Timeout for this Runnable.
always_run This property is required. bool
By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
background This property is required. bool
This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).
barrier This property is required. BarrierResponse
Barrier runnable.
container This property is required. ContainerResponse
Container runnable.
display_name This property is required. str
Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs.
environment This property is required. EnvironmentResponse
Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
ignore_exit_status This property is required. bool
Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
labels This property is required. Mapping[str, str]
Labels for this Runnable.
script This property is required. ScriptResponse
Script runnable.
timeout This property is required. str
Timeout for this Runnable.
alwaysRun This property is required. Boolean
By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then no further Runnables will execute, not even always_run Runnables.
background This property is required. Boolean
This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).
barrier This property is required. Property Map
Barrier runnable.
container This property is required. Property Map
Container runnable.
displayName This property is required. String
Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs.
environment This property is required. Property Map
Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup).
ignoreExitStatus This property is required. Boolean
Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.
labels This property is required. Map<String>
Labels for this Runnable.
script This property is required. Property Map
Script runnable.
timeout This property is required. String
Timeout for this Runnable.

ScriptResponse

Path This property is required. string
Script file path on the host VM. To specify an interpreter, please add a #!(also known as shebang line) as the first line of the file.(For example, to execute the script using bash, #!/bin/bash should be the first line of the file. To execute the script usingPython3, #!/usr/bin/env python3 should be the first line of the file.) Otherwise, the file will by default be excuted by /bin/sh.
Text This property is required. string
Shell script text. To specify an interpreter, please add a #!\n at the beginning of the text.(For example, to execute the script using bash, #!/bin/bash\n should be added. To execute the script usingPython3, #!/usr/bin/env python3\n should be added.) Otherwise, the script will by default be excuted by /bin/sh.
Path This property is required. string
Script file path on the host VM. To specify an interpreter, please add a #!(also known as shebang line) as the first line of the file.(For example, to execute the script using bash, #!/bin/bash should be the first line of the file. To execute the script usingPython3, #!/usr/bin/env python3 should be the first line of the file.) Otherwise, the file will by default be excuted by /bin/sh.
Text This property is required. string
Shell script text. To specify an interpreter, please add a #!\n at the beginning of the text.(For example, to execute the script using bash, #!/bin/bash\n should be added. To execute the script usingPython3, #!/usr/bin/env python3\n should be added.) Otherwise, the script will by default be excuted by /bin/sh.
path This property is required. String
Script file path on the host VM. To specify an interpreter, please add a #!(also known as shebang line) as the first line of the file.(For example, to execute the script using bash, #!/bin/bash should be the first line of the file. To execute the script usingPython3, #!/usr/bin/env python3 should be the first line of the file.) Otherwise, the file will by default be excuted by /bin/sh.
text This property is required. String
Shell script text. To specify an interpreter, please add a #!\n at the beginning of the text.(For example, to execute the script using bash, #!/bin/bash\n should be added. To execute the script usingPython3, #!/usr/bin/env python3\n should be added.) Otherwise, the script will by default be excuted by /bin/sh.
path This property is required. string
Script file path on the host VM. To specify an interpreter, please add a #!(also known as shebang line) as the first line of the file.(For example, to execute the script using bash, #!/bin/bash should be the first line of the file. To execute the script usingPython3, #!/usr/bin/env python3 should be the first line of the file.) Otherwise, the file will by default be excuted by /bin/sh.
text This property is required. string
Shell script text. To specify an interpreter, please add a #!\n at the beginning of the text.(For example, to execute the script using bash, #!/bin/bash\n should be added. To execute the script usingPython3, #!/usr/bin/env python3\n should be added.) Otherwise, the script will by default be excuted by /bin/sh.
path This property is required. str
Script file path on the host VM. To specify an interpreter, please add a #!(also known as shebang line) as the first line of the file.(For example, to execute the script using bash, #!/bin/bash should be the first line of the file. To execute the script usingPython3, #!/usr/bin/env python3 should be the first line of the file.) Otherwise, the file will by default be excuted by /bin/sh.
text This property is required. str
Shell script text. To specify an interpreter, please add a #!\n at the beginning of the text.(For example, to execute the script using bash, #!/bin/bash\n should be added. To execute the script usingPython3, #!/usr/bin/env python3\n should be added.) Otherwise, the script will by default be excuted by /bin/sh.
path This property is required. String
Script file path on the host VM. To specify an interpreter, please add a #!(also known as shebang line) as the first line of the file.(For example, to execute the script using bash, #!/bin/bash should be the first line of the file. To execute the script usingPython3, #!/usr/bin/env python3 should be the first line of the file.) Otherwise, the file will by default be excuted by /bin/sh.
text This property is required. String
Shell script text. To specify an interpreter, please add a #!\n at the beginning of the text.(For example, to execute the script using bash, #!/bin/bash\n should be added. To execute the script usingPython3, #!/usr/bin/env python3\n should be added.) Otherwise, the script will by default be excuted by /bin/sh.

ServiceAccountResponse

Email This property is required. string
Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service account has to be specified in the instance template and it has to match the email field here.
Scopes This property is required. List<string>
List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default.
Email This property is required. string
Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service account has to be specified in the instance template and it has to match the email field here.
Scopes This property is required. []string
List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default.
email This property is required. String
Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service account has to be specified in the instance template and it has to match the email field here.
scopes This property is required. List<String>
List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default.
email This property is required. string
Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service account has to be specified in the instance template and it has to match the email field here.
scopes This property is required. string[]
List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default.
email This property is required. str
Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service account has to be specified in the instance template and it has to match the email field here.
scopes This property is required. Sequence[str]
List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default.
email This property is required. String
Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service account has to be specified in the instance template and it has to match the email field here.
scopes This property is required. List<String>
List of scopes to be enabled for this service account on the VM, in addition to the cloud-platform API scope that will be added by default.

StatusEventResponse

Description This property is required. string
Description of the event.
EventTime This property is required. string
The time this event occurred.
TaskExecution This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.TaskExecutionResponse
Task Execution
TaskState This property is required. string
Task State
Type This property is required. string
Type of the event.
Description This property is required. string
Description of the event.
EventTime This property is required. string
The time this event occurred.
TaskExecution This property is required. TaskExecutionResponse
Task Execution
TaskState This property is required. string
Task State
Type This property is required. string
Type of the event.
description This property is required. String
Description of the event.
eventTime This property is required. String
The time this event occurred.
taskExecution This property is required. TaskExecutionResponse
Task Execution
taskState This property is required. String
Task State
type This property is required. String
Type of the event.
description This property is required. string
Description of the event.
eventTime This property is required. string
The time this event occurred.
taskExecution This property is required. TaskExecutionResponse
Task Execution
taskState This property is required. string
Task State
type This property is required. string
Type of the event.
description This property is required. str
Description of the event.
event_time This property is required. str
The time this event occurred.
task_execution This property is required. TaskExecutionResponse
Task Execution
task_state This property is required. str
Task State
type This property is required. str
Type of the event.
description This property is required. String
Description of the event.
eventTime This property is required. String
The time this event occurred.
taskExecution This property is required. Property Map
Task Execution
taskState This property is required. String
Task State
type This property is required. String
Type of the event.

TaskExecutionResponse

ExitCode This property is required. int
When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
ExitCode This property is required. int
When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
exitCode This property is required. Integer
When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
exitCode This property is required. number
When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
exit_code This property is required. int
When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
exitCode This property is required. Number
When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.

TaskGroupResponse

Name This property is required. string
TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
Parallelism This property is required. string
Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
PermissiveSsh This property is required. bool
When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
RequireHostsFile This property is required. bool
When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
SchedulingPolicy This property is required. string
Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
TaskCount This property is required. string
Number of Tasks in the TaskGroup. Default is 1.
TaskCountPerNode This property is required. string
Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
TaskEnvironments This property is required. List<Pulumi.GoogleNative.Batch.V1.Inputs.EnvironmentResponse>
An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1).
TaskSpec This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.TaskSpecResponse
Tasks in the group share the same task spec.
Name This property is required. string
TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
Parallelism This property is required. string
Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
PermissiveSsh This property is required. bool
When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
RequireHostsFile This property is required. bool
When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
SchedulingPolicy This property is required. string
Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
TaskCount This property is required. string
Number of Tasks in the TaskGroup. Default is 1.
TaskCountPerNode This property is required. string
Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
TaskEnvironments This property is required. []EnvironmentResponse
An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1).
TaskSpec This property is required. TaskSpecResponse
Tasks in the group share the same task spec.
name This property is required. String
TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
parallelism This property is required. String
Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
permissiveSsh This property is required. Boolean
When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
requireHostsFile This property is required. Boolean
When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
schedulingPolicy This property is required. String
Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
taskCount This property is required. String
Number of Tasks in the TaskGroup. Default is 1.
taskCountPerNode This property is required. String
Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
taskEnvironments This property is required. List<EnvironmentResponse>
An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1).
taskSpec This property is required. TaskSpecResponse
Tasks in the group share the same task spec.
name This property is required. string
TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
parallelism This property is required. string
Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
permissiveSsh This property is required. boolean
When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
requireHostsFile This property is required. boolean
When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
schedulingPolicy This property is required. string
Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
taskCount This property is required. string
Number of Tasks in the TaskGroup. Default is 1.
taskCountPerNode This property is required. string
Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
taskEnvironments This property is required. EnvironmentResponse[]
An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1).
taskSpec This property is required. TaskSpecResponse
Tasks in the group share the same task spec.
name This property is required. str
TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
parallelism This property is required. str
Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
permissive_ssh This property is required. bool
When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
require_hosts_file This property is required. bool
When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
scheduling_policy This property is required. str
Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
task_count This property is required. str
Number of Tasks in the TaskGroup. Default is 1.
task_count_per_node This property is required. str
Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
task_environments This property is required. Sequence[EnvironmentResponse]
An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1).
task_spec This property is required. TaskSpecResponse
Tasks in the group share the same task spec.
name This property is required. String
TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01".
parallelism This property is required. String
Max number of tasks that can run in parallel. Default to min(task_count, parallel tasks per job limit). See: Job Limits. Field parallelism must be 1 if the scheduling_policy is IN_ORDER.
permissiveSsh This property is required. Boolean
When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup.
requireHostsFile This property is required. Boolean
When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false.
schedulingPolicy This property is required. String
Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE.
taskCount This property is required. String
Number of Tasks in the TaskGroup. Default is 1.
taskCountPerNode This property is required. String
Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements.
taskEnvironments This property is required. List<Property Map>
An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1).
taskSpec This property is required. Property Map
Tasks in the group share the same task spec.

TaskSpecResponse

ComputeResource This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.ComputeResourceResponse
ComputeResource requirements.
Environment This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.EnvironmentResponse
Environment variables to set before running the Task.
Environments This property is required. Dictionary<string, string>
Deprecated: please use environment(non-plural) instead.

Deprecated: Deprecated: please use environment(non-plural) instead.

LifecyclePolicies This property is required. List<Pulumi.GoogleNative.Batch.V1.Inputs.LifecyclePolicyResponse>
Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
MaxRetryCount This property is required. int
Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
MaxRunDuration This property is required. string
Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
Runnables This property is required. List<Pulumi.GoogleNative.Batch.V1.Inputs.RunnableResponse>
The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
Volumes This property is required. List<Pulumi.GoogleNative.Batch.V1.Inputs.VolumeResponse>
Volumes to mount before running Tasks using this TaskSpec.
ComputeResource This property is required. ComputeResourceResponse
ComputeResource requirements.
Environment This property is required. EnvironmentResponse
Environment variables to set before running the Task.
Environments This property is required. map[string]string
Deprecated: please use environment(non-plural) instead.

Deprecated: Deprecated: please use environment(non-plural) instead.

LifecyclePolicies This property is required. []LifecyclePolicyResponse
Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
MaxRetryCount This property is required. int
Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
MaxRunDuration This property is required. string
Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
Runnables This property is required. []RunnableResponse
The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
Volumes This property is required. []VolumeResponse
Volumes to mount before running Tasks using this TaskSpec.
computeResource This property is required. ComputeResourceResponse
ComputeResource requirements.
environment This property is required. EnvironmentResponse
Environment variables to set before running the Task.
environments This property is required. Map<String,String>
Deprecated: please use environment(non-plural) instead.

Deprecated: Deprecated: please use environment(non-plural) instead.

lifecyclePolicies This property is required. List<LifecyclePolicyResponse>
Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
maxRetryCount This property is required. Integer
Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
maxRunDuration This property is required. String
Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
runnables This property is required. List<RunnableResponse>
The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
volumes This property is required. List<VolumeResponse>
Volumes to mount before running Tasks using this TaskSpec.
computeResource This property is required. ComputeResourceResponse
ComputeResource requirements.
environment This property is required. EnvironmentResponse
Environment variables to set before running the Task.
environments This property is required. {[key: string]: string}
Deprecated: please use environment(non-plural) instead.

Deprecated: Deprecated: please use environment(non-plural) instead.

lifecyclePolicies This property is required. LifecyclePolicyResponse[]
Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
maxRetryCount This property is required. number
Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
maxRunDuration This property is required. string
Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
runnables This property is required. RunnableResponse[]
The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
volumes This property is required. VolumeResponse[]
Volumes to mount before running Tasks using this TaskSpec.
compute_resource This property is required. ComputeResourceResponse
ComputeResource requirements.
environment This property is required. EnvironmentResponse
Environment variables to set before running the Task.
environments This property is required. Mapping[str, str]
Deprecated: please use environment(non-plural) instead.

Deprecated: Deprecated: please use environment(non-plural) instead.

lifecycle_policies This property is required. Sequence[LifecyclePolicyResponse]
Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
max_retry_count This property is required. int
Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
max_run_duration This property is required. str
Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
runnables This property is required. Sequence[RunnableResponse]
The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
volumes This property is required. Sequence[VolumeResponse]
Volumes to mount before running Tasks using this TaskSpec.
computeResource This property is required. Property Map
ComputeResource requirements.
environment This property is required. Property Map
Environment variables to set before running the Task.
environments This property is required. Map<String>
Deprecated: please use environment(non-plural) instead.

Deprecated: Deprecated: please use environment(non-plural) instead.

lifecyclePolicies This property is required. List<Property Map>
Lifecycle management schema when any task in a task group is failed. Currently we only support one lifecycle policy. When the lifecycle policy condition is met, the action in the policy will execute. If task execution result does not meet with the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit code, retry the task with max_retry_count.
maxRetryCount This property is required. Number
Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10].
maxRunDuration This property is required. String
Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit.
runnables This property is required. List<Property Map>
The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.
volumes This property is required. List<Property Map>
Volumes to mount before running Tasks using this TaskSpec.

VolumeResponse

DeviceName This property is required. string
Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given instance template in job.allocation_policy.instances[0].instance_template.
Gcs This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.GCSResponse
A Google Cloud Storage (GCS) volume.
MountOptions This property is required. List<string>
For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).
MountPath This property is required. string
The mount path for the volume, e.g. /mnt/disks/share.
Nfs This property is required. Pulumi.GoogleNative.Batch.V1.Inputs.NFSResponse
A Network File System (NFS) volume. For example, a Filestore file share.
DeviceName This property is required. string
Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given instance template in job.allocation_policy.instances[0].instance_template.
Gcs This property is required. GCSResponse
A Google Cloud Storage (GCS) volume.
MountOptions This property is required. []string
For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).
MountPath This property is required. string
The mount path for the volume, e.g. /mnt/disks/share.
Nfs This property is required. NFSResponse
A Network File System (NFS) volume. For example, a Filestore file share.
deviceName This property is required. String
Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given instance template in job.allocation_policy.instances[0].instance_template.
gcs This property is required. GCSResponse
A Google Cloud Storage (GCS) volume.
mountOptions This property is required. List<String>
For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).
mountPath This property is required. String
The mount path for the volume, e.g. /mnt/disks/share.
nfs This property is required. NFSResponse
A Network File System (NFS) volume. For example, a Filestore file share.
deviceName This property is required. string
Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given instance template in job.allocation_policy.instances[0].instance_template.
gcs This property is required. GCSResponse
A Google Cloud Storage (GCS) volume.
mountOptions This property is required. string[]
For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).
mountPath This property is required. string
The mount path for the volume, e.g. /mnt/disks/share.
nfs This property is required. NFSResponse
A Network File System (NFS) volume. For example, a Filestore file share.
device_name This property is required. str
Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given instance template in job.allocation_policy.instances[0].instance_template.
gcs This property is required. GCSResponse
A Google Cloud Storage (GCS) volume.
mount_options This property is required. Sequence[str]
For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).
mount_path This property is required. str
The mount path for the volume, e.g. /mnt/disks/share.
nfs This property is required. NFSResponse
A Network File System (NFS) volume. For example, a Filestore file share.
deviceName This property is required. String
Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given instance template in job.allocation_policy.instances[0].instance_template.
gcs This property is required. Property Map
A Google Cloud Storage (GCS) volume.
mountOptions This property is required. List<String>
For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html).
mountPath This property is required. String
The mount path for the volume, e.g. /mnt/disks/share.
nfs This property is required. Property Map
A Network File System (NFS) volume. For example, a Filestore file share.

Package Details

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

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

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi