Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. remotebuildexecution
  5. remotebuildexecution/v1alpha
  6. getWorkerPool

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

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

google-native.remotebuildexecution/v1alpha.getWorkerPool

Explore with Pulumi AI

google-native logo

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

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

    Returns the specified worker pool.

    Using getWorkerPool

    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 getWorkerPool(args: GetWorkerPoolArgs, opts?: InvokeOptions): Promise<GetWorkerPoolResult>
function getWorkerPoolOutput(args: GetWorkerPoolOutputArgs, opts?: InvokeOptions): Output<GetWorkerPoolResult>
    def get_worker_pool(instance_id: Optional[str] = None,
                    project: Optional[str] = None,
                    workerpool_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetWorkerPoolResult
def get_worker_pool_output(instance_id: Optional[pulumi.Input[str]] = None,
                    project: Optional[pulumi.Input[str]] = None,
                    workerpool_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetWorkerPoolResult]
    func LookupWorkerPool(ctx *Context, args *LookupWorkerPoolArgs, opts ...InvokeOption) (*LookupWorkerPoolResult, error)
func LookupWorkerPoolOutput(ctx *Context, args *LookupWorkerPoolOutputArgs, opts ...InvokeOption) LookupWorkerPoolResultOutput

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

    public static class GetWorkerPool 
{
    public static Task<GetWorkerPoolResult> InvokeAsync(GetWorkerPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkerPoolResult> Invoke(GetWorkerPoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWorkerPoolResult> getWorkerPool(GetWorkerPoolArgs args, InvokeOptions options)
public static Output<GetWorkerPoolResult> getWorkerPool(GetWorkerPoolArgs args, InvokeOptions options)

    fn::invoke:
  function: google-native:remotebuildexecution/v1alpha:getWorkerPool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    WorkerpoolId string
    Project string
    InstanceId string
    WorkerpoolId string
    Project string
    instanceId String
    workerpoolId String
    project String
    instanceId string
    workerpoolId string
    project string
    instanceId String
    workerpoolId String
    project String

    getWorkerPool Result

    The following output properties are available:

    Autoscale Pulumi.GoogleNative.RemoteBuildExecution.V1Alpha.Outputs.GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscaleResponse
    The autoscale policy to apply on a pool.
    Channel string
    Channel specifies the release channel of the pool.
    Name string
    WorkerPool resource name formatted as: projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]. name should not be populated when creating a worker pool since it is provided in the poolId field.
    State string
    State of the worker pool.
    WorkerConfig Pulumi.GoogleNative.RemoteBuildExecution.V1Alpha.Outputs.GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfigResponse
    Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool.
    WorkerCount string
    The desired number of workers in the worker pool. Must be a value between 0 and 15000.
    Autoscale GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscaleResponse
    The autoscale policy to apply on a pool.
    Channel string
    Channel specifies the release channel of the pool.
    Name string
    WorkerPool resource name formatted as: projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]. name should not be populated when creating a worker pool since it is provided in the poolId field.
    State string
    State of the worker pool.
    WorkerConfig GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfigResponse
    Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool.
    WorkerCount string
    The desired number of workers in the worker pool. Must be a value between 0 and 15000.
    autoscale GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscaleResponse
    The autoscale policy to apply on a pool.
    channel String
    Channel specifies the release channel of the pool.
    name String
    WorkerPool resource name formatted as: projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]. name should not be populated when creating a worker pool since it is provided in the poolId field.
    state String
    State of the worker pool.
    workerConfig GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfigResponse
    Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool.
    workerCount String
    The desired number of workers in the worker pool. Must be a value between 0 and 15000.
    autoscale GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscaleResponse
    The autoscale policy to apply on a pool.
    channel string
    Channel specifies the release channel of the pool.
    name string
    WorkerPool resource name formatted as: projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]. name should not be populated when creating a worker pool since it is provided in the poolId field.
    state string
    State of the worker pool.
    workerConfig GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfigResponse
    Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool.
    workerCount string
    The desired number of workers in the worker pool. Must be a value between 0 and 15000.
    autoscale GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscaleResponse
    The autoscale policy to apply on a pool.
    channel str
    Channel specifies the release channel of the pool.
    name str
    WorkerPool resource name formatted as: projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]. name should not be populated when creating a worker pool since it is provided in the poolId field.
    state str
    State of the worker pool.
    worker_config GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfigResponse
    Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool.
    worker_count str
    The desired number of workers in the worker pool. Must be a value between 0 and 15000.
    autoscale Property Map
    The autoscale policy to apply on a pool.
    channel String
    Channel specifies the release channel of the pool.
    name String
    WorkerPool resource name formatted as: projects/[PROJECT_ID]/instances/[INSTANCE_ID]/workerpools/[POOL_ID]. name should not be populated when creating a worker pool since it is provided in the poolId field.
    state String
    State of the worker pool.
    workerConfig Property Map
    Specifies the properties, such as machine type and disk size, used for creating workers in a worker pool.
    workerCount String
    The desired number of workers in the worker pool. Must be a value between 0 and 15000.

    Supporting Types

    GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfigResponse

    AcceleratorCount string
    The number of guest accelerator cards exposed to each VM.
    AcceleratorType string
    The type of accelerator to attach to each VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80.
    AcceleratorCount string
    The number of guest accelerator cards exposed to each VM.
    AcceleratorType string
    The type of accelerator to attach to each VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80.
    acceleratorCount String
    The number of guest accelerator cards exposed to each VM.
    acceleratorType String
    The type of accelerator to attach to each VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80.
    acceleratorCount string
    The number of guest accelerator cards exposed to each VM.
    acceleratorType string
    The type of accelerator to attach to each VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80.
    accelerator_count str
    The number of guest accelerator cards exposed to each VM.
    accelerator_type str
    The type of accelerator to attach to each VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80.
    acceleratorCount String
    The number of guest accelerator cards exposed to each VM.
    acceleratorType String
    The type of accelerator to attach to each VM, e.g. "nvidia-tesla-k80" for nVidia Tesla K80.

    GoogleDevtoolsRemotebuildexecutionAdminV1alphaAutoscaleResponse

    MaxSize string
    The maximal number of workers. Must be equal to or greater than min_size.
    MinSize string
    The minimal number of workers. Must be greater than 0.
    MaxSize string
    The maximal number of workers. Must be equal to or greater than min_size.
    MinSize string
    The minimal number of workers. Must be greater than 0.
    maxSize String
    The maximal number of workers. Must be equal to or greater than min_size.
    minSize String
    The minimal number of workers. Must be greater than 0.
    maxSize string
    The maximal number of workers. Must be equal to or greater than min_size.
    minSize string
    The minimal number of workers. Must be greater than 0.
    max_size str
    The maximal number of workers. Must be equal to or greater than min_size.
    min_size str
    The minimal number of workers. Must be greater than 0.
    maxSize String
    The maximal number of workers. Must be equal to or greater than min_size.
    minSize String
    The minimal number of workers. Must be greater than 0.

    GoogleDevtoolsRemotebuildexecutionAdminV1alphaWorkerConfigResponse

    Accelerator Pulumi.GoogleNative.RemoteBuildExecution.V1Alpha.Inputs.GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfigResponse
    The accelerator card attached to each VM.
    DiskSizeGb string
    Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/
    DiskType string
    Disk Type to use for the worker. See Storage options. Currently only pd-standard and pd-ssd are supported.
    Labels Dictionary<string, string>
    Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Label keys must start with a letter. Label values are optional. There can not be more than 64 labels per resource.
    MachineType string
    Machine type of the worker, such as e2-standard-2. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that f1-micro and g1-small are not yet supported.
    MaxConcurrentActions string
    The maximum number of actions a worker can execute concurrently.
    MinCpuPlatform string
    Minimum CPU platform to use when creating the worker. See CPU Platforms.
    NetworkAccess string
    Determines the type of network access granted to workers. Possible values: - "public": Workers can connect to the public internet. - "private": Workers can only connect to Google APIs and services. - "restricted-private": Workers can only connect to Google APIs that are reachable through restricted.googleapis.com (199.36.153.4/30).
    Reserved bool
    Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See Preemptible VMs for more details.
    SoleTenantNodeType string
    The node type name to be used for sole-tenant nodes.
    VmImage string
    The name of the image used by each VM.
    Accelerator GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfigResponse
    The accelerator card attached to each VM.
    DiskSizeGb string
    Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/
    DiskType string
    Disk Type to use for the worker. See Storage options. Currently only pd-standard and pd-ssd are supported.
    Labels map[string]string
    Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Label keys must start with a letter. Label values are optional. There can not be more than 64 labels per resource.
    MachineType string
    Machine type of the worker, such as e2-standard-2. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that f1-micro and g1-small are not yet supported.
    MaxConcurrentActions string
    The maximum number of actions a worker can execute concurrently.
    MinCpuPlatform string
    Minimum CPU platform to use when creating the worker. See CPU Platforms.
    NetworkAccess string
    Determines the type of network access granted to workers. Possible values: - "public": Workers can connect to the public internet. - "private": Workers can only connect to Google APIs and services. - "restricted-private": Workers can only connect to Google APIs that are reachable through restricted.googleapis.com (199.36.153.4/30).
    Reserved bool
    Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See Preemptible VMs for more details.
    SoleTenantNodeType string
    The node type name to be used for sole-tenant nodes.
    VmImage string
    The name of the image used by each VM.
    accelerator GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfigResponse
    The accelerator card attached to each VM.
    diskSizeGb String
    Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/
    diskType String
    Disk Type to use for the worker. See Storage options. Currently only pd-standard and pd-ssd are supported.
    labels Map<String,String>
    Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Label keys must start with a letter. Label values are optional. There can not be more than 64 labels per resource.
    machineType String
    Machine type of the worker, such as e2-standard-2. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that f1-micro and g1-small are not yet supported.
    maxConcurrentActions String
    The maximum number of actions a worker can execute concurrently.
    minCpuPlatform String
    Minimum CPU platform to use when creating the worker. See CPU Platforms.
    networkAccess String
    Determines the type of network access granted to workers. Possible values: - "public": Workers can connect to the public internet. - "private": Workers can only connect to Google APIs and services. - "restricted-private": Workers can only connect to Google APIs that are reachable through restricted.googleapis.com (199.36.153.4/30).
    reserved Boolean
    Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See Preemptible VMs for more details.
    soleTenantNodeType String
    The node type name to be used for sole-tenant nodes.
    vmImage String
    The name of the image used by each VM.
    accelerator GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfigResponse
    The accelerator card attached to each VM.
    diskSizeGb string
    Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/
    diskType string
    Disk Type to use for the worker. See Storage options. Currently only pd-standard and pd-ssd are supported.
    labels {[key: string]: string}
    Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Label keys must start with a letter. Label values are optional. There can not be more than 64 labels per resource.
    machineType string
    Machine type of the worker, such as e2-standard-2. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that f1-micro and g1-small are not yet supported.
    maxConcurrentActions string
    The maximum number of actions a worker can execute concurrently.
    minCpuPlatform string
    Minimum CPU platform to use when creating the worker. See CPU Platforms.
    networkAccess string
    Determines the type of network access granted to workers. Possible values: - "public": Workers can connect to the public internet. - "private": Workers can only connect to Google APIs and services. - "restricted-private": Workers can only connect to Google APIs that are reachable through restricted.googleapis.com (199.36.153.4/30).
    reserved boolean
    Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See Preemptible VMs for more details.
    soleTenantNodeType string
    The node type name to be used for sole-tenant nodes.
    vmImage string
    The name of the image used by each VM.
    accelerator GoogleDevtoolsRemotebuildexecutionAdminV1alphaAcceleratorConfigResponse
    The accelerator card attached to each VM.
    disk_size_gb str
    Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/
    disk_type str
    Disk Type to use for the worker. See Storage options. Currently only pd-standard and pd-ssd are supported.
    labels Mapping[str, str]
    Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Label keys must start with a letter. Label values are optional. There can not be more than 64 labels per resource.
    machine_type str
    Machine type of the worker, such as e2-standard-2. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that f1-micro and g1-small are not yet supported.
    max_concurrent_actions str
    The maximum number of actions a worker can execute concurrently.
    min_cpu_platform str
    Minimum CPU platform to use when creating the worker. See CPU Platforms.
    network_access str
    Determines the type of network access granted to workers. Possible values: - "public": Workers can connect to the public internet. - "private": Workers can only connect to Google APIs and services. - "restricted-private": Workers can only connect to Google APIs that are reachable through restricted.googleapis.com (199.36.153.4/30).
    reserved bool
    Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See Preemptible VMs for more details.
    sole_tenant_node_type str
    The node type name to be used for sole-tenant nodes.
    vm_image str
    The name of the image used by each VM.
    accelerator Property Map
    The accelerator card attached to each VM.
    diskSizeGb String
    Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/
    diskType String
    Disk Type to use for the worker. See Storage options. Currently only pd-standard and pd-ssd are supported.
    labels Map<String>
    Labels associated with the workers. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International letters are permitted. Label keys must start with a letter. Label values are optional. There can not be more than 64 labels per resource.
    machineType String
    Machine type of the worker, such as e2-standard-2. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that f1-micro and g1-small are not yet supported.
    maxConcurrentActions String
    The maximum number of actions a worker can execute concurrently.
    minCpuPlatform String
    Minimum CPU platform to use when creating the worker. See CPU Platforms.
    networkAccess String
    Determines the type of network access granted to workers. Possible values: - "public": Workers can connect to the public internet. - "private": Workers can only connect to Google APIs and services. - "restricted-private": Workers can only connect to Google APIs that are reachable through restricted.googleapis.com (199.36.153.4/30).
    reserved Boolean
    Determines whether the worker is reserved (equivalent to a Compute Engine on-demand VM and therefore won't be preempted). See Preemptible VMs for more details.
    soleTenantNodeType String
    The node type name to be used for sole-tenant nodes.
    vmImage String
    The name of the image used by each VM.

    Package Details

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

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

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