dataHcpAwsNetworkPeering.typescript.md

dataHcpAwsNetworkPeering Submodule

Constructs

DataHcpAwsNetworkPeering

Represents a {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/data-sources/aws_network_peering hcp_aws_network_peering}.

Initializers

import { dataHcpAwsNetworkPeering } from '@cdktf/provider-hcp'

new dataHcpAwsNetworkPeering.DataHcpAwsNetworkPeering(scope: Construct, id: string, config: DataHcpAwsNetworkPeeringConfig)

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

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform	Adds this resource to the terraform JSON output.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
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.
putTimeouts	No description.
resetId	No description.
resetProjectId	No description.
resetTimeouts	No description.
resetWaitForActiveState	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

Adds this resource to the terraform JSON output.

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

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(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

putTimeouts

public putTimeouts(value: DataHcpAwsNetworkPeeringTimeouts): void

value^Required

• Type: DataHcpAwsNetworkPeeringTimeouts

---

resetId

public resetId(): void

resetProjectId

public resetProjectId(): void

resetTimeouts

public resetTimeouts(): void

resetWaitForActiveState

public resetWaitForActiveState(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformDataSource	No description.
generateConfigForImport	Generates CDKTF code for importing a DataHcpAwsNetworkPeering resource upon running "cdktf plan ".

---

isConstruct

import { dataHcpAwsNetworkPeering } from '@cdktf/provider-hcp'

dataHcpAwsNetworkPeering.DataHcpAwsNetworkPeering.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 { dataHcpAwsNetworkPeering } from '@cdktf/provider-hcp'

dataHcpAwsNetworkPeering.DataHcpAwsNetworkPeering.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformDataSource

import { dataHcpAwsNetworkPeering } from '@cdktf/provider-hcp'

dataHcpAwsNetworkPeering.DataHcpAwsNetworkPeering.isTerraformDataSource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { dataHcpAwsNetworkPeering } from '@cdktf/provider-hcp'

dataHcpAwsNetworkPeering.DataHcpAwsNetworkPeering.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a DataHcpAwsNetworkPeering resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the DataHcpAwsNetworkPeering to import.

---

importFromId^Required

• Type: string

The id of the existing DataHcpAwsNetworkPeering that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/data-sources/aws_network_peering#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
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.
createdAt	string	No description.
expiresAt	string	No description.
organizationId	string	No description.
peerAccountId	string	No description.
peerVpcId	string	No description.
peerVpcRegion	string	No description.
providerPeeringId	string	No description.
selfLink	string	No description.
state	string	No description.
timeouts	DataHcpAwsNetworkPeeringTimeoutsOutputReference	No description.
hvnIdInput	string	No description.
idInput	string	No description.
peeringIdInput	string	No description.
projectIdInput	string	No description.
timeoutsInput	cdktf.IResolvable | DataHcpAwsNetworkPeeringTimeouts	No description.
waitForActiveStateInput	boolean | cdktf.IResolvable	No description.
hvnId	string	No description.
id	string	No description.
peeringId	string	No description.
projectId	string	No description.
waitForActiveState	boolean | cdktf.IResolvable	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

createdAt^Required

public readonly createdAt: string;

• Type: string

---

expiresAt^Required

public readonly expiresAt: string;

• Type: string

---

organizationId^Required

public readonly organizationId: string;

• Type: string

---

peerAccountId^Required

public readonly peerAccountId: string;

• Type: string

---

peerVpcId^Required

public readonly peerVpcId: string;

• Type: string

---

peerVpcRegion^Required

public readonly peerVpcRegion: string;

• Type: string

---

providerPeeringId^Required

public readonly providerPeeringId: string;

• Type: string

---

selfLink^Required

public readonly selfLink: string;

• Type: string

---

state^Required

public readonly state: string;

• Type: string

---

timeouts^Required

public readonly timeouts: DataHcpAwsNetworkPeeringTimeoutsOutputReference;

• Type: DataHcpAwsNetworkPeeringTimeoutsOutputReference

---

hvnIdInput^Optional

public readonly hvnIdInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

peeringIdInput^Optional

public readonly peeringIdInput: string;

• Type: string

---

projectIdInput^Optional

public readonly projectIdInput: string;

• Type: string

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | DataHcpAwsNetworkPeeringTimeouts;

• Type: cdktf.IResolvable | DataHcpAwsNetworkPeeringTimeouts

---

waitForActiveStateInput^Optional

public readonly waitForActiveStateInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

hvnId^Required

public readonly hvnId: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

peeringId^Required

public readonly peeringId: string;

• Type: string

---

projectId^Required

public readonly projectId: string;

• Type: string

---

waitForActiveState^Required

public readonly waitForActiveState: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

DataHcpAwsNetworkPeeringConfig

Initializer

import { dataHcpAwsNetworkPeering } from '@cdktf/provider-hcp'

const dataHcpAwsNetworkPeeringConfig: dataHcpAwsNetworkPeering.DataHcpAwsNetworkPeeringConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
hvnId	string	The ID of the HashiCorp Virtual Network (HVN).
peeringId	string	The ID of the network peering.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/data-sources/aws_network_peering#id DataHcpAwsNetworkPeering#id}.
projectId	string	The ID of the HCP project where the network peering is located.
timeouts	DataHcpAwsNetworkPeeringTimeouts	timeouts block.
waitForActiveState	boolean | cdktf.IResolvable	If true, Terraform will wait for the network peering to reach an ACTIVE state before continuing. Default false.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

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

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

hvnId^Required

public readonly hvnId: string;

• Type: string

The ID of the HashiCorp Virtual Network (HVN).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/data-sources/aws_network_peering#hvn_id DataHcpAwsNetworkPeering#hvn_id}

---

peeringId^Required

public readonly peeringId: string;

• Type: string

The ID of the network peering.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/data-sources/aws_network_peering#peering_id DataHcpAwsNetworkPeering#peering_id}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/data-sources/aws_network_peering#id DataHcpAwsNetworkPeering#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.

---

projectId^Optional

public readonly projectId: string;

• Type: string

The ID of the HCP project where the network peering is located.

Always matches the HVN's project. If not specified, the project specified in the HCP Provider config block will be used, if configured. If a project is not configured in the HCP Provider config block, the oldest project in the organization will be used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/data-sources/aws_network_peering#project_id DataHcpAwsNetworkPeering#project_id}

---

timeouts^Optional

public readonly timeouts: DataHcpAwsNetworkPeeringTimeouts;

• Type: DataHcpAwsNetworkPeeringTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/data-sources/aws_network_peering#timeouts DataHcpAwsNetworkPeering#timeouts}

---

waitForActiveState^Optional

public readonly waitForActiveState: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

If true, Terraform will wait for the network peering to reach an ACTIVE state before continuing. Default false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/data-sources/aws_network_peering#wait_for_active_state DataHcpAwsNetworkPeering#wait_for_active_state}

---

DataHcpAwsNetworkPeeringTimeouts

Initializer

import { dataHcpAwsNetworkPeering } from '@cdktf/provider-hcp'

const dataHcpAwsNetworkPeeringTimeouts: dataHcpAwsNetworkPeering.DataHcpAwsNetworkPeeringTimeouts = { ... }

Properties

Name	Type	Description
read	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/data-sources/aws_network_peering#read DataHcpAwsNetworkPeering#read}.

---

read^Optional

public readonly read: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.99.0/docs/data-sources/aws_network_peering#read DataHcpAwsNetworkPeering#read}.

---

Classes

DataHcpAwsNetworkPeeringTimeoutsOutputReference

Initializers

import { dataHcpAwsNetworkPeering } from '@cdktf/provider-hcp'

new dataHcpAwsNetworkPeering.DataHcpAwsNetworkPeeringTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

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

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetRead	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetRead

public resetRead(): 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.
readInput	string	No description.
read	string	No description.
internalValue	cdktf.IResolvable | DataHcpAwsNetworkPeeringTimeouts	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

---

readInput^Optional

public readonly readInput: string;

• Type: string

---

read^Required

public readonly read: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | DataHcpAwsNetworkPeeringTimeouts;

• Type: cdktf.IResolvable | DataHcpAwsNetworkPeeringTimeouts

---