Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering google_compute_network_peering}.
import { computeNetworkPeering } from '@cdktf/provider-google'
new computeNetworkPeering.ComputeNetworkPeering(scope: Construct, id: string, config: ComputeNetworkPeeringConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
ComputeNetworkPeeringConfig |
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. |
resetExportCustomRoutes |
No description. |
resetExportSubnetRoutesWithPublicIp |
No description. |
resetId |
No description. |
resetImportCustomRoutes |
No description. |
resetImportSubnetRoutesWithPublicIp |
No description. |
resetStackType |
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: ComputeNetworkPeeringTimeouts): void
public resetExportCustomRoutes(): void
public resetExportSubnetRoutesWithPublicIp(): void
public resetId(): void
public resetImportCustomRoutes(): void
public resetImportSubnetRoutesWithPublicIp(): void
public resetStackType(): 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 ComputeNetworkPeering resource upon running "cdktf plan ". |
import { computeNetworkPeering } from '@cdktf/provider-google'
computeNetworkPeering.ComputeNetworkPeering.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 { computeNetworkPeering } from '@cdktf/provider-google'
computeNetworkPeering.ComputeNetworkPeering.isTerraformElement(x: any)
- Type: any
import { computeNetworkPeering } from '@cdktf/provider-google'
computeNetworkPeering.ComputeNetworkPeering.isTerraformResource(x: any)
- Type: any
import { computeNetworkPeering } from '@cdktf/provider-google'
computeNetworkPeering.ComputeNetworkPeering.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a ComputeNetworkPeering 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 ComputeNetworkPeering to import.
- Type: string
The id of the existing ComputeNetworkPeering that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the ComputeNetworkPeering 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. |
state |
string |
No description. |
stateDetails |
string |
No description. |
timeouts |
ComputeNetworkPeeringTimeoutsOutputReference |
No description. |
exportCustomRoutesInput |
boolean | cdktf.IResolvable |
No description. |
exportSubnetRoutesWithPublicIpInput |
boolean | cdktf.IResolvable |
No description. |
idInput |
string |
No description. |
importCustomRoutesInput |
boolean | cdktf.IResolvable |
No description. |
importSubnetRoutesWithPublicIpInput |
boolean | cdktf.IResolvable |
No description. |
nameInput |
string |
No description. |
networkInput |
string |
No description. |
peerNetworkInput |
string |
No description. |
stackTypeInput |
string |
No description. |
timeoutsInput |
cdktf.IResolvable | ComputeNetworkPeeringTimeouts |
No description. |
exportCustomRoutes |
boolean | cdktf.IResolvable |
No description. |
exportSubnetRoutesWithPublicIp |
boolean | cdktf.IResolvable |
No description. |
id |
string |
No description. |
importCustomRoutes |
boolean | cdktf.IResolvable |
No description. |
importSubnetRoutesWithPublicIp |
boolean | cdktf.IResolvable |
No description. |
name |
string |
No description. |
network |
string |
No description. |
peerNetwork |
string |
No description. |
stackType |
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 state: string;
- Type: string
public readonly stateDetails: string;
- Type: string
public readonly timeouts: ComputeNetworkPeeringTimeoutsOutputReference;
public readonly exportCustomRoutesInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly exportSubnetRoutesWithPublicIpInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly idInput: string;
- Type: string
public readonly importCustomRoutesInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly importSubnetRoutesWithPublicIpInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly nameInput: string;
- Type: string
public readonly networkInput: string;
- Type: string
public readonly peerNetworkInput: string;
- Type: string
public readonly stackTypeInput: string;
- Type: string
public readonly timeoutsInput: IResolvable | ComputeNetworkPeeringTimeouts;
- Type: cdktf.IResolvable | ComputeNetworkPeeringTimeouts
public readonly exportCustomRoutes: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly exportSubnetRoutesWithPublicIp: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly id: string;
- Type: string
public readonly importCustomRoutes: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly importSubnetRoutesWithPublicIp: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly name: string;
- Type: string
public readonly network: string;
- Type: string
public readonly peerNetwork: string;
- Type: string
public readonly stackType: string;
- Type: string
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { computeNetworkPeering } from '@cdktf/provider-google'
const computeNetworkPeeringConfig: computeNetworkPeering.ComputeNetworkPeeringConfig = { ... }
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 |
Name of the peering. |
network |
string |
The primary network of the peering. |
peerNetwork |
string |
The peer network in the peering. The peer network may belong to a different project. |
exportCustomRoutes |
boolean | cdktf.IResolvable |
Whether to export the custom routes to the peer network. Defaults to false. |
exportSubnetRoutesWithPublicIp |
boolean | cdktf.IResolvable |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#export_subnet_routes_with_public_ip ComputeNetworkPeering#export_subnet_routes_with_public_ip}. |
id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#id ComputeNetworkPeering#id}. |
importCustomRoutes |
boolean | cdktf.IResolvable |
Whether to export the custom routes from the peer network. Defaults to false. |
importSubnetRoutesWithPublicIp |
boolean | cdktf.IResolvable |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#import_subnet_routes_with_public_ip ComputeNetworkPeering#import_subnet_routes_with_public_ip}. |
stackType |
string |
Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. |
timeouts |
ComputeNetworkPeeringTimeouts |
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
Name of the peering.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#name ComputeNetworkPeering#name}
public readonly network: string;
- Type: string
The primary network of the peering.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#network ComputeNetworkPeering#network}
public readonly peerNetwork: string;
- Type: string
The peer network in the peering. The peer network may belong to a different project.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#peer_network ComputeNetworkPeering#peer_network}
public readonly exportCustomRoutes: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Whether to export the custom routes to the peer network. Defaults to false.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#export_custom_routes ComputeNetworkPeering#export_custom_routes}
public readonly exportSubnetRoutesWithPublicIp: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#export_subnet_routes_with_public_ip ComputeNetworkPeering#export_subnet_routes_with_public_ip}.
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#id ComputeNetworkPeering#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 importCustomRoutes: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Whether to export the custom routes from the peer network. Defaults to false.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#import_custom_routes ComputeNetworkPeering#import_custom_routes}
public readonly importSubnetRoutesWithPublicIp: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#import_subnet_routes_with_public_ip ComputeNetworkPeering#import_subnet_routes_with_public_ip}.
public readonly stackType: string;
- Type: string
Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks.
The default value is IPV4_ONLY. Possible values: ["IPV4_ONLY", "IPV4_IPV6"]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#stack_type ComputeNetworkPeering#stack_type}
public readonly timeouts: ComputeNetworkPeeringTimeouts;
timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#timeouts ComputeNetworkPeering#timeouts}
import { computeNetworkPeering } from '@cdktf/provider-google'
const computeNetworkPeeringTimeouts: computeNetworkPeering.ComputeNetworkPeeringTimeouts = { ... }
Name | Type | Description |
---|---|---|
create |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#create ComputeNetworkPeering#create}. |
delete |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#delete ComputeNetworkPeering#delete}. |
update |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#update ComputeNetworkPeering#update}. |
public readonly create: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#create ComputeNetworkPeering#create}.
public readonly delete: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#delete ComputeNetworkPeering#delete}.
public readonly update: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.17.0/docs/resources/compute_network_peering#update ComputeNetworkPeering#update}.
import { computeNetworkPeering } from '@cdktf/provider-google'
new computeNetworkPeering.ComputeNetworkPeeringTimeoutsOutputReference(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 | ComputeNetworkPeeringTimeouts |
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 | ComputeNetworkPeeringTimeouts;
- Type: cdktf.IResolvable | ComputeNetworkPeeringTimeouts