Google Cloud Native v0.28.0, Feb 2 23

google-native.cloudbuild/v1alpha2.WorkerPool

Creates a WorkerPool to run the builds, and returns the new worker pool. Auto-naming is currently not supported for this resource.

Create WorkerPool Resource

new WorkerPool(name: string, args: WorkerPoolArgs, opts?: CustomResourceOptions);

@overload
def WorkerPool(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               network_config: Optional[NetworkConfigArgs] = None,
               project: Optional[str] = None,
               region: Optional[str] = None,
               worker_config: Optional[WorkerConfigArgs] = None,
               worker_pool_id: Optional[str] = None)
@overload
def WorkerPool(resource_name: str,
               args: WorkerPoolArgs,
               opts: Optional[ResourceOptions] = None)

func NewWorkerPool(ctx *Context, name string, args WorkerPoolArgs, opts ...ResourceOption) (*WorkerPool, error)

public WorkerPool(string name, WorkerPoolArgs args, CustomResourceOptions? opts = null)

public WorkerPool(String name, WorkerPoolArgs args)
public WorkerPool(String name, WorkerPoolArgs args, CustomResourceOptions options)

type: google-native:cloudbuild/v1alpha2:WorkerPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args WorkerPoolArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args WorkerPoolArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args WorkerPoolArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args WorkerPoolArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args WorkerPoolArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

WorkerPool Resource Properties

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

Inputs

The WorkerPool resource accepts the following input properties:

Region string: Immutable. The region where the WorkerPool runs. Only "us-central1" is currently supported. Note that region cannot be changed once the WorkerPool is created.
WorkerPoolId string: Required. Immutable. The ID to use for the WorkerPool, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/.
NetworkConfig Pulumi.GoogleNative.CloudBuild.V1Alpha2.Inputs.NetworkConfigArgs: Network configuration for the WorkerPool.
Project string
WorkerConfig Pulumi.GoogleNative.CloudBuild.V1Alpha2.Inputs.WorkerConfigArgs: Worker configuration for the WorkerPool.

Region string: Immutable. The region where the WorkerPool runs. Only "us-central1" is currently supported. Note that region cannot be changed once the WorkerPool is created.
WorkerPoolId string: Required. Immutable. The ID to use for the WorkerPool, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/.
NetworkConfig NetworkConfigArgs: Network configuration for the WorkerPool.
Project string
WorkerConfig WorkerConfigArgs: Worker configuration for the WorkerPool.

region String: Immutable. The region where the WorkerPool runs. Only "us-central1" is currently supported. Note that region cannot be changed once the WorkerPool is created.
workerPoolId String: Required. Immutable. The ID to use for the WorkerPool, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/.
networkConfig NetworkConfigArgs: Network configuration for the WorkerPool.
project String
workerConfig WorkerConfigArgs: Worker configuration for the WorkerPool.

region string: Immutable. The region where the WorkerPool runs. Only "us-central1" is currently supported. Note that region cannot be changed once the WorkerPool is created.
workerPoolId string: Required. Immutable. The ID to use for the WorkerPool, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/.
networkConfig NetworkConfigArgs: Network configuration for the WorkerPool.
project string
workerConfig WorkerConfigArgs: Worker configuration for the WorkerPool.

region str: Immutable. The region where the WorkerPool runs. Only "us-central1" is currently supported. Note that region cannot be changed once the WorkerPool is created.
worker_pool_id str: Required. Immutable. The ID to use for the WorkerPool, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/.
network_config NetworkConfigArgs: Network configuration for the WorkerPool.
project str
worker_config WorkerConfigArgs: Worker configuration for the WorkerPool.

region String: Immutable. The region where the WorkerPool runs. Only "us-central1" is currently supported. Note that region cannot be changed once the WorkerPool is created.
workerPoolId String: Required. Immutable. The ID to use for the WorkerPool, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/.
networkConfig Property Map: Network configuration for the WorkerPool.
project String
workerConfig Property Map: Worker configuration for the WorkerPool.

Outputs

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

CreateTime string: Time at which the request to create the WorkerPool was received.
DeleteTime string: Time at which the request to delete the WorkerPool was received.
Id string: The provider-assigned unique ID for this managed resource.
Name string: The resource name of the WorkerPool. Format of the name is projects/{project_id}/workerPools/{worker_pool_id}, where the value of {worker_pool_id} is provided in the CreateWorkerPool request.
State string: WorkerPool state.
UpdateTime string: Time at which the request to update the WorkerPool was received.

CreateTime string: Time at which the request to create the WorkerPool was received.
DeleteTime string: Time at which the request to delete the WorkerPool was received.
Id string: The provider-assigned unique ID for this managed resource.
Name string: The resource name of the WorkerPool. Format of the name is projects/{project_id}/workerPools/{worker_pool_id}, where the value of {worker_pool_id} is provided in the CreateWorkerPool request.
State string: WorkerPool state.
UpdateTime string: Time at which the request to update the WorkerPool was received.

createTime String: Time at which the request to create the WorkerPool was received.
deleteTime String: Time at which the request to delete the WorkerPool was received.
id String: The provider-assigned unique ID for this managed resource.
name String: The resource name of the WorkerPool. Format of the name is projects/{project_id}/workerPools/{worker_pool_id}, where the value of {worker_pool_id} is provided in the CreateWorkerPool request.
state String: WorkerPool state.
updateTime String: Time at which the request to update the WorkerPool was received.

createTime string: Time at which the request to create the WorkerPool was received.
deleteTime string: Time at which the request to delete the WorkerPool was received.
id string: The provider-assigned unique ID for this managed resource.
name string: The resource name of the WorkerPool. Format of the name is projects/{project_id}/workerPools/{worker_pool_id}, where the value of {worker_pool_id} is provided in the CreateWorkerPool request.
state string: WorkerPool state.
updateTime string: Time at which the request to update the WorkerPool was received.

create_time str: Time at which the request to create the WorkerPool was received.
delete_time str: Time at which the request to delete the WorkerPool was received.
id str: The provider-assigned unique ID for this managed resource.
name str: The resource name of the WorkerPool. Format of the name is projects/{project_id}/workerPools/{worker_pool_id}, where the value of {worker_pool_id} is provided in the CreateWorkerPool request.
state str: WorkerPool state.
update_time str: Time at which the request to update the WorkerPool was received.

createTime String: Time at which the request to create the WorkerPool was received.
deleteTime String: Time at which the request to delete the WorkerPool was received.
id String: The provider-assigned unique ID for this managed resource.
name String: The resource name of the WorkerPool. Format of the name is projects/{project_id}/workerPools/{worker_pool_id}, where the value of {worker_pool_id} is provided in the CreateWorkerPool request.
state String: WorkerPool state.
updateTime String: Time at which the request to update the WorkerPool was received.

Supporting Types

NetworkConfig

PeeredNetwork string: Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to WorkerPool.project_id on the default network. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number, such as 12345, and {network} is the name of a VPC network in the project.

PeeredNetwork string: Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to WorkerPool.project_id on the default network. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number, such as 12345, and {network} is the name of a VPC network in the project.

peeredNetwork String: Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to WorkerPool.project_id on the default network. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number, such as 12345, and {network} is the name of a VPC network in the project.

peeredNetwork string: Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to WorkerPool.project_id on the default network. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number, such as 12345, and {network} is the name of a VPC network in the project.

peered_network str: Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to WorkerPool.project_id on the default network. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number, such as 12345, and {network} is the name of a VPC network in the project.

peeredNetwork String: Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to WorkerPool.project_id on the default network. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number, such as 12345, and {network} is the name of a VPC network in the project.

NetworkConfigResponse

PeeredNetwork string: Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to WorkerPool.project_id on the default network. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number, such as 12345, and {network} is the name of a VPC network in the project.

PeeredNetwork string: Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to WorkerPool.project_id on the default network. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number, such as 12345, and {network} is the name of a VPC network in the project.

peeredNetwork String: Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to WorkerPool.project_id on the default network. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number, such as 12345, and {network} is the name of a VPC network in the project.

peeredNetwork string: Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to WorkerPool.project_id on the default network. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number, such as 12345, and {network} is the name of a VPC network in the project.

peered_network str: Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to WorkerPool.project_id on the default network. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number, such as 12345, and {network} is the name of a VPC network in the project.

peeredNetwork String: Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to WorkerPool.project_id on the default network. Must be in the format projects/{project}/global/networks/{network}, where {project} is a project number, such as 12345, and {network} is the name of a VPC network in the project.

WorkerConfig

DiskSizeGb string: Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If 0 is specified, Cloud Build will use a standard disk size.
MachineType string: Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool.

DiskSizeGb string: Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If 0 is specified, Cloud Build will use a standard disk size.
MachineType string: Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool.

diskSizeGb String: Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If 0 is specified, Cloud Build will use a standard disk size.
machineType String: Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool.

diskSizeGb string: Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If 0 is specified, Cloud Build will use a standard disk size.
machineType string: Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool.

disk_size_gb str: Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If 0 is specified, Cloud Build will use a standard disk size.
machine_type str: Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool.

diskSizeGb String: Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If 0 is specified, Cloud Build will use a standard disk size.
machineType String: Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool.

WorkerConfigResponse

DiskSizeGb string: Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If 0 is specified, Cloud Build will use a standard disk size.
MachineType string: Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool.

DiskSizeGb string: Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If 0 is specified, Cloud Build will use a standard disk size.
MachineType string: Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool.

diskSizeGb String: Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If 0 is specified, Cloud Build will use a standard disk size.
machineType String: Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool.

diskSizeGb string: Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If 0 is specified, Cloud Build will use a standard disk size.
machineType string: Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool.

disk_size_gb str: Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If 0 is specified, Cloud Build will use a standard disk size.
machine_type str: Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool.

diskSizeGb String: Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If 0 is specified, Cloud Build will use a standard disk size.
machineType String: Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool.

Package Details

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