Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool google_compute_target_pool}.
import { googleComputeTargetPool } from '@cdktf/provider-google-beta'
new googleComputeTargetPool.GoogleComputeTargetPool(scope: Construct, id: string, config: GoogleComputeTargetPoolConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
GoogleComputeTargetPoolConfig |
No description. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
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". |
putTimeouts |
No description. |
resetBackupPool |
No description. |
resetDescription |
No description. |
resetFailoverRatio |
No description. |
resetHealthChecks |
No description. |
resetId |
No description. |
resetInstances |
No description. |
resetProject |
No description. |
resetRegion |
No description. |
resetSecurityPolicy |
No description. |
resetSessionAffinity |
No description. |
resetTimeouts |
No description. |
public toString(): string
Returns a string representation of this construct.
public addOverride(path: string, value: any): void
- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
public toHclTerraform(): any
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
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.
- Type: string
The string move target that will correspond to this resource.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
public importFrom(id: string, provider?: TerraformProvider): void
- Type: string
- Type: cdktf.TerraformProvider
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public moveTo(moveTarget: string, index?: string | number): void
Moves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: string | number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public moveToId(id: string): void
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public putTimeouts(value: GoogleComputeTargetPoolTimeouts): void
public resetBackupPool(): void
public resetDescription(): void
public resetFailoverRatio(): void
public resetHealthChecks(): void
public resetId(): void
public resetInstances(): void
public resetProject(): void
public resetRegion(): void
public resetSecurityPolicy(): void
public resetSessionAffinity(): void
public resetTimeouts(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a GoogleComputeTargetPool resource upon running "cdktf plan ". |
import { googleComputeTargetPool } from '@cdktf/provider-google-beta'
googleComputeTargetPool.GoogleComputeTargetPool.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.
- Type: any
Any object.
import { googleComputeTargetPool } from '@cdktf/provider-google-beta'
googleComputeTargetPool.GoogleComputeTargetPool.isTerraformElement(x: any)
- Type: any
import { googleComputeTargetPool } from '@cdktf/provider-google-beta'
googleComputeTargetPool.GoogleComputeTargetPool.isTerraformResource(x: any)
- Type: any
import { googleComputeTargetPool } from '@cdktf/provider-google-beta'
googleComputeTargetPool.GoogleComputeTargetPool.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a GoogleComputeTargetPool resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the GoogleComputeTargetPool to import.
- Type: string
The id of the existing GoogleComputeTargetPool that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the GoogleComputeTargetPool to import is found.
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. |
selfLink |
string |
No description. |
timeouts |
GoogleComputeTargetPoolTimeoutsOutputReference |
No description. |
backupPoolInput |
string |
No description. |
descriptionInput |
string |
No description. |
failoverRatioInput |
number |
No description. |
healthChecksInput |
string[] |
No description. |
idInput |
string |
No description. |
instancesInput |
string[] |
No description. |
nameInput |
string |
No description. |
projectInput |
string |
No description. |
regionInput |
string |
No description. |
securityPolicyInput |
string |
No description. |
sessionAffinityInput |
string |
No description. |
timeoutsInput |
cdktf.IResolvable | GoogleComputeTargetPoolTimeouts |
No description. |
backupPool |
string |
No description. |
description |
string |
No description. |
failoverRatio |
number |
No description. |
healthChecks |
string[] |
No description. |
id |
string |
No description. |
instances |
string[] |
No description. |
name |
string |
No description. |
project |
string |
No description. |
region |
string |
No description. |
securityPolicy |
string |
No description. |
sessionAffinity |
string |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;
- Type: cdktf.TerraformStack
public readonly fqn: string;
- Type: string
public readonly friendlyUniqueId: string;
- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];
- Type: string[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly selfLink: string;
- Type: string
public readonly timeouts: GoogleComputeTargetPoolTimeoutsOutputReference;
public readonly backupPoolInput: string;
- Type: string
public readonly descriptionInput: string;
- Type: string
public readonly failoverRatioInput: number;
- Type: number
public readonly healthChecksInput: string[];
- Type: string[]
public readonly idInput: string;
- Type: string
public readonly instancesInput: string[];
- Type: string[]
public readonly nameInput: string;
- Type: string
public readonly projectInput: string;
- Type: string
public readonly regionInput: string;
- Type: string
public readonly securityPolicyInput: string;
- Type: string
public readonly sessionAffinityInput: string;
- Type: string
public readonly timeoutsInput: IResolvable | GoogleComputeTargetPoolTimeouts;
- Type: cdktf.IResolvable | GoogleComputeTargetPoolTimeouts
public readonly backupPool: string;
- Type: string
public readonly description: string;
- Type: string
public readonly failoverRatio: number;
- Type: number
public readonly healthChecks: string[];
- Type: string[]
public readonly id: string;
- Type: string
public readonly instances: string[];
- Type: string[]
public readonly name: string;
- Type: string
public readonly project: string;
- Type: string
public readonly region: string;
- Type: string
public readonly securityPolicy: string;
- Type: string
public readonly sessionAffinity: string;
- Type: string
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { googleComputeTargetPool } from '@cdktf/provider-google-beta'
const googleComputeTargetPoolConfig: googleComputeTargetPool.GoogleComputeTargetPoolConfig = { ... }
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. |
name |
string |
A unique name for the resource, required by GCE. Changing this forces a new resource to be created. |
backupPool |
string |
URL to the backup target pool. Must also set failover_ratio. |
description |
string |
Textual description field. |
failoverRatio |
number |
Ratio (0 to 1) of failed nodes before using the backup pool (which must also be set). |
healthChecks |
string[] |
List of zero or one health check name or self_link. Only legacy google_compute_http_health_check is supported. |
id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#id GoogleComputeTargetPool#id}. |
instances |
string[] |
List of instances in the pool. |
project |
string |
The ID of the project in which the resource belongs. |
region |
string |
Where the target pool resides. Defaults to project region. |
securityPolicy |
string |
The resource URL for the security policy associated with this target pool. |
sessionAffinity |
string |
How to distribute load. |
timeouts |
GoogleComputeTargetPoolTimeouts |
timeouts block. |
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];
- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly name: string;
- Type: string
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#name GoogleComputeTargetPool#name}
public readonly backupPool: string;
- Type: string
URL to the backup target pool. Must also set failover_ratio.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#backup_pool GoogleComputeTargetPool#backup_pool}
public readonly description: string;
- Type: string
Textual description field.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#description GoogleComputeTargetPool#description}
public readonly failoverRatio: number;
- Type: number
Ratio (0 to 1) of failed nodes before using the backup pool (which must also be set).
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#failover_ratio GoogleComputeTargetPool#failover_ratio}
public readonly healthChecks: string[];
- Type: string[]
List of zero or one health check name or self_link. Only legacy google_compute_http_health_check is supported.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#health_checks GoogleComputeTargetPool#health_checks}
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#id GoogleComputeTargetPool#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.
public readonly instances: string[];
- Type: string[]
List of instances in the pool.
They can be given as URLs, or in the form of "zone/name". Note that the instances need not exist at the time of target pool creation, so there is no need to use the Terraform interpolators to create a dependency on the instances from the target pool.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#instances GoogleComputeTargetPool#instances}
public readonly project: string;
- Type: string
The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#project GoogleComputeTargetPool#project}
public readonly region: string;
- Type: string
Where the target pool resides. Defaults to project region.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#region GoogleComputeTargetPool#region}
public readonly securityPolicy: string;
- Type: string
The resource URL for the security policy associated with this target pool.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#security_policy GoogleComputeTargetPool#security_policy}
public readonly sessionAffinity: string;
- Type: string
How to distribute load.
Options are "NONE" (no affinity). "CLIENT_IP" (hash of the source/dest addresses / ports), and "CLIENT_IP_PROTO" also includes the protocol (default "NONE").
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#session_affinity GoogleComputeTargetPool#session_affinity}
public readonly timeouts: GoogleComputeTargetPoolTimeouts;
timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#timeouts GoogleComputeTargetPool#timeouts}
import { googleComputeTargetPool } from '@cdktf/provider-google-beta'
const googleComputeTargetPoolTimeouts: googleComputeTargetPool.GoogleComputeTargetPoolTimeouts = { ... }
Name | Type | Description |
---|---|---|
create |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#create GoogleComputeTargetPool#create}. |
delete |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#delete GoogleComputeTargetPool#delete}. |
update |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#update GoogleComputeTargetPool#update}. |
public readonly create: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#create GoogleComputeTargetPool#create}.
public readonly delete: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#delete GoogleComputeTargetPool#delete}.
public readonly update: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_compute_target_pool#update GoogleComputeTargetPool#update}.
import { googleComputeTargetPool } from '@cdktf/provider-google-beta'
new googleComputeTargetPool.GoogleComputeTargetPoolTimeoutsOutputReference(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. |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
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. |
public computeFqn(): string
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(property: string): IResolvable
- Type: string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
public resetCreate(): void
public resetDelete(): void
public resetUpdate(): void
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 | GoogleComputeTargetPoolTimeouts |
No description. |
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.
public readonly fqn: string;
- Type: string
public readonly createInput: string;
- Type: string
public readonly deleteInput: string;
- Type: string
public readonly updateInput: string;
- Type: string
public readonly create: string;
- Type: string
public readonly delete: string;
- Type: string
public readonly update: string;
- Type: string
public readonly internalValue: IResolvable | GoogleComputeTargetPoolTimeouts;
- Type: cdktf.IResolvable | GoogleComputeTargetPoolTimeouts