`iamProjectsPolicyBinding` Submodule

Constructs

IamProjectsPolicyBinding

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding google_iam_projects_policy_binding}.

Initializers

import { iamProjectsPolicyBinding } from '@cdktn/provider-google'

new iamProjectsPolicyBinding.IamProjectsPolicyBinding(scope: Construct, id: string, config: IamProjectsPolicyBindingConfig)

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

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to 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".
`putCondition`	No description.
`putTarget`	No description.
`putTimeouts`	No description.
`resetAnnotations`	No description.
`resetCondition`	No description.
`resetDeletionPolicy`	No description.
`resetDisplayName`	No description.
`resetId`	No description.
`resetPolicyKind`	No description.
`resetProject`	No description.
`resetTimeouts`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`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: cdktn.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".

`putCondition`

public putCondition(value: IamProjectsPolicyBindingCondition): void

`value`^Required

Type: IamProjectsPolicyBindingCondition

`putTarget`

public putTarget(value: IamProjectsPolicyBindingTarget): void

`value`^Required

Type: IamProjectsPolicyBindingTarget

`putTimeouts`

public putTimeouts(value: IamProjectsPolicyBindingTimeouts): void

`value`^Required

Type: IamProjectsPolicyBindingTimeouts

`resetAnnotations`

public resetAnnotations(): void

`resetCondition`

public resetCondition(): void

`resetDeletionPolicy`

public resetDeletionPolicy(): void

`resetDisplayName`

public resetDisplayName(): void

`resetId`

public resetId(): void

`resetPolicyKind`

public resetPolicyKind(): void

`resetProject`

public resetProject(): void

`resetTimeouts`

public resetTimeouts(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTN code for importing a IamProjectsPolicyBinding resource upon running "cdktn plan ".

`isConstruct`

import { iamProjectsPolicyBinding } from '@cdktn/provider-google'

iamProjectsPolicyBinding.IamProjectsPolicyBinding.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 { iamProjectsPolicyBinding } from '@cdktn/provider-google'

iamProjectsPolicyBinding.IamProjectsPolicyBinding.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { iamProjectsPolicyBinding } from '@cdktn/provider-google'

iamProjectsPolicyBinding.IamProjectsPolicyBinding.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { iamProjectsPolicyBinding } from '@cdktn/provider-google'

iamProjectsPolicyBinding.IamProjectsPolicyBinding.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTN code for importing a IamProjectsPolicyBinding resource upon running "cdktn 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 IamProjectsPolicyBinding to import.

`importFromId`^Required

Type: string

The id of the existing IamProjectsPolicyBinding that should be imported.

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

`provider`^Optional

Type: cdktn.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktn.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktn.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktn.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner[]`	No description.
`condition`	`IamProjectsPolicyBindingConditionOutputReference`	No description.
`createTime`	`string`	No description.
`effectiveAnnotations`	`cdktn.StringMap`	No description.
`etag`	`string`	No description.
`name`	`string`	No description.
`policyUid`	`string`	No description.
`target`	`IamProjectsPolicyBindingTargetOutputReference`	No description.
`timeouts`	`IamProjectsPolicyBindingTimeoutsOutputReference`	No description.
`uid`	`string`	No description.
`updateTime`	`string`	No description.
`annotationsInput`	`{[ key: string ]: string}`	No description.
`conditionInput`	`IamProjectsPolicyBindingCondition`	No description.
`deletionPolicyInput`	`string`	No description.
`displayNameInput`	`string`	No description.
`idInput`	`string`	No description.
`locationInput`	`string`	No description.
`policyBindingIdInput`	`string`	No description.
`policyInput`	`string`	No description.
`policyKindInput`	`string`	No description.
`projectInput`	`string`	No description.
`targetInput`	`IamProjectsPolicyBindingTarget`	No description.
`timeoutsInput`	`cdktn.IResolvable \| IamProjectsPolicyBindingTimeouts`	No description.
`annotations`	`{[ key: string ]: string}`	No description.
`deletionPolicy`	`string`	No description.
`displayName`	`string`	No description.
`id`	`string`	No description.
`location`	`string`	No description.
`policy`	`string`	No description.
`policyBindingId`	`string`	No description.
`policyKind`	`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: cdktn.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: cdktn.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktn.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktn.TerraformProvider

`provisioners`^Optional

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

Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

`condition`^Required

public readonly condition: IamProjectsPolicyBindingConditionOutputReference;

Type: IamProjectsPolicyBindingConditionOutputReference

`createTime`^Required

public readonly createTime: string;

Type: string

`effectiveAnnotations`^Required

public readonly effectiveAnnotations: StringMap;

Type: cdktn.StringMap

`etag`^Required

public readonly etag: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`policyUid`^Required

public readonly policyUid: string;

Type: string

`target`^Required

public readonly target: IamProjectsPolicyBindingTargetOutputReference;

Type: IamProjectsPolicyBindingTargetOutputReference

`timeouts`^Required

public readonly timeouts: IamProjectsPolicyBindingTimeoutsOutputReference;

Type: IamProjectsPolicyBindingTimeoutsOutputReference

`uid`^Required

public readonly uid: string;

Type: string

`updateTime`^Required

public readonly updateTime: string;

Type: string

`annotationsInput`^Optional

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

Type: {[ key: string ]: string}

`conditionInput`^Optional

public readonly conditionInput: IamProjectsPolicyBindingCondition;

Type: IamProjectsPolicyBindingCondition

`deletionPolicyInput`^Optional

public readonly deletionPolicyInput: string;

Type: 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

`policyBindingIdInput`^Optional

public readonly policyBindingIdInput: string;

Type: string

`policyInput`^Optional

public readonly policyInput: string;

Type: string

`policyKindInput`^Optional

public readonly policyKindInput: string;

Type: string

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`targetInput`^Optional

public readonly targetInput: IamProjectsPolicyBindingTarget;

Type: IamProjectsPolicyBindingTarget

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | IamProjectsPolicyBindingTimeouts;

Type: cdktn.IResolvable | IamProjectsPolicyBindingTimeouts

`annotations`^Required

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

Type: {[ key: string ]: string}

`deletionPolicy`^Required

public readonly deletionPolicy: string;

Type: 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

`policy`^Required

public readonly policy: string;

Type: string

`policyBindingId`^Required

public readonly policyBindingId: string;

Type: string

`policyKind`^Required

public readonly policyKind: 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

IamProjectsPolicyBindingCondition

Initializer

import { iamProjectsPolicyBinding } from '@cdktn/provider-google'

const iamProjectsPolicyBindingCondition: iamProjectsPolicyBinding.IamProjectsPolicyBindingCondition = { ... }

Properties

Name	Type	Description
`description`	`string`	Optional.
`expression`	`string`	Textual representation of an expression in Common Expression Language syntax.
`location`	`string`	Optional.
`title`	`string`	Optional.

`description`^Optional

public readonly description: string;

Type: string

Optional.

Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#description IamProjectsPolicyBinding#description}

`expression`^Optional

public readonly expression: string;

Type: string

Textual representation of an expression in Common Expression Language syntax.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#expression IamProjectsPolicyBinding#expression}

`location`^Optional

public readonly location: string;

Type: string

Optional.

String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#location IamProjectsPolicyBinding#location}

`title`^Optional

public readonly title: string;

Type: string

Optional.

Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#title IamProjectsPolicyBinding#title}

IamProjectsPolicyBindingConfig

Initializer

import { iamProjectsPolicyBinding } from '@cdktn/provider-google'

const iamProjectsPolicyBindingConfig: iamProjectsPolicyBinding.IamProjectsPolicyBindingConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktn.TerraformCount`	No description.
`dependsOn`	`cdktn.ITerraformDependable[]`	No description.
`forEach`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner[]`	No description.
`location`	`string`	The location of the Policy Binding.
`policy`	`string`	Required.
`policyBindingId`	`string`	The Policy Binding ID.
`target`	`IamProjectsPolicyBindingTarget`	target block.
`annotations`	`{[ key: string ]: string}`	Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations.
`condition`	`IamProjectsPolicyBindingCondition`	condition block.
`deletionPolicy`	`string`	Whether Terraform will be prevented from destroying the instance.
`displayName`	`string`	Optional. The description of the policy binding. Must be less than or equal to 63 characters.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#id IamProjectsPolicyBinding#id}.
`policyKind`	`string`	Immutable.
`project`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#project IamProjectsPolicyBinding#project}.
`timeouts`	`IamProjectsPolicyBindingTimeouts`	timeouts block.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktn.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktn.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktn.TerraformProvider

`provisioners`^Optional

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

Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

`location`^Required

public readonly location: string;

Type: string

The location of the Policy Binding.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#location IamProjectsPolicyBinding#location}

`policy`^Required

public readonly policy: string;

Type: string

Required.

Immutable. The resource name of the policy to be bound. The binding parent and policy must belong to the same Organization (or Project).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#policy IamProjectsPolicyBinding#policy}

`policyBindingId`^Required

public readonly policyBindingId: string;

Type: string

The Policy Binding ID.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#policy_binding_id IamProjectsPolicyBinding#policy_binding_id}

`target`^Required

public readonly target: IamProjectsPolicyBindingTarget;

Type: IamProjectsPolicyBindingTarget

target block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#target IamProjectsPolicyBinding#target}

`annotations`^Optional

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

Type: {[ key: string ]: string}

Optional. User defined annotations. See https://google.aip.dev/148#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/7.40.0/docs/resources/iam_projects_policy_binding#annotations IamProjectsPolicyBinding#annotations}

`condition`^Optional

public readonly condition: IamProjectsPolicyBindingCondition;

Type: IamProjectsPolicyBindingCondition

condition block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#condition IamProjectsPolicyBinding#condition}

`deletionPolicy`^Optional

public readonly deletionPolicy: string;

Type: string

Whether Terraform will be prevented from destroying the instance.

Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#deletion_policy IamProjectsPolicyBinding#deletion_policy}

`displayName`^Optional

public readonly displayName: string;

Type: string

Optional. The description of the policy binding. Must be less than or equal to 63 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#display_name IamProjectsPolicyBinding#display_name}

`id`^Optional

public readonly id: string;

Type: string

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

`policyKind`^Optional

public readonly policyKind: string;

Type: string

Immutable.

The kind of the policy to attach in this binding. This field must be one of the following: - Left empty (will be automatically set to the policy kind) - The input policy kind Possible values: POLICY_KIND_UNSPECIFIED PRINCIPAL_ACCESS_BOUNDARY ACCESS

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#policy_kind IamProjectsPolicyBinding#policy_kind}

`project`^Optional

public readonly project: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#project IamProjectsPolicyBinding#project}.

`timeouts`^Optional

public readonly timeouts: IamProjectsPolicyBindingTimeouts;

Type: IamProjectsPolicyBindingTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#timeouts IamProjectsPolicyBinding#timeouts}

IamProjectsPolicyBindingTarget

Initializer

import { iamProjectsPolicyBinding } from '@cdktn/provider-google'

const iamProjectsPolicyBindingTarget: iamProjectsPolicyBinding.IamProjectsPolicyBindingTarget = { ... }

Properties

Name	Type	Description
`principalSet`	`string`	Required.

`principalSet`^Optional

public readonly principalSet: string;

Type: string

Required.

Immutable. Full Resource Name of the principal set used for principal access boundary policy bindings. Examples for each one of the following supported principal set types:

Project:
- '//cloudresourcemanager.googleapis.com/projects/PROJECT_NUMBER'
- '//cloudresourcemanager.googleapis.com/projects/PROJECT_ID'
Workload Identity Pool: '//iam.googleapis.com/projects/PROJECT_NUMBER/locations/LOCATION/workloadIdentityPools/WORKLOAD_POOL_ID' It must be parent by the policy binding's parent (the project).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#principal_set IamProjectsPolicyBinding#principal_set}

IamProjectsPolicyBindingTimeouts

Initializer

import { iamProjectsPolicyBinding } from '@cdktn/provider-google'

const iamProjectsPolicyBindingTimeouts: iamProjectsPolicyBinding.IamProjectsPolicyBindingTimeouts = { ... }

Properties

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

`create`^Optional

public readonly create: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#create IamProjectsPolicyBinding#create}.

`delete`^Optional

public readonly delete: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#delete IamProjectsPolicyBinding#delete}.

`update`^Optional

public readonly update: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/7.40.0/docs/resources/iam_projects_policy_binding#update IamProjectsPolicyBinding#update}.

Classes

IamProjectsPolicyBindingConditionOutputReference

Initializers

import { iamProjectsPolicyBinding } from '@cdktn/provider-google'

new iamProjectsPolicyBinding.IamProjectsPolicyBindingConditionOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

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

`terraformResource`^Required

Type: cdktn.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.
`resetDescription`	No description.
`resetExpression`	No description.
`resetLocation`	No description.
`resetTitle`	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: cdktn.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetDescription`

public resetDescription(): void

`resetExpression`

public resetExpression(): void

`resetLocation`

public resetLocation(): void

`resetTitle`

public resetTitle(): 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.
`descriptionInput`	`string`	No description.
`expressionInput`	`string`	No description.
`locationInput`	`string`	No description.
`titleInput`	`string`	No description.
`description`	`string`	No description.
`expression`	`string`	No description.
`location`	`string`	No description.
`title`	`string`	No description.
`internalValue`	`IamProjectsPolicyBindingCondition`	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

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`expressionInput`^Optional

public readonly expressionInput: string;

Type: string

`locationInput`^Optional

public readonly locationInput: string;

Type: string

`titleInput`^Optional

public readonly titleInput: string;

Type: string

`description`^Required

public readonly description: string;

Type: string

`expression`^Required

public readonly expression: string;

Type: string

`location`^Required

public readonly location: string;

Type: string

`title`^Required

public readonly title: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IamProjectsPolicyBindingCondition;

Type: IamProjectsPolicyBindingCondition

IamProjectsPolicyBindingTargetOutputReference

Initializers

import { iamProjectsPolicyBinding } from '@cdktn/provider-google'

new iamProjectsPolicyBinding.IamProjectsPolicyBindingTargetOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

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

`terraformResource`^Required

Type: cdktn.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.
`resetPrincipalSet`	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: cdktn.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetPrincipalSet`

public resetPrincipalSet(): 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.
`principalSetInput`	`string`	No description.
`principalSet`	`string`	No description.
`internalValue`	`IamProjectsPolicyBindingTarget`	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

`principalSetInput`^Optional

public readonly principalSetInput: string;

Type: string

`principalSet`^Required

public readonly principalSet: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IamProjectsPolicyBindingTarget;

Type: IamProjectsPolicyBindingTarget

IamProjectsPolicyBindingTimeoutsOutputReference

Initializers

import { iamProjectsPolicyBinding } from '@cdktn/provider-google'

new iamProjectsPolicyBinding.IamProjectsPolicyBindingTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

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

`terraformResource`^Required

Type: cdktn.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: cdktn.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`	`cdktn.IResolvable \| IamProjectsPolicyBindingTimeouts`	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 | IamProjectsPolicyBindingTimeouts;

Type: cdktn.IResolvable | IamProjectsPolicyBindingTimeouts

Uh oh!

FilesExpand file tree

iamProjectsPolicyBinding.typescript.md

Latest commit

History

iamProjectsPolicyBinding.typescript.md

File metadata and controls

iamProjectsPolicyBinding Submodule

Constructs