`computeNetworkPeering` Submodule

Constructs

ComputeNetworkPeering

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering google_compute_network_peering}.

Initializers

from cdktf_cdktf_provider_google import compute_network_peering

computeNetworkPeering.ComputeNetworkPeering(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  network: str,
  peer_network: str,
  export_custom_routes: typing.Union[bool, IResolvable] = None,
  export_subnet_routes_with_public_ip: typing.Union[bool, IResolvable] = None,
  id: str = None,
  import_custom_routes: typing.Union[bool, IResolvable] = None,
  import_subnet_routes_with_public_ip: typing.Union[bool, IResolvable] = None,
  stack_type: str = None,
  timeouts: ComputeNetworkPeeringTimeouts = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`name`	`str`	Name of the peering.
`network`	`str`	The primary network of the peering.
`peer_network`	`str`	The peer network in the peering. The peer network may belong to a different project.
`export_custom_routes`	`typing.Union[bool, cdktf.IResolvable]`	Whether to export the custom routes to the peer network. Defaults to false.
`export_subnet_routes_with_public_ip`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#export_subnet_routes_with_public_ip ComputeNetworkPeering#export_subnet_routes_with_public_ip}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#id ComputeNetworkPeering#id}.
`import_custom_routes`	`typing.Union[bool, cdktf.IResolvable]`	Whether to export the custom routes from the peer network. Defaults to false.
`import_subnet_routes_with_public_ip`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#import_subnet_routes_with_public_ip ComputeNetworkPeering#import_subnet_routes_with_public_ip}.
`stack_type`	`str`	Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks.
`timeouts`	`ComputeNetworkPeeringTimeouts`	timeouts block.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: cdktf.TerraformProvider

`provisioners`^Optional

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`name`^Required

Type: str

Name of the peering.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#name ComputeNetworkPeering#name}

`network`^Required

Type: str

The primary network of the peering.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#network ComputeNetworkPeering#network}

`peer_network`^Required

Type: str

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.14.1/docs/resources/compute_network_peering#peer_network ComputeNetworkPeering#peer_network}

`export_custom_routes`^Optional

Type: typing.Union[bool, 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.14.1/docs/resources/compute_network_peering#export_custom_routes ComputeNetworkPeering#export_custom_routes}

`export_subnet_routes_with_public_ip`^Optional

Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#export_subnet_routes_with_public_ip ComputeNetworkPeering#export_subnet_routes_with_public_ip}.

`id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/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.

`import_custom_routes`^Optional

Type: typing.Union[bool, 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.14.1/docs/resources/compute_network_peering#import_custom_routes ComputeNetworkPeering#import_custom_routes}

`import_subnet_routes_with_public_ip`^Optional

Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#import_subnet_routes_with_public_ip ComputeNetworkPeering#import_subnet_routes_with_public_ip}.

`stack_type`^Optional

Type: str

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.14.1/docs/resources/compute_network_peering#stack_type ComputeNetworkPeering#stack_type}

`timeouts`^Optional

Type: ComputeNetworkPeeringTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#timeouts ComputeNetworkPeering#timeouts}

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`add_move_target`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`has_resource_move`	No description.
`import_from`	No description.
`interpolation_for_attribute`	No description.
`move_from_id`	Move the resource corresponding to "id" to this resource.
`move_to`	Moves this resource to the target resource given by moveTarget.
`move_to_id`	Moves this resource to the resource corresponding to "id".
`put_timeouts`	No description.
`reset_export_custom_routes`	No description.
`reset_export_subnet_routes_with_public_ip`	No description.
`reset_id`	No description.
`reset_import_custom_routes`	No description.
`reset_import_subnet_routes_with_public_ip`	No description.
`reset_stack_type`	No description.
`reset_timeouts`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

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

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

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

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`add_move_target`

def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`move_target`^Required

Type: str

The string move target that will correspond to this resource.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`has_resource_move`

def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`move_from_id`

def move_from_id(
  id: str
) -> None

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.

`id`^Required

Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`move_to`

def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

`move_target`^Required

Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`move_to_id`

def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`put_timeouts`

def put_timeouts(
  create: str = None,
  delete: str = None,
  update: str = None
) -> None

`create`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#create ComputeNetworkPeering#create}.

`delete`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#delete ComputeNetworkPeering#delete}.

`update`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#update ComputeNetworkPeering#update}.

`reset_export_custom_routes`

def reset_export_custom_routes() -> None

`reset_export_subnet_routes_with_public_ip`

def reset_export_subnet_routes_with_public_ip() -> None

`reset_id`

def reset_id() -> None

`reset_import_custom_routes`

def reset_import_custom_routes() -> None

`reset_import_subnet_routes_with_public_ip`

def reset_import_subnet_routes_with_public_ip() -> None

`reset_stack_type`

def reset_stack_type() -> None

`reset_timeouts`

def reset_timeouts() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_resource`	No description.
`generate_config_for_import`	Generates CDKTF code for importing a ComputeNetworkPeering resource upon running "cdktf plan ".

`is_construct`

from cdktf_cdktf_provider_google import compute_network_peering

computeNetworkPeering.ComputeNetworkPeering.is_construct(
  x: typing.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: typing.Any

Any object.

`is_terraform_element`

from cdktf_cdktf_provider_google import compute_network_peering

computeNetworkPeering.ComputeNetworkPeering.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktf_cdktf_provider_google import compute_network_peering

computeNetworkPeering.ComputeNetworkPeering.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_provider_google import compute_network_peering

computeNetworkPeering.ComputeNetworkPeering.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

The id of the existing ComputeNetworkPeering that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_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 ComputeNetworkPeering to import is found.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`cdktf.TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`terraform_meta_arguments`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`state`	`str`	No description.
`state_details`	`str`	No description.
`timeouts`	`ComputeNetworkPeeringTimeoutsOutputReference`	No description.
`export_custom_routes_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`export_subnet_routes_with_public_ip_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`id_input`	`str`	No description.
`import_custom_routes_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`import_subnet_routes_with_public_ip_input`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`name_input`	`str`	No description.
`network_input`	`str`	No description.
`peer_network_input`	`str`	No description.
`stack_type_input`	`str`	No description.
`timeouts_input`	`typing.Union[cdktf.IResolvable, ComputeNetworkPeeringTimeouts]`	No description.
`export_custom_routes`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`export_subnet_routes_with_public_ip`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`id`	`str`	No description.
`import_custom_routes`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`import_subnet_routes_with_public_ip`	`typing.Union[bool, cdktf.IResolvable]`	No description.
`name`	`str`	No description.
`network`	`str`	No description.
`peer_network`	`str`	No description.
`stack_type`	`str`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktf.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`state`^Required

state: str

Type: str

`state_details`^Required

state_details: str

Type: str

`timeouts`^Required

timeouts: ComputeNetworkPeeringTimeoutsOutputReference

Type: ComputeNetworkPeeringTimeoutsOutputReference

`export_custom_routes_input`^Optional

export_custom_routes_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`export_subnet_routes_with_public_ip_input`^Optional

export_subnet_routes_with_public_ip_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`id_input`^Optional

id_input: str

Type: str

`import_custom_routes_input`^Optional

import_custom_routes_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`import_subnet_routes_with_public_ip_input`^Optional

import_subnet_routes_with_public_ip_input: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`name_input`^Optional

name_input: str

Type: str

`network_input`^Optional

network_input: str

Type: str

`peer_network_input`^Optional

peer_network_input: str

Type: str

`stack_type_input`^Optional

stack_type_input: str

Type: str

`timeouts_input`^Optional

timeouts_input: typing.Union[IResolvable, ComputeNetworkPeeringTimeouts]

Type: typing.Union[cdktf.IResolvable, ComputeNetworkPeeringTimeouts]

`export_custom_routes`^Required

export_custom_routes: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`export_subnet_routes_with_public_ip`^Required

export_subnet_routes_with_public_ip: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`id`^Required

id: str

Type: str

`import_custom_routes`^Required

import_custom_routes: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`import_subnet_routes_with_public_ip`^Required

import_subnet_routes_with_public_ip: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

`name`^Required

name: str

Type: str

`network`^Required

network: str

Type: str

`peer_network`^Required

peer_network: str

Type: str

`stack_type`^Required

stack_type: str

Type: str

Constants

Name	Type	Description
`tfResourceType`	`str`	No description.

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

ComputeNetworkPeeringConfig

Initializer

from cdktf_cdktf_provider_google import compute_network_peering

computeNetworkPeering.ComputeNetworkPeeringConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  network: str,
  peer_network: str,
  export_custom_routes: typing.Union[bool, IResolvable] = None,
  export_subnet_routes_with_public_ip: typing.Union[bool, IResolvable] = None,
  id: str = None,
  import_custom_routes: typing.Union[bool, IResolvable] = None,
  import_subnet_routes_with_public_ip: typing.Union[bool, IResolvable] = None,
  stack_type: str = None,
  timeouts: ComputeNetworkPeeringTimeouts = None
)

Properties

Name	Type	Description
`connection`	`typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]`	No description.
`count`	`typing.Union[typing.Union[int, float], cdktf.TerraformCount]`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]`	No description.
`name`	`str`	Name of the peering.
`network`	`str`	The primary network of the peering.
`peer_network`	`str`	The peer network in the peering. The peer network may belong to a different project.
`export_custom_routes`	`typing.Union[bool, cdktf.IResolvable]`	Whether to export the custom routes to the peer network. Defaults to false.
`export_subnet_routes_with_public_ip`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#export_subnet_routes_with_public_ip ComputeNetworkPeering#export_subnet_routes_with_public_ip}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#id ComputeNetworkPeering#id}.
`import_custom_routes`	`typing.Union[bool, cdktf.IResolvable]`	Whether to export the custom routes from the peer network. Defaults to false.
`import_subnet_routes_with_public_ip`	`typing.Union[bool, cdktf.IResolvable]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#import_subnet_routes_with_public_ip ComputeNetworkPeering#import_subnet_routes_with_public_ip}.
`stack_type`	`str`	Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks.
`timeouts`	`ComputeNetworkPeeringTimeouts`	timeouts block.

`connection`^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

`count`^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

`name`^Required

name: str

Type: str

Name of the peering.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#name ComputeNetworkPeering#name}

`network`^Required

network: str

Type: str

The primary network of the peering.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#network ComputeNetworkPeering#network}

`peer_network`^Required

peer_network: str

Type: str

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.14.1/docs/resources/compute_network_peering#peer_network ComputeNetworkPeering#peer_network}

`export_custom_routes`^Optional

export_custom_routes: typing.Union[bool, IResolvable]

Type: typing.Union[bool, 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.14.1/docs/resources/compute_network_peering#export_custom_routes ComputeNetworkPeering#export_custom_routes}

`export_subnet_routes_with_public_ip`^Optional

export_subnet_routes_with_public_ip: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#export_subnet_routes_with_public_ip ComputeNetworkPeering#export_subnet_routes_with_public_ip}.

`id`^Optional

id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/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.

`import_custom_routes`^Optional

import_custom_routes: typing.Union[bool, IResolvable]

Type: typing.Union[bool, 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.14.1/docs/resources/compute_network_peering#import_custom_routes ComputeNetworkPeering#import_custom_routes}

`import_subnet_routes_with_public_ip`^Optional

import_subnet_routes_with_public_ip: typing.Union[bool, IResolvable]

Type: typing.Union[bool, cdktf.IResolvable]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#import_subnet_routes_with_public_ip ComputeNetworkPeering#import_subnet_routes_with_public_ip}.

`stack_type`^Optional

stack_type: str

Type: str

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.14.1/docs/resources/compute_network_peering#stack_type ComputeNetworkPeering#stack_type}

`timeouts`^Optional

timeouts: ComputeNetworkPeeringTimeouts

Type: ComputeNetworkPeeringTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#timeouts ComputeNetworkPeering#timeouts}

ComputeNetworkPeeringTimeouts

Initializer

from cdktf_cdktf_provider_google import compute_network_peering

computeNetworkPeering.ComputeNetworkPeeringTimeouts(
  create: str = None,
  delete: str = None,
  update: str = None
)

Properties

Name	Type	Description
`create`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#create ComputeNetworkPeering#create}.
`delete`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#delete ComputeNetworkPeering#delete}.
`update`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#update ComputeNetworkPeering#update}.

`create`^Optional

create: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#create ComputeNetworkPeering#create}.

`delete`^Optional

delete: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#delete ComputeNetworkPeering#delete}.

`update`^Optional

update: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_network_peering#update ComputeNetworkPeering#update}.

Classes

ComputeNetworkPeeringTimeoutsOutputReference

Initializers

from cdktf_cdktf_provider_google import compute_network_peering

computeNetworkPeering.ComputeNetworkPeeringTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
`terraform_resource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.

`terraform_resource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`compute_fqn`	No description.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`interpolation_for_attribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`to_string`	Return a string representation of this resolvable object.
`reset_create`	No description.
`reset_delete`	No description.
`reset_update`	No description.

`compute_fqn`

def compute_fqn() -> str

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`reset_create`

def reset_create() -> None

`reset_delete`

def reset_delete() -> None

`reset_update`

def reset_update() -> None

Properties

Name	Type	Description
`creation_stack`	`typing.List[str]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`str`	No description.
`create_input`	`str`	No description.
`delete_input`	`str`	No description.
`update_input`	`str`	No description.
`create`	`str`	No description.
`delete`	`str`	No description.
`update`	`str`	No description.
`internal_value`	`typing.Union[cdktf.IResolvable, ComputeNetworkPeeringTimeouts]`	No description.

`creation_stack`^Required

creation_stack: typing.List[str]

Type: typing.List[str]

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

fqn: str

Type: str

`create_input`^Optional

create_input: str

Type: str

`delete_input`^Optional

delete_input: str

Type: str

`update_input`^Optional

update_input: str

Type: str

`create`^Required

create: str

Type: str

`delete`^Required

delete: str

Type: str

`update`^Required

update: str

Type: str

`internal_value`^Optional

internal_value: typing.Union[IResolvable, ComputeNetworkPeeringTimeouts]

Type: typing.Union[cdktf.IResolvable, ComputeNetworkPeeringTimeouts]

Files

computeNetworkPeering.python.md

Latest commit

History

computeNetworkPeering.python.md

File metadata and controls

computeNetworkPeering Submodule

Constructs