`iamWorkforcePool` Submodule

Constructs

IamWorkforcePool

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

Initializers

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

new iamWorkforcePool.IamWorkforcePool(scope: Construct, id: string, config: IamWorkforcePoolConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`IamWorkforcePoolConfig`	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: IamWorkforcePoolConfig

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".
`putAccessRestrictions`	No description.
`putTimeouts`	No description.
`resetAccessRestrictions`	No description.
`resetDescription`	No description.
`resetDisabled`	No description.
`resetDisplayName`	No description.
`resetId`	No description.
`resetSessionDuration`	No description.
`resetTimeouts`	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".

`putAccessRestrictions`

public putAccessRestrictions(value: IamWorkforcePoolAccessRestrictions): void

`value`^Required

Type: IamWorkforcePoolAccessRestrictions

`putTimeouts`

public putTimeouts(value: IamWorkforcePoolTimeouts): void

`value`^Required

Type: IamWorkforcePoolTimeouts

`resetAccessRestrictions`

public resetAccessRestrictions(): void

`resetDescription`

public resetDescription(): void

`resetDisabled`

public resetDisabled(): void

`resetDisplayName`

public resetDisplayName(): void

`resetId`

public resetId(): void

`resetSessionDuration`

public resetSessionDuration(): void

`resetTimeouts`

public resetTimeouts(): 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 IamWorkforcePool resource upon running "cdktf plan ".

`isConstruct`

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

iamWorkforcePool.IamWorkforcePool.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 { iamWorkforcePool } from '@cdktf/provider-google'

iamWorkforcePool.IamWorkforcePool.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

iamWorkforcePool.IamWorkforcePool.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

iamWorkforcePool.IamWorkforcePool.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a IamWorkforcePool 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 IamWorkforcePool to import.

`importFromId`^Required

Type: string

The id of the existing IamWorkforcePool that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/iam_workforce_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 IamWorkforcePool 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.
`accessRestrictions`	`IamWorkforcePoolAccessRestrictionsOutputReference`	No description.
`name`	`string`	No description.
`state`	`string`	No description.
`timeouts`	`IamWorkforcePoolTimeoutsOutputReference`	No description.
`accessRestrictionsInput`	`IamWorkforcePoolAccessRestrictions`	No description.
`descriptionInput`	`string`	No description.
`disabledInput`	`boolean \| cdktf.IResolvable`	No description.
`displayNameInput`	`string`	No description.
`idInput`	`string`	No description.
`locationInput`	`string`	No description.
`parentInput`	`string`	No description.
`sessionDurationInput`	`string`	No description.
`timeoutsInput`	`cdktf.IResolvable \| IamWorkforcePoolTimeouts`	No description.
`workforcePoolIdInput`	`string`	No description.
`description`	`string`	No description.
`disabled`	`boolean \| cdktf.IResolvable`	No description.
`displayName`	`string`	No description.
`id`	`string`	No description.
`location`	`string`	No description.
`parent`	`string`	No description.
`sessionDuration`	`string`	No description.
`workforcePoolId`	`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[]

`accessRestrictions`^Required

public readonly accessRestrictions: IamWorkforcePoolAccessRestrictionsOutputReference;

Type: IamWorkforcePoolAccessRestrictionsOutputReference

`name`^Required

public readonly name: string;

Type: string

`state`^Required

public readonly state: string;

Type: string

`timeouts`^Required

public readonly timeouts: IamWorkforcePoolTimeoutsOutputReference;

Type: IamWorkforcePoolTimeoutsOutputReference

`accessRestrictionsInput`^Optional

public readonly accessRestrictionsInput: IamWorkforcePoolAccessRestrictions;

Type: IamWorkforcePoolAccessRestrictions

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`disabledInput`^Optional

public readonly disabledInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`displayNameInput`^Optional

public readonly displayNameInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`locationInput`^Optional

public readonly locationInput: string;

Type: string

`parentInput`^Optional

public readonly parentInput: string;

Type: string

`sessionDurationInput`^Optional

public readonly sessionDurationInput: string;

Type: string

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | IamWorkforcePoolTimeouts;

Type: cdktf.IResolvable | IamWorkforcePoolTimeouts

`workforcePoolIdInput`^Optional

public readonly workforcePoolIdInput: string;

Type: string

`description`^Required

public readonly description: string;

Type: string

`disabled`^Required

public readonly disabled: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`displayName`^Required

public readonly displayName: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`location`^Required

public readonly location: string;

Type: string

`parent`^Required

public readonly parent: string;

Type: string

`sessionDuration`^Required

public readonly sessionDuration: string;

Type: string

`workforcePoolId`^Required

public readonly workforcePoolId: string;

Type: string

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

IamWorkforcePoolAccessRestrictions

Initializer

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

const iamWorkforcePoolAccessRestrictions: iamWorkforcePool.IamWorkforcePoolAccessRestrictions = { ... }

Properties

Name	Type	Description
`allowedServices`	`cdktf.IResolvable \| IamWorkforcePoolAccessRestrictionsAllowedServices[]`	allowed_services block.
`disableProgrammaticSignin`	`boolean \| cdktf.IResolvable`	Disable programmatic sign-in by disabling token issue via the Security Token API endpoint. See Security Token Service API.

`allowedServices`^Optional

public readonly allowedServices: IResolvable | IamWorkforcePoolAccessRestrictionsAllowedServices[];

Type: cdktf.IResolvable | IamWorkforcePoolAccessRestrictionsAllowedServices[]

allowed_services block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/iam_workforce_pool#allowed_services IamWorkforcePool#allowed_services}

`disableProgrammaticSignin`^Optional

public readonly disableProgrammaticSignin: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Disable programmatic sign-in by disabling token issue via the Security Token API endpoint. See Security Token Service API.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/iam_workforce_pool#disable_programmatic_signin IamWorkforcePool#disable_programmatic_signin}

IamWorkforcePoolAccessRestrictionsAllowedServices

Initializer

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

const iamWorkforcePoolAccessRestrictionsAllowedServices: iamWorkforcePool.IamWorkforcePoolAccessRestrictionsAllowedServices = { ... }

Properties

Name	Type	Description
`domain`	`string`	Domain name of the service. Example: console.cloud.google.

`domain`^Optional

public readonly domain: string;

Type: string

Domain name of the service. Example: console.cloud.google.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/iam_workforce_pool#domain IamWorkforcePool#domain}

IamWorkforcePoolConfig

Initializer

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

const iamWorkforcePoolConfig: iamWorkforcePool.IamWorkforcePoolConfig = { ... }

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.
`parent`	`string`	Immutable. The resource name of the parent. Format: 'organizations/{org-id}'.
`workforcePoolId`	`string`	The name of the pool.
`accessRestrictions`	`IamWorkforcePoolAccessRestrictions`	access_restrictions block.
`description`	`string`	A user-specified description of the pool. Cannot exceed 256 characters.
`disabled`	`boolean \| cdktf.IResolvable`	Whether the pool is disabled.
`displayName`	`string`	A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/iam_workforce_pool#id IamWorkforcePool#id}.
`sessionDuration`	`string`	Duration that the Google Cloud access tokens, console sign-in sessions, and 'gcloud' sign-in sessions from this pool are valid.
`timeouts`	`IamWorkforcePoolTimeouts`	timeouts 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/iam_workforce_pool#location IamWorkforcePool#location}

`parent`^Required

public readonly parent: string;

Type: string

Immutable. The resource name of the parent. Format: 'organizations/{org-id}'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/iam_workforce_pool#parent IamWorkforcePool#parent}

`workforcePoolId`^Required

public readonly workforcePoolId: string;

Type: string

The name of the pool.

The ID must be a globally unique string of 6 to 63 lowercase letters, digits, or hyphens. It must start with a letter, and cannot have a trailing hyphen. The prefix 'gcp-' is reserved for use by Google, and may not be specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/iam_workforce_pool#workforce_pool_id IamWorkforcePool#workforce_pool_id}

`accessRestrictions`^Optional

public readonly accessRestrictions: IamWorkforcePoolAccessRestrictions;

Type: IamWorkforcePoolAccessRestrictions

access_restrictions block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/iam_workforce_pool#access_restrictions IamWorkforcePool#access_restrictions}

`description`^Optional

public readonly description: string;

Type: string

A user-specified description of the pool. Cannot exceed 256 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/iam_workforce_pool#description IamWorkforcePool#description}

`disabled`^Optional

public readonly disabled: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Whether the pool is disabled.

You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/iam_workforce_pool#disabled IamWorkforcePool#disabled}

`displayName`^Optional

public readonly displayName: string;

Type: string

A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/iam_workforce_pool#display_name IamWorkforcePool#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/iam_workforce_pool#id IamWorkforcePool#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.

`sessionDuration`^Optional

public readonly sessionDuration: string;

Type: string

Duration that the Google Cloud access tokens, console sign-in sessions, and 'gcloud' sign-in sessions from this pool are valid.

Must be greater than 15 minutes (900s) and less than 12 hours (43200s). If 'sessionDuration' is not configured, minted credentials have a default duration of one hour (3600s). A duration in seconds with up to nine fractional digits, ending with ''s''. Example: "'3.5s'".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/iam_workforce_pool#session_duration IamWorkforcePool#session_duration}

`timeouts`^Optional

public readonly timeouts: IamWorkforcePoolTimeouts;

Type: IamWorkforcePoolTimeouts

timeouts block.

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

IamWorkforcePoolTimeouts

Initializer

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

const iamWorkforcePoolTimeouts: iamWorkforcePool.IamWorkforcePoolTimeouts = { ... }

Properties

Name	Type	Description
`create`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/iam_workforce_pool#create IamWorkforcePool#create}.
`delete`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/iam_workforce_pool#delete IamWorkforcePool#delete}.
`update`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/iam_workforce_pool#update IamWorkforcePool#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/iam_workforce_pool#create IamWorkforcePool#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/iam_workforce_pool#delete IamWorkforcePool#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/iam_workforce_pool#update IamWorkforcePool#update}.

Classes

IamWorkforcePoolAccessRestrictionsAllowedServicesList

Initializers

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

new iamWorkforcePool.IamWorkforcePoolAccessRestrictionsAllowedServicesList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`wrapsSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name	Description
`allWithMapKey`	Creating an iterator for this complex list.
`computeFqn`	No description.
`resolve`	Produce the Token's value at resolution time.
`toString`	Return a string representation of this resolvable object.
`get`	No description.

`allWithMapKey`

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

`mapKeyAttributeName`^Required

Type: string

`computeFqn`

public computeFqn(): 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.

`get`

public get(index: number): IamWorkforcePoolAccessRestrictionsAllowedServicesOutputReference

`index`^Required

Type: number

the index of the item to return.

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.
`internalValue`	`cdktf.IResolvable \| IamWorkforcePoolAccessRestrictionsAllowedServices[]`	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

`internalValue`^Optional

public readonly internalValue: IResolvable | IamWorkforcePoolAccessRestrictionsAllowedServices[];

Type: cdktf.IResolvable | IamWorkforcePoolAccessRestrictionsAllowedServices[]

IamWorkforcePoolAccessRestrictionsAllowedServicesOutputReference

Initializers

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

new iamWorkforcePool.IamWorkforcePoolAccessRestrictionsAllowedServicesOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`complexObjectIndex`	`number`	the index of this item in the list.
`complexObjectIsFromSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: number

the index of this item in the list.

`complexObjectIsFromSet`^Required

Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

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.
`resetDomain`	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.

`resetDomain`

public resetDomain(): 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.
`domainInput`	`string`	No description.
`domain`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| IamWorkforcePoolAccessRestrictionsAllowedServices`	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

`domainInput`^Optional

public readonly domainInput: string;

Type: string

`domain`^Required

public readonly domain: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | IamWorkforcePoolAccessRestrictionsAllowedServices;

Type: cdktf.IResolvable | IamWorkforcePoolAccessRestrictionsAllowedServices

IamWorkforcePoolAccessRestrictionsOutputReference

Initializers

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

new iamWorkforcePool.IamWorkforcePoolAccessRestrictionsOutputReference(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.
`putAllowedServices`	No description.
`resetAllowedServices`	No description.
`resetDisableProgrammaticSignin`	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.

`putAllowedServices`

public putAllowedServices(value: IResolvable | IamWorkforcePoolAccessRestrictionsAllowedServices[]): void

`value`^Required

Type: cdktf.IResolvable | IamWorkforcePoolAccessRestrictionsAllowedServices[]

`resetAllowedServices`

public resetAllowedServices(): void

`resetDisableProgrammaticSignin`

public resetDisableProgrammaticSignin(): 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.
`allowedServices`	`IamWorkforcePoolAccessRestrictionsAllowedServicesList`	No description.
`allowedServicesInput`	`cdktf.IResolvable \| IamWorkforcePoolAccessRestrictionsAllowedServices[]`	No description.
`disableProgrammaticSigninInput`	`boolean \| cdktf.IResolvable`	No description.
`disableProgrammaticSignin`	`boolean \| cdktf.IResolvable`	No description.
`internalValue`	`IamWorkforcePoolAccessRestrictions`	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

`allowedServices`^Required

public readonly allowedServices: IamWorkforcePoolAccessRestrictionsAllowedServicesList;

Type: IamWorkforcePoolAccessRestrictionsAllowedServicesList

`allowedServicesInput`^Optional

public readonly allowedServicesInput: IResolvable | IamWorkforcePoolAccessRestrictionsAllowedServices[];

Type: cdktf.IResolvable | IamWorkforcePoolAccessRestrictionsAllowedServices[]

`disableProgrammaticSigninInput`^Optional

public readonly disableProgrammaticSigninInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`disableProgrammaticSignin`^Required

public readonly disableProgrammaticSignin: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`internalValue`^Optional

public readonly internalValue: IamWorkforcePoolAccessRestrictions;

Type: IamWorkforcePoolAccessRestrictions

IamWorkforcePoolTimeoutsOutputReference

Initializers

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

new iamWorkforcePool.IamWorkforcePoolTimeoutsOutputReference(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 \| IamWorkforcePoolTimeouts`	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 | IamWorkforcePoolTimeouts;

Type: cdktf.IResolvable | IamWorkforcePoolTimeouts

Files

iamWorkforcePool.typescript.md

Latest commit

History

iamWorkforcePool.typescript.md

File metadata and controls

iamWorkforcePool Submodule

Constructs