dataHcpAwsNetworkPeering.csharp.md

dataHcpAwsNetworkPeering Submodule

Constructs

DataHcpAwsNetworkPeering

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

Initializers

using HashiCorp.Cdktf.Providers.Hcp;

new DataHcpAwsNetworkPeering(Construct Scope, string Id, DataHcpAwsNetworkPeeringConfig Config);

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

private string ToString()

Returns a string representation of this construct.

AddOverride

private void AddOverride(string Path, object Value)

Path^Required

• Type: string

---

Value^Required

• Type: object

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

private void ResetOverrideLogicalId()

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

ToHclTerraform

private object ToHclTerraform()

Adds this resource to the terraform JSON output.

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

GetAnyMapAttribute

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

PutTimeouts

private void PutTimeouts(DataHcpAwsNetworkPeeringTimeouts Value)

Value^Required

• Type: DataHcpAwsNetworkPeeringTimeouts

---

ResetId

private void ResetId()

ResetProjectId

private void ResetProjectId()

ResetTimeouts

private void ResetTimeouts()

ResetWaitForActiveState

private void ResetWaitForActiveState()

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

using HashiCorp.Cdktf.Providers.Hcp;

DataHcpAwsNetworkPeering.IsConstruct(object X);

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

Any object.

---

IsTerraformElement

using HashiCorp.Cdktf.Providers.Hcp;

DataHcpAwsNetworkPeering.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformDataSource

using HashiCorp.Cdktf.Providers.Hcp;

DataHcpAwsNetworkPeering.IsTerraformDataSource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Hcp;

DataHcpAwsNetworkPeering.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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.101.0/docs/data-sources/aws_network_peering#import import section} in the documentation of this resource for the id to use

---

Provider^Optional

• Type: HashiCorp.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	HashiCorp.Cdktf.TerraformStack	No description.
Fqn	string	No description.
FriendlyUniqueId	string	No description.
TerraformMetaArguments	System.Collections.Generic.IDictionary<string, object>	No description.
TerraformResourceType	string	No description.
TerraformGeneratorMetadata	HashiCorp.Cdktf.TerraformProviderGeneratorMetadata	No description.
Count	object	No description.
DependsOn	string[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.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	object	No description.
WaitForActiveStateInput	object	No description.
HvnId	string	No description.
Id	string	No description.
PeeringId	string	No description.
ProjectId	string	No description.
WaitForActiveState	object	No description.

---

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: HashiCorp.Cdktf.TerraformStack

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

FriendlyUniqueId^Required

public string FriendlyUniqueId { get; }

• Type: string

---

TerraformMetaArguments^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

• Type: System.Collections.Generic.IDictionary<string, object>

---

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

---

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

---

Count^Optional

public object Count { get; }

• Type: object

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

CreatedAt^Required

public string CreatedAt { get; }

• Type: string

---

ExpiresAt^Required

public string ExpiresAt { get; }

• Type: string

---

OrganizationId^Required

public string OrganizationId { get; }

• Type: string

---

PeerAccountId^Required

public string PeerAccountId { get; }

• Type: string

---

PeerVpcId^Required

public string PeerVpcId { get; }

• Type: string

---

PeerVpcRegion^Required

public string PeerVpcRegion { get; }

• Type: string

---

ProviderPeeringId^Required

public string ProviderPeeringId { get; }

• Type: string

---

SelfLink^Required

public string SelfLink { get; }

• Type: string

---

State^Required

public string State { get; }

• Type: string

---

Timeouts^Required

public DataHcpAwsNetworkPeeringTimeoutsOutputReference Timeouts { get; }

• Type: DataHcpAwsNetworkPeeringTimeoutsOutputReference

---

HvnIdInput^Optional

public string HvnIdInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

PeeringIdInput^Optional

public string PeeringIdInput { get; }

• Type: string

---

ProjectIdInput^Optional

public string ProjectIdInput { get; }

• Type: string

---

TimeoutsInput^Optional

public object TimeoutsInput { get; }

• Type: object

---

WaitForActiveStateInput^Optional

public object WaitForActiveStateInput { get; }

• Type: object

---

HvnId^Required

public string HvnId { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

PeeringId^Required

public string PeeringId { get; }

• Type: string

---

ProjectId^Required

public string ProjectId { get; }

• Type: string

---

WaitForActiveState^Required

public object WaitForActiveState { get; }

• Type: object

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

DataHcpAwsNetworkPeeringConfig

Initializer

using HashiCorp.Cdktf.Providers.Hcp;

new DataHcpAwsNetworkPeeringConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string HvnId,
    string PeeringId,
    string Id = null,
    string ProjectId = null,
    DataHcpAwsNetworkPeeringTimeouts Timeouts = null,
    object WaitForActiveState = null
};

Properties

Name	Type	Description
Connection	object	No description.
Count	object	No description.
DependsOn	HashiCorp.Cdktf.ITerraformDependable[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	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.101.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	object	If true, Terraform will wait for the network peering to reach an ACTIVE state before continuing. Default false.

---

Connection^Optional

public object Connection { get; set; }

• Type: object

---

Count^Optional

public object Count { get; set; }

• Type: object

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: HashiCorp.Cdktf.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; set; }

• Type: object[]

---

HvnId^Required

public string HvnId { get; set; }

• Type: string

The ID of the HashiCorp Virtual Network (HVN).

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

---

PeeringId^Required

public string PeeringId { get; set; }

• Type: string

The ID of the network peering.

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

---

Id^Optional

public string Id { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcp/0.101.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 string ProjectId { get; set; }

• 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.101.0/docs/data-sources/aws_network_peering#project_id DataHcpAwsNetworkPeering#project_id}

---

Timeouts^Optional

public DataHcpAwsNetworkPeeringTimeouts Timeouts { get; set; }

• Type: DataHcpAwsNetworkPeeringTimeouts

timeouts block.

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

---

WaitForActiveState^Optional

public object WaitForActiveState { get; set; }

• Type: object

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.101.0/docs/data-sources/aws_network_peering#wait_for_active_state DataHcpAwsNetworkPeering#wait_for_active_state}

---

DataHcpAwsNetworkPeeringTimeouts

Initializer

using HashiCorp.Cdktf.Providers.Hcp;

new DataHcpAwsNetworkPeeringTimeouts {
    string Read = null
};

Properties

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

---

Read^Optional

public string Read { get; set; }

• Type: string

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

---

Classes

DataHcpAwsNetworkPeeringTimeoutsOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Hcp;

new DataHcpAwsNetworkPeeringTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);

Name	Type	Description
TerraformResource	HashiCorp.Cdktf.IInterpolatingParent	The parent resource.
TerraformAttribute	string	The attribute on the parent resource this class is referencing.

---

TerraformResource^Required

• Type: HashiCorp.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

private string ComputeFqn()

GetAnyMapAttribute

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string Property)

Property^Required

• Type: string

---

Resolve

private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

Context^Required

• Type: HashiCorp.Cdktf.IResolveContext

---

ToString

private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetRead

private void ResetRead()

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	object	No description.

---

CreationStack^Required

public string[] CreationStack { get; }

• 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 string Fqn { get; }

• Type: string

---

ReadInput^Optional

public string ReadInput { get; }

• Type: string

---

Read^Required

public string Read { get; }

• Type: string

---

InternalValue^Optional

public object InternalValue { get; }

• Type: object

---