Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance google_compute_target_instance}.
import { googleComputeTargetInstance } from '@cdktn/provider-google-beta'
new googleComputeTargetInstance.GoogleComputeTargetInstance(scope: Construct, id: string, config: GoogleComputeTargetInstanceConfig)| Name | Type | Description |
|---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
GoogleComputeTargetInstanceConfig |
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. |
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". |
putTimeouts |
No description. |
resetDeletionPolicy |
No description. |
resetDescription |
No description. |
resetId |
No description. |
resetNatPolicy |
No description. |
resetNetwork |
No description. |
resetProject |
No description. |
resetSecurityPolicy |
No description. |
resetTimeouts |
No description. |
resetZone |
No description. |
public toString(): stringReturns a string representation of this construct.
public with(mixins: ...IMixin[]): IConstructApplies 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.
- Type: ...constructs.IMixin[]
The mixins to apply.
public addOverride(path: string, value: any): void- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): voidOverrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): voidResets a previously passed logical Id to use the auto-generated logical id again.
public toHclTerraform(): anypublic toMetadata(): anypublic toTerraform(): anyAdds this resource to the terraform JSON output.
public addMoveTarget(moveTarget: string): voidAdds 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 | TerraformResourceMoveByIdpublic importFrom(id: string, provider?: TerraformProvider): void- Type: string
- Type: cdktn.TerraformProvider
public interpolationForAttribute(terraformAttribute: string): IResolvable- Type: string
public moveFromId(id: string): voidMove 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): voidMoves 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): voidMoves 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: GoogleComputeTargetInstanceTimeouts): voidpublic resetDeletionPolicy(): voidpublic resetDescription(): voidpublic resetId(): voidpublic resetNatPolicy(): voidpublic resetNetwork(): voidpublic resetProject(): voidpublic resetSecurityPolicy(): voidpublic resetTimeouts(): voidpublic resetZone(): void| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTN code for importing a GoogleComputeTargetInstance resource upon running "cdktn plan ". |
import { googleComputeTargetInstance } from '@cdktn/provider-google-beta'
googleComputeTargetInstance.GoogleComputeTargetInstance.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 { googleComputeTargetInstance } from '@cdktn/provider-google-beta'
googleComputeTargetInstance.GoogleComputeTargetInstance.isTerraformElement(x: any)- Type: any
import { googleComputeTargetInstance } from '@cdktn/provider-google-beta'
googleComputeTargetInstance.GoogleComputeTargetInstance.isTerraformResource(x: any)- Type: any
import { googleComputeTargetInstance } from '@cdktn/provider-google-beta'
googleComputeTargetInstance.GoogleComputeTargetInstance.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)Generates CDKTN code for importing a GoogleComputeTargetInstance resource upon running "cdktn plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the GoogleComputeTargetInstance to import.
- Type: string
The id of the existing GoogleComputeTargetInstance that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#import import section} in the documentation of this resource for the id to use
- Type: cdktn.TerraformProvider
? Optional instance of the provider where the GoogleComputeTargetInstance to import is found.
| 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. |
creationTimestamp |
string |
No description. |
selfLink |
string |
No description. |
timeouts |
GoogleComputeTargetInstanceTimeoutsOutputReference |
No description. |
deletionPolicyInput |
string |
No description. |
descriptionInput |
string |
No description. |
idInput |
string |
No description. |
instanceInput |
string |
No description. |
nameInput |
string |
No description. |
natPolicyInput |
string |
No description. |
networkInput |
string |
No description. |
projectInput |
string |
No description. |
securityPolicyInput |
string |
No description. |
timeoutsInput |
cdktn.IResolvable | GoogleComputeTargetInstanceTimeouts |
No description. |
zoneInput |
string |
No description. |
deletionPolicy |
string |
No description. |
description |
string |
No description. |
id |
string |
No description. |
instance |
string |
No description. |
name |
string |
No description. |
natPolicy |
string |
No description. |
network |
string |
No description. |
project |
string |
No description. |
securityPolicy |
string |
No description. |
zone |
string |
No description. |
public readonly node: Node;- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;- Type: cdktn.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: cdktn.TerraformProviderGeneratorMetadata
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;- Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
public readonly count: number | TerraformCount;- Type: number | cdktn.TerraformCount
public readonly dependsOn: string[];- Type: string[]
public readonly forEach: ITerraformIterator;- Type: cdktn.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;- Type: cdktn.TerraformResourceLifecycle
public readonly provider: TerraformProvider;- Type: cdktn.TerraformProvider
public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];- Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]
public readonly creationTimestamp: string;- Type: string
public readonly selfLink: string;- Type: string
public readonly timeouts: GoogleComputeTargetInstanceTimeoutsOutputReference;public readonly deletionPolicyInput: string;- Type: string
public readonly descriptionInput: string;- Type: string
public readonly idInput: string;- Type: string
public readonly instanceInput: string;- Type: string
public readonly nameInput: string;- Type: string
public readonly natPolicyInput: string;- Type: string
public readonly networkInput: string;- Type: string
public readonly projectInput: string;- Type: string
public readonly securityPolicyInput: string;- Type: string
public readonly timeoutsInput: IResolvable | GoogleComputeTargetInstanceTimeouts;- Type: cdktn.IResolvable | GoogleComputeTargetInstanceTimeouts
public readonly zoneInput: string;- Type: string
public readonly deletionPolicy: string;- Type: string
public readonly description: string;- Type: string
public readonly id: string;- Type: string
public readonly instance: string;- Type: string
public readonly name: string;- Type: string
public readonly natPolicy: string;- Type: string
public readonly network: string;- Type: string
public readonly project: string;- Type: string
public readonly securityPolicy: string;- Type: string
public readonly zone: string;- Type: string
| Name | Type | Description |
|---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;- Type: string
import { googleComputeTargetInstance } from '@cdktn/provider-google-beta'
const googleComputeTargetInstanceConfig: googleComputeTargetInstance.GoogleComputeTargetInstanceConfig = { ... }| 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. |
instance |
string |
The Compute instance VM handling traffic for this target instance. |
name |
string |
Name of the resource. |
deletionPolicy |
string |
Whether Terraform will be prevented from destroying the instance. |
description |
string |
An optional description of this resource. |
id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#id GoogleComputeTargetInstance#id}. |
natPolicy |
string |
NAT option controlling how IPs are NAT'ed to the instance. |
network |
string |
The URL of the network this target instance uses to forward traffic. |
project |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#project GoogleComputeTargetInstance#project}. |
securityPolicy |
string |
The resource URL for the security policy associated with this target instance. |
timeouts |
GoogleComputeTargetInstanceTimeouts |
timeouts block. |
zone |
string |
URL of the zone where the target instance resides. |
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;- Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection
public readonly count: number | TerraformCount;- Type: number | cdktn.TerraformCount
public readonly dependsOn: ITerraformDependable[];- Type: cdktn.ITerraformDependable[]
public readonly forEach: ITerraformIterator;- Type: cdktn.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;- Type: cdktn.TerraformResourceLifecycle
public readonly provider: TerraformProvider;- Type: cdktn.TerraformProvider
public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];- Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]
public readonly instance: string;- Type: string
The Compute instance VM handling traffic for this target instance.
Accepts the instance self-link, relative path (e.g. 'projects/project/zones/zone/instances/instance') or name. If name is given, the zone will default to the given zone or the provider-default zone and the project will default to the provider-level project.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#instance GoogleComputeTargetInstance#instance}
public readonly name: string;- Type: string
Name of the resource.
Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#name GoogleComputeTargetInstance#name}
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-beta/7.36.0/docs/resources/google_compute_target_instance#deletion_policy GoogleComputeTargetInstance#deletion_policy}
public readonly description: string;- Type: string
An optional description of this resource.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#description GoogleComputeTargetInstance#description}
public readonly id: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#id GoogleComputeTargetInstance#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 natPolicy: string;- Type: string
NAT option controlling how IPs are NAT'ed to the instance.
Currently only NO_NAT (default value) is supported. Default value: "NO_NAT" Possible values: ["NO_NAT"]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#nat_policy GoogleComputeTargetInstance#nat_policy}
public readonly network: string;- Type: string
The URL of the network this target instance uses to forward traffic.
If not specified, the traffic will be forwarded to the network that the default network interface belongs to.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#network GoogleComputeTargetInstance#network}
public readonly project: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#project GoogleComputeTargetInstance#project}.
public readonly securityPolicy: string;- Type: string
The resource URL for the security policy associated with this target instance.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#security_policy GoogleComputeTargetInstance#security_policy}
public readonly timeouts: GoogleComputeTargetInstanceTimeouts;timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#timeouts GoogleComputeTargetInstance#timeouts}
public readonly zone: string;- Type: string
URL of the zone where the target instance resides.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#zone GoogleComputeTargetInstance#zone}
import { googleComputeTargetInstance } from '@cdktn/provider-google-beta'
const googleComputeTargetInstanceTimeouts: googleComputeTargetInstance.GoogleComputeTargetInstanceTimeouts = { ... }| Name | Type | Description |
|---|---|---|
create |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#create GoogleComputeTargetInstance#create}. |
delete |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#delete GoogleComputeTargetInstance#delete}. |
update |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#update GoogleComputeTargetInstance#update}. |
public readonly create: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#create GoogleComputeTargetInstance#create}.
public readonly delete: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#delete GoogleComputeTargetInstance#delete}.
public readonly update: string;- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.36.0/docs/resources/google_compute_target_instance#update GoogleComputeTargetInstance#update}.
import { googleComputeTargetInstance } from '@cdktn/provider-google-beta'
new googleComputeTargetInstance.GoogleComputeTargetInstanceTimeoutsOutputReference(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. |
- Type: cdktn.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(): stringpublic 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): anyProduce the Token's value at resolution time.
- Type: cdktn.IResolveContext
public toString(): stringReturn a string representation of this resolvable object.
Returns a reversible string representation.
public resetCreate(): voidpublic resetDelete(): voidpublic 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 |
cdktn.IResolvable | GoogleComputeTargetInstanceTimeouts |
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 | GoogleComputeTargetInstanceTimeouts;- Type: cdktn.IResolvable | GoogleComputeTargetInstanceTimeouts