cloudbuildWorkerPool.typescript.md

cloudbuildWorkerPool Submodule

Constructs

CloudbuildWorkerPool

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool google_cloudbuild_worker_pool}.

Initializers

import { cloudbuildWorkerPool } from '@cdktf/provider-google'

new cloudbuildWorkerPool.CloudbuildWorkerPool(scope: Construct, id: string, config: CloudbuildWorkerPoolConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	CloudbuildWorkerPoolConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: CloudbuildWorkerPoolConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
putNetworkConfig	No description.
putPrivateServiceConnect	No description.
putTimeouts	No description.
putWorkerConfig	No description.
resetAnnotations	No description.
resetDisplayName	No description.
resetId	No description.
resetNetworkConfig	No description.
resetPrivateServiceConnect	No description.
resetProject	No description.
resetTimeouts	No description.
resetWorkerConfig	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

putNetworkConfig

public putNetworkConfig(value: CloudbuildWorkerPoolNetworkConfig): void

value^Required

• Type: CloudbuildWorkerPoolNetworkConfig

---

putPrivateServiceConnect

public putPrivateServiceConnect(value: CloudbuildWorkerPoolPrivateServiceConnect): void

value^Required

• Type: CloudbuildWorkerPoolPrivateServiceConnect

---

putTimeouts

public putTimeouts(value: CloudbuildWorkerPoolTimeouts): void

value^Required

• Type: CloudbuildWorkerPoolTimeouts

---

putWorkerConfig

public putWorkerConfig(value: CloudbuildWorkerPoolWorkerConfig): void

value^Required

• Type: CloudbuildWorkerPoolWorkerConfig

---

resetAnnotations

public resetAnnotations(): void

resetDisplayName

public resetDisplayName(): void

resetId

public resetId(): void

resetNetworkConfig

public resetNetworkConfig(): void

resetPrivateServiceConnect

public resetPrivateServiceConnect(): void

resetProject

public resetProject(): void

resetTimeouts

public resetTimeouts(): void

resetWorkerConfig

public resetWorkerConfig(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a CloudbuildWorkerPool resource upon running "cdktf plan ".

---

isConstruct

import { cloudbuildWorkerPool } from '@cdktf/provider-google'

cloudbuildWorkerPool.CloudbuildWorkerPool.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { cloudbuildWorkerPool } from '@cdktf/provider-google'

cloudbuildWorkerPool.CloudbuildWorkerPool.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { cloudbuildWorkerPool } from '@cdktf/provider-google'

cloudbuildWorkerPool.CloudbuildWorkerPool.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { cloudbuildWorkerPool } from '@cdktf/provider-google'

cloudbuildWorkerPool.CloudbuildWorkerPool.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a CloudbuildWorkerPool resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the CloudbuildWorkerPool to import.

---

importFromId^Required

• Type: string

The id of the existing CloudbuildWorkerPool that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the CloudbuildWorkerPool to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
createTime	string	No description.
deleteTime	string	No description.
effectiveAnnotations	cdktf.StringMap	No description.
networkConfig	CloudbuildWorkerPoolNetworkConfigOutputReference	No description.
privateServiceConnect	CloudbuildWorkerPoolPrivateServiceConnectOutputReference	No description.
state	string	No description.
timeouts	CloudbuildWorkerPoolTimeoutsOutputReference	No description.
uid	string	No description.
updateTime	string	No description.
workerConfig	CloudbuildWorkerPoolWorkerConfigOutputReference	No description.
annotationsInput	{[ key: string ]: string}	No description.
displayNameInput	string	No description.
idInput	string	No description.
locationInput	string	No description.
nameInput	string	No description.
networkConfigInput	CloudbuildWorkerPoolNetworkConfig	No description.
privateServiceConnectInput	CloudbuildWorkerPoolPrivateServiceConnect	No description.
projectInput	string	No description.
timeoutsInput	cdktf.IResolvable | CloudbuildWorkerPoolTimeouts	No description.
workerConfigInput	CloudbuildWorkerPoolWorkerConfig	No description.
annotations	{[ key: string ]: string}	No description.
displayName	string	No description.
id	string	No description.
location	string	No description.
name	string	No description.
project	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

createTime^Required

public readonly createTime: string;

• Type: string

---

deleteTime^Required

public readonly deleteTime: string;

• Type: string

---

effectiveAnnotations^Required

public readonly effectiveAnnotations: StringMap;

• Type: cdktf.StringMap

---

networkConfig^Required

public readonly networkConfig: CloudbuildWorkerPoolNetworkConfigOutputReference;

• Type: CloudbuildWorkerPoolNetworkConfigOutputReference

---

privateServiceConnect^Required

public readonly privateServiceConnect: CloudbuildWorkerPoolPrivateServiceConnectOutputReference;

• Type: CloudbuildWorkerPoolPrivateServiceConnectOutputReference

---

state^Required

public readonly state: string;

• Type: string

---

timeouts^Required

public readonly timeouts: CloudbuildWorkerPoolTimeoutsOutputReference;

• Type: CloudbuildWorkerPoolTimeoutsOutputReference

---

uid^Required

public readonly uid: string;

• Type: string

---

updateTime^Required

public readonly updateTime: string;

• Type: string

---

workerConfig^Required

public readonly workerConfig: CloudbuildWorkerPoolWorkerConfigOutputReference;

• Type: CloudbuildWorkerPoolWorkerConfigOutputReference

---

annotationsInput^Optional

public readonly annotationsInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

displayNameInput^Optional

public readonly displayNameInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

locationInput^Optional

public readonly locationInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

networkConfigInput^Optional

public readonly networkConfigInput: CloudbuildWorkerPoolNetworkConfig;

• Type: CloudbuildWorkerPoolNetworkConfig

---

privateServiceConnectInput^Optional

public readonly privateServiceConnectInput: CloudbuildWorkerPoolPrivateServiceConnect;

• Type: CloudbuildWorkerPoolPrivateServiceConnect

---

projectInput^Optional

public readonly projectInput: string;

• Type: string

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | CloudbuildWorkerPoolTimeouts;

• Type: cdktf.IResolvable | CloudbuildWorkerPoolTimeouts

---

workerConfigInput^Optional

public readonly workerConfigInput: CloudbuildWorkerPoolWorkerConfig;

• Type: CloudbuildWorkerPoolWorkerConfig

---

annotations^Required

public readonly annotations: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

displayName^Required

public readonly displayName: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

location^Required

public readonly location: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

project^Required

public readonly project: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

CloudbuildWorkerPoolConfig

Initializer

import { cloudbuildWorkerPool } from '@cdktf/provider-google'

const cloudbuildWorkerPoolConfig: cloudbuildWorkerPool.CloudbuildWorkerPoolConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
location	string	The location for the resource.
name	string	User-defined name of the WorkerPool.
annotations	{[ key: string ]: string}	User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
displayName	string	A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#id CloudbuildWorkerPool#id}.
networkConfig	CloudbuildWorkerPoolNetworkConfig	network_config block.
privateServiceConnect	CloudbuildWorkerPoolPrivateServiceConnect	private_service_connect block.
project	string	The project for the resource.
timeouts	CloudbuildWorkerPoolTimeouts	timeouts block.
workerConfig	CloudbuildWorkerPoolWorkerConfig	worker_config block.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

location^Required

public readonly location: string;

• Type: string

The location for the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#location CloudbuildWorkerPool#location}

---

name^Required

public readonly name: string;

• Type: string

User-defined name of the WorkerPool.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#name CloudbuildWorkerPool#name}

---

annotations^Optional

public readonly annotations: {[ key: string ]: string};

• Type: {[ key: string ]: string}

User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

Note: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#annotations CloudbuildWorkerPool#annotations}

---

displayName^Optional

public readonly displayName: string;

• Type: string

A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#display_name CloudbuildWorkerPool#display_name}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#id CloudbuildWorkerPool#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

networkConfig^Optional

public readonly networkConfig: CloudbuildWorkerPoolNetworkConfig;

• Type: CloudbuildWorkerPoolNetworkConfig

network_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#network_config CloudbuildWorkerPool#network_config}

---

privateServiceConnect^Optional

public readonly privateServiceConnect: CloudbuildWorkerPoolPrivateServiceConnect;

• Type: CloudbuildWorkerPoolPrivateServiceConnect

private_service_connect block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#private_service_connect CloudbuildWorkerPool#private_service_connect}

---

project^Optional

public readonly project: string;

• Type: string

The project for the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#project CloudbuildWorkerPool#project}

---

timeouts^Optional

public readonly timeouts: CloudbuildWorkerPoolTimeouts;

• Type: CloudbuildWorkerPoolTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#timeouts CloudbuildWorkerPool#timeouts}

---

workerConfig^Optional

public readonly workerConfig: CloudbuildWorkerPoolWorkerConfig;

• Type: CloudbuildWorkerPoolWorkerConfig

worker_config block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#worker_config CloudbuildWorkerPool#worker_config}

---

CloudbuildWorkerPoolNetworkConfig

Initializer

import { cloudbuildWorkerPool } from '@cdktf/provider-google'

const cloudbuildWorkerPoolNetworkConfig: cloudbuildWorkerPool.CloudbuildWorkerPoolNetworkConfig = { ... }

Properties

Name	Type	Description
peeredNetwork	string	Required.
peeredNetworkIpRange	string	Optional.

---

peeredNetwork^Required

public readonly peeredNetwork: string;

• Type: string

Required.

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 service producer 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. See Understanding network configuration options

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#peered_network CloudbuildWorkerPool#peered_network}

---

peeredNetworkIpRange^Optional

public readonly peeredNetworkIpRange: string;

• Type: string

Optional.

Immutable. Subnet IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. 192.168.0.0/29 would specify an IP range starting at 192.168.0.0 with a prefix size of 29 bits. /16 would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of /24 will be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#peered_network_ip_range CloudbuildWorkerPool#peered_network_ip_range}

---

CloudbuildWorkerPoolPrivateServiceConnect

Initializer

import { cloudbuildWorkerPool } from '@cdktf/provider-google'

const cloudbuildWorkerPoolPrivateServiceConnect: cloudbuildWorkerPool.CloudbuildWorkerPoolPrivateServiceConnect = { ... }

Properties

Name	Type	Description
networkAttachment	string	Required.
routeAllTraffic	boolean | cdktf.IResolvable	Immutable.

---

networkAttachment^Required

public readonly networkAttachment: string;

• Type: string

Required.

Immutable. The network attachment that the worker network interface is connected to. Must be in the format projects/{project}/regions/{region}/networkAttachments/{networkAttachment}. The region of network attachment must be the same as the worker pool. See Network Attachments

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#network_attachment CloudbuildWorkerPool#network_attachment}

---

routeAllTraffic^Optional

public readonly routeAllTraffic: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Immutable.

Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route private IPs, e.g. 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 through PSC interface.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#route_all_traffic CloudbuildWorkerPool#route_all_traffic}

---

CloudbuildWorkerPoolTimeouts

Initializer

import { cloudbuildWorkerPool } from '@cdktf/provider-google'

const cloudbuildWorkerPoolTimeouts: cloudbuildWorkerPool.CloudbuildWorkerPoolTimeouts = { ... }

Properties

Name	Type	Description
create	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#create CloudbuildWorkerPool#create}.
delete	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#delete CloudbuildWorkerPool#delete}.
update	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#update CloudbuildWorkerPool#update}.

---

create^Optional

public readonly create: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#create CloudbuildWorkerPool#create}.

---

delete^Optional

public readonly delete: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#delete CloudbuildWorkerPool#delete}.

---

update^Optional

public readonly update: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#update CloudbuildWorkerPool#update}.

---

CloudbuildWorkerPoolWorkerConfig

Initializer

import { cloudbuildWorkerPool } from '@cdktf/provider-google'

const cloudbuildWorkerPoolWorkerConfig: cloudbuildWorkerPool.CloudbuildWorkerPoolWorkerConfig = { ... }

Properties

Name	Type	Description
diskSizeGb	number	Size of the disk attached to the worker, in GB.
machineType	string	Machine type of a worker, such as n1-standard-1.
noExternalIp	boolean | cdktf.IResolvable	If true, workers are created without any public address, which prevents network egress to public IPs.

---

diskSizeGb^Optional

public readonly diskSizeGb: number;

• Type: number

Size of the disk attached to the worker, in GB.

See Worker pool config file. Specify a value of up to 1000. If 0 is specified, Cloud Build will use a standard disk size.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#disk_size_gb CloudbuildWorkerPool#disk_size_gb}

---

machineType^Optional

public readonly machineType: string;

• Type: string

Machine type of a worker, such as n1-standard-1.

See Worker pool config file. If left blank, Cloud Build will use n1-standard-1.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#machine_type CloudbuildWorkerPool#machine_type}

---

noExternalIp^Optional

public readonly noExternalIp: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

If true, workers are created without any public address, which prevents network egress to public IPs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/cloudbuild_worker_pool#no_external_ip CloudbuildWorkerPool#no_external_ip}

---

Classes

CloudbuildWorkerPoolNetworkConfigOutputReference

Initializers

import { cloudbuildWorkerPool } from '@cdktf/provider-google'

new cloudbuildWorkerPool.CloudbuildWorkerPoolNetworkConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetPeeredNetworkIpRange	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetPeeredNetworkIpRange

public resetPeeredNetworkIpRange(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
peeredNetworkInput	string	No description.
peeredNetworkIpRangeInput	string	No description.
peeredNetwork	string	No description.
peeredNetworkIpRange	string	No description.
internalValue	CloudbuildWorkerPoolNetworkConfig	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

peeredNetworkInput^Optional

public readonly peeredNetworkInput: string;

• Type: string

---

peeredNetworkIpRangeInput^Optional

public readonly peeredNetworkIpRangeInput: string;

• Type: string

---

peeredNetwork^Required

public readonly peeredNetwork: string;

• Type: string

---

peeredNetworkIpRange^Required

public readonly peeredNetworkIpRange: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: CloudbuildWorkerPoolNetworkConfig;

• Type: CloudbuildWorkerPoolNetworkConfig

---

CloudbuildWorkerPoolPrivateServiceConnectOutputReference

Initializers

import { cloudbuildWorkerPool } from '@cdktf/provider-google'

new cloudbuildWorkerPool.CloudbuildWorkerPoolPrivateServiceConnectOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetRouteAllTraffic	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetRouteAllTraffic

public resetRouteAllTraffic(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
networkAttachmentInput	string	No description.
routeAllTrafficInput	boolean | cdktf.IResolvable	No description.
networkAttachment	string	No description.
routeAllTraffic	boolean | cdktf.IResolvable	No description.
internalValue	CloudbuildWorkerPoolPrivateServiceConnect	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

networkAttachmentInput^Optional

public readonly networkAttachmentInput: string;

• Type: string

---

routeAllTrafficInput^Optional

public readonly routeAllTrafficInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

networkAttachment^Required

public readonly networkAttachment: string;

• Type: string

---

routeAllTraffic^Required

public readonly routeAllTraffic: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

internalValue^Optional

public readonly internalValue: CloudbuildWorkerPoolPrivateServiceConnect;

• Type: CloudbuildWorkerPoolPrivateServiceConnect

---

CloudbuildWorkerPoolTimeoutsOutputReference

Initializers

import { cloudbuildWorkerPool } from '@cdktf/provider-google'

new cloudbuildWorkerPool.CloudbuildWorkerPoolTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetCreate	No description.
resetDelete	No description.
resetUpdate	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate

public resetCreate(): void

resetDelete

public resetDelete(): void

resetUpdate

public resetUpdate(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
createInput	string	No description.
deleteInput	string	No description.
updateInput	string	No description.
create	string	No description.
delete	string	No description.
update	string	No description.
internalValue	cdktf.IResolvable | CloudbuildWorkerPoolTimeouts	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

createInput^Optional

public readonly createInput: string;

• Type: string

---

deleteInput^Optional

public readonly deleteInput: string;

• Type: string

---

updateInput^Optional

public readonly updateInput: string;

• Type: string

---

create^Required

public readonly create: string;

• Type: string

---

delete^Required

public readonly delete: string;

• Type: string

---

update^Required

public readonly update: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | CloudbuildWorkerPoolTimeouts;

• Type: cdktf.IResolvable | CloudbuildWorkerPoolTimeouts

---

CloudbuildWorkerPoolWorkerConfigOutputReference

Initializers

import { cloudbuildWorkerPool } from '@cdktf/provider-google'

new cloudbuildWorkerPool.CloudbuildWorkerPoolWorkerConfigOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetDiskSizeGb	No description.
resetMachineType	No description.
resetNoExternalIp	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetDiskSizeGb

public resetDiskSizeGb(): void

resetMachineType

public resetMachineType(): void

resetNoExternalIp

public resetNoExternalIp(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
diskSizeGbInput	number	No description.
machineTypeInput	string	No description.
noExternalIpInput	boolean | cdktf.IResolvable	No description.
diskSizeGb	number	No description.
machineType	string	No description.
noExternalIp	boolean | cdktf.IResolvable	No description.
internalValue	CloudbuildWorkerPoolWorkerConfig	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

diskSizeGbInput^Optional

public readonly diskSizeGbInput: number;

• Type: number

---

machineTypeInput^Optional

public readonly machineTypeInput: string;

• Type: string

---

noExternalIpInput^Optional

public readonly noExternalIpInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

diskSizeGb^Required

public readonly diskSizeGb: number;

• Type: number

---

machineType^Required

public readonly machineType: string;

• Type: string

---

noExternalIp^Required

public readonly noExternalIp: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

internalValue^Optional

public readonly internalValue: CloudbuildWorkerPoolWorkerConfig;

• Type: CloudbuildWorkerPoolWorkerConfig

---