Skip to content

Latest commit

 

History

History
2677 lines (1663 loc) · 146 KB

googleNetworkManagementConnectivityTest.typescript.md

File metadata and controls

2677 lines (1663 loc) · 146 KB

googleNetworkManagementConnectivityTest Submodule

Constructs

GoogleNetworkManagementConnectivityTest

Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test google_network_management_connectivity_test}.

Initializers

import { googleNetworkManagementConnectivityTest } from '@cdktf/provider-google-beta'

new googleNetworkManagementConnectivityTest.GoogleNetworkManagementConnectivityTest(scope: Construct, id: string, config: GoogleNetworkManagementConnectivityTestConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config GoogleNetworkManagementConnectivityTestConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

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 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".
putDestination No description.
putSource No description.
putTimeouts No description.
resetDescription No description.
resetId No description.
resetLabels No description.
resetProject No description.
resetProtocol No description.
resetRelatedProjects No description.
resetTimeouts No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • 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
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget
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.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.


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

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string

providerOptional
  • Type: cdktf.TerraformProvider

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

moveFromId
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.

idRequired
  • Type: string

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


moveTo
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

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


indexOptional
  • Type: string | number

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


moveToId
public moveToId(id: string): void

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

idRequired
  • Type: string

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


putDestination
public putDestination(value: GoogleNetworkManagementConnectivityTestDestination): void
valueRequired

putSource
public putSource(value: GoogleNetworkManagementConnectivityTestSource): void
valueRequired

putTimeouts
public putTimeouts(value: GoogleNetworkManagementConnectivityTestTimeouts): void
valueRequired

resetDescription
public resetDescription(): void
resetId
public resetId(): void
resetLabels
public resetLabels(): void
resetProject
public resetProject(): void
resetProtocol
public resetProtocol(): void
resetRelatedProjects
public resetRelatedProjects(): void
resetTimeouts
public resetTimeouts(): void

Static Functions

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

isConstruct
import { googleNetworkManagementConnectivityTest } from '@cdktf/provider-google-beta'

googleNetworkManagementConnectivityTest.GoogleNetworkManagementConnectivityTest.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.

xRequired
  • Type: any

Any object.


isTerraformElement
import { googleNetworkManagementConnectivityTest } from '@cdktf/provider-google-beta'

googleNetworkManagementConnectivityTest.GoogleNetworkManagementConnectivityTest.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { googleNetworkManagementConnectivityTest } from '@cdktf/provider-google-beta'

googleNetworkManagementConnectivityTest.GoogleNetworkManagementConnectivityTest.isTerraformResource(x: any)
xRequired
  • Type: any

generateConfigForImport
import { googleNetworkManagementConnectivityTest } from '@cdktf/provider-google-beta'

googleNetworkManagementConnectivityTest.GoogleNetworkManagementConnectivityTest.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


importToIdRequired
  • Type: string

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


importFromIdRequired
  • Type: string

The id of the existing GoogleNetworkManagementConnectivityTest that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the GoogleNetworkManagementConnectivityTest 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.
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.
destination GoogleNetworkManagementConnectivityTestDestinationOutputReference No description.
effectiveLabels cdktf.StringMap No description.
source GoogleNetworkManagementConnectivityTestSourceOutputReference No description.
terraformLabels cdktf.StringMap No description.
timeouts GoogleNetworkManagementConnectivityTestTimeoutsOutputReference No description.
descriptionInput string No description.
destinationInput GoogleNetworkManagementConnectivityTestDestination No description.
idInput string No description.
labelsInput {[ key: string ]: string} No description.
nameInput string No description.
projectInput string No description.
protocolInput string No description.
relatedProjectsInput string[] No description.
sourceInput GoogleNetworkManagementConnectivityTestSource No description.
timeoutsInput cdktf.IResolvable | GoogleNetworkManagementConnectivityTestTimeouts No description.
description string No description.
id string No description.
labels {[ key: string ]: string} No description.
name string No description.
project string No description.
protocol string No description.
relatedProjects string[] No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

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

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

destinationRequired
public readonly destination: GoogleNetworkManagementConnectivityTestDestinationOutputReference;

effectiveLabelsRequired
public readonly effectiveLabels: StringMap;
  • Type: cdktf.StringMap

sourceRequired
public readonly source: GoogleNetworkManagementConnectivityTestSourceOutputReference;

terraformLabelsRequired
public readonly terraformLabels: StringMap;
  • Type: cdktf.StringMap

timeoutsRequired
public readonly timeouts: GoogleNetworkManagementConnectivityTestTimeoutsOutputReference;

descriptionInputOptional
public readonly descriptionInput: string;
  • Type: string

destinationInputOptional
public readonly destinationInput: GoogleNetworkManagementConnectivityTestDestination;

idInputOptional
public readonly idInput: string;
  • Type: string

labelsInputOptional
public readonly labelsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

nameInputOptional
public readonly nameInput: string;
  • Type: string

projectInputOptional
public readonly projectInput: string;
  • Type: string

protocolInputOptional
public readonly protocolInput: string;
  • Type: string

relatedProjectsInputOptional
public readonly relatedProjectsInput: string[];
  • Type: string[]

sourceInputOptional
public readonly sourceInput: GoogleNetworkManagementConnectivityTestSource;

timeoutsInputOptional
public readonly timeoutsInput: IResolvable | GoogleNetworkManagementConnectivityTestTimeouts;

descriptionRequired
public readonly description: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

labelsRequired
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

nameRequired
public readonly name: string;
  • Type: string

projectRequired
public readonly project: string;
  • Type: string

protocolRequired
public readonly protocol: string;
  • Type: string

relatedProjectsRequired
public readonly relatedProjects: string[];
  • Type: string[]

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

GoogleNetworkManagementConnectivityTestConfig

Initializer

import { googleNetworkManagementConnectivityTest } from '@cdktf/provider-google-beta'

const googleNetworkManagementConnectivityTestConfig: googleNetworkManagementConnectivityTest.GoogleNetworkManagementConnectivityTestConfig = { ... }

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.
destination GoogleNetworkManagementConnectivityTestDestination destination block.
name string Unique name for the connectivity test.
source GoogleNetworkManagementConnectivityTestSource source block.
description string The user-supplied description of the Connectivity Test. Maximum of 512 characters.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#id GoogleNetworkManagementConnectivityTest#id}.
labels {[ key: string ]: string} Resource labels to represent user-provided metadata.
project string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#project GoogleNetworkManagementConnectivityTest#project}.
protocol string IP Protocol of the test. When not provided, "TCP" is assumed.
relatedProjects string[] Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.
timeouts GoogleNetworkManagementConnectivityTestTimeouts timeouts block.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

destinationRequired
public readonly destination: GoogleNetworkManagementConnectivityTestDestination;

destination block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#destination GoogleNetworkManagementConnectivityTest#destination}


nameRequired
public readonly name: string;
  • Type: string

Unique name for the connectivity test.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#name GoogleNetworkManagementConnectivityTest#name}


sourceRequired
public readonly source: GoogleNetworkManagementConnectivityTestSource;

source block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#source GoogleNetworkManagementConnectivityTest#source}


descriptionOptional
public readonly description: string;
  • Type: string

The user-supplied description of the Connectivity Test. Maximum of 512 characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#description GoogleNetworkManagementConnectivityTest#description}


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#id GoogleNetworkManagementConnectivityTest#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.


labelsOptional
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Resource labels to represent user-provided metadata.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#labels GoogleNetworkManagementConnectivityTest#labels}


projectOptional
public readonly project: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#project GoogleNetworkManagementConnectivityTest#project}.


protocolOptional
public readonly protocol: string;
  • Type: string

IP Protocol of the test. When not provided, "TCP" is assumed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#protocol GoogleNetworkManagementConnectivityTest#protocol}


relatedProjectsOptional
public readonly relatedProjects: string[];
  • Type: string[]

Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#related_projects GoogleNetworkManagementConnectivityTest#related_projects}


timeoutsOptional
public readonly timeouts: GoogleNetworkManagementConnectivityTestTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#timeouts GoogleNetworkManagementConnectivityTest#timeouts}


GoogleNetworkManagementConnectivityTestDestination

Initializer

import { googleNetworkManagementConnectivityTest } from '@cdktf/provider-google-beta'

const googleNetworkManagementConnectivityTestDestination: googleNetworkManagementConnectivityTest.GoogleNetworkManagementConnectivityTestDestination = { ... }

Properties

Name Type Description
instance string A Compute Engine instance URI.
ipAddress string The IP address of the endpoint, which can be an external or internal IP.
network string A Compute Engine network URI.
port number The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
projectId string Project ID where the endpoint is located.

instanceOptional
public readonly instance: string;
  • Type: string

A Compute Engine instance URI.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#instance GoogleNetworkManagementConnectivityTest#instance}


ipAddressOptional
public readonly ipAddress: string;
  • Type: string

The IP address of the endpoint, which can be an external or internal IP.

An IPv6 address is only allowed when the test's destination is a global load balancer VIP.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#ip_address GoogleNetworkManagementConnectivityTest#ip_address}


networkOptional
public readonly network: string;
  • Type: string

A Compute Engine network URI.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#network GoogleNetworkManagementConnectivityTest#network}


portOptional
public readonly port: number;
  • Type: number

The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#port GoogleNetworkManagementConnectivityTest#port}


projectIdOptional
public readonly projectId: string;
  • Type: string

Project ID where the endpoint is located.

The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID:

  1. Only the IP address is specified, and the IP address is within a GCP project. 2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#project_id GoogleNetworkManagementConnectivityTest#project_id}


GoogleNetworkManagementConnectivityTestSource

Initializer

import { googleNetworkManagementConnectivityTest } from '@cdktf/provider-google-beta'

const googleNetworkManagementConnectivityTestSource: googleNetworkManagementConnectivityTest.GoogleNetworkManagementConnectivityTestSource = { ... }

Properties

Name Type Description
instance string A Compute Engine instance URI.
ipAddress string The IP address of the endpoint, which can be an external or internal IP.
network string A Compute Engine network URI.
networkType string Type of the network where the endpoint is located. Possible values: ["GCP_NETWORK", "NON_GCP_NETWORK"].
port number The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.
projectId string Project ID where the endpoint is located.

instanceOptional
public readonly instance: string;
  • Type: string

A Compute Engine instance URI.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#instance GoogleNetworkManagementConnectivityTest#instance}


ipAddressOptional
public readonly ipAddress: string;
  • Type: string

The IP address of the endpoint, which can be an external or internal IP.

An IPv6 address is only allowed when the test's destination is a global load balancer VIP.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#ip_address GoogleNetworkManagementConnectivityTest#ip_address}


networkOptional
public readonly network: string;
  • Type: string

A Compute Engine network URI.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#network GoogleNetworkManagementConnectivityTest#network}


networkTypeOptional
public readonly networkType: string;
  • Type: string

Type of the network where the endpoint is located. Possible values: ["GCP_NETWORK", "NON_GCP_NETWORK"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#network_type GoogleNetworkManagementConnectivityTest#network_type}


portOptional
public readonly port: number;
  • Type: number

The IP protocol port of the endpoint. Only applicable when protocol is TCP or UDP.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#port GoogleNetworkManagementConnectivityTest#port}


projectIdOptional
public readonly projectId: string;
  • Type: string

Project ID where the endpoint is located.

The Project ID can be derived from the URI if you provide a VM instance or network URI. The following are two cases where you must provide the project ID:

  1. Only the IP address is specified, and the IP address is within a GCP project.
  2. When you are using Shared VPC and the IP address that you provide is from the service project. In this case, the network that the IP address resides in is defined in the host project.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#project_id GoogleNetworkManagementConnectivityTest#project_id}


GoogleNetworkManagementConnectivityTestTimeouts

Initializer

import { googleNetworkManagementConnectivityTest } from '@cdktf/provider-google-beta'

const googleNetworkManagementConnectivityTestTimeouts: googleNetworkManagementConnectivityTest.GoogleNetworkManagementConnectivityTestTimeouts = { ... }

Properties

Name Type Description
create string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#create GoogleNetworkManagementConnectivityTest#create}.
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#delete GoogleNetworkManagementConnectivityTest#delete}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#update GoogleNetworkManagementConnectivityTest#update}.

createOptional
public readonly create: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#create GoogleNetworkManagementConnectivityTest#create}.


deleteOptional
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#delete GoogleNetworkManagementConnectivityTest#delete}.


updateOptional
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_network_management_connectivity_test#update GoogleNetworkManagementConnectivityTest#update}.


Classes

GoogleNetworkManagementConnectivityTestDestinationOutputReference

Initializers

import { googleNetworkManagementConnectivityTest } from '@cdktf/provider-google-beta'

new googleNetworkManagementConnectivityTest.GoogleNetworkManagementConnectivityTestDestinationOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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.
resetInstance No description.
resetIpAddress No description.
resetNetwork No description.
resetPort No description.
resetProjectId No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetInstance
public resetInstance(): void
resetIpAddress
public resetIpAddress(): void
resetNetwork
public resetNetwork(): void
resetPort
public resetPort(): void
resetProjectId
public resetProjectId(): 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.
instanceInput string No description.
ipAddressInput string No description.
networkInput string No description.
portInput number No description.
projectIdInput string No description.
instance string No description.
ipAddress string No description.
network string No description.
port number No description.
projectId string No description.
internalValue GoogleNetworkManagementConnectivityTestDestination No description.

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

instanceInputOptional
public readonly instanceInput: string;
  • Type: string

ipAddressInputOptional
public readonly ipAddressInput: string;
  • Type: string

networkInputOptional
public readonly networkInput: string;
  • Type: string

portInputOptional
public readonly portInput: number;
  • Type: number

projectIdInputOptional
public readonly projectIdInput: string;
  • Type: string

instanceRequired
public readonly instance: string;
  • Type: string

ipAddressRequired
public readonly ipAddress: string;
  • Type: string

networkRequired
public readonly network: string;
  • Type: string

portRequired
public readonly port: number;
  • Type: number

projectIdRequired
public readonly projectId: string;
  • Type: string

internalValueOptional
public readonly internalValue: GoogleNetworkManagementConnectivityTestDestination;

GoogleNetworkManagementConnectivityTestSourceOutputReference

Initializers

import { googleNetworkManagementConnectivityTest } from '@cdktf/provider-google-beta'

new googleNetworkManagementConnectivityTest.GoogleNetworkManagementConnectivityTestSourceOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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.
resetInstance No description.
resetIpAddress No description.
resetNetwork No description.
resetNetworkType No description.
resetPort No description.
resetProjectId No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetInstance
public resetInstance(): void
resetIpAddress
public resetIpAddress(): void
resetNetwork
public resetNetwork(): void
resetNetworkType
public resetNetworkType(): void
resetPort
public resetPort(): void
resetProjectId
public resetProjectId(): 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.
instanceInput string No description.
ipAddressInput string No description.
networkInput string No description.
networkTypeInput string No description.
portInput number No description.
projectIdInput string No description.
instance string No description.
ipAddress string No description.
network string No description.
networkType string No description.
port number No description.
projectId string No description.
internalValue GoogleNetworkManagementConnectivityTestSource No description.

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

instanceInputOptional
public readonly instanceInput: string;
  • Type: string

ipAddressInputOptional
public readonly ipAddressInput: string;
  • Type: string

networkInputOptional
public readonly networkInput: string;
  • Type: string

networkTypeInputOptional
public readonly networkTypeInput: string;
  • Type: string

portInputOptional
public readonly portInput: number;
  • Type: number

projectIdInputOptional
public readonly projectIdInput: string;
  • Type: string

instanceRequired
public readonly instance: string;
  • Type: string

ipAddressRequired
public readonly ipAddress: string;
  • Type: string

networkRequired
public readonly network: string;
  • Type: string

networkTypeRequired
public readonly networkType: string;
  • Type: string

portRequired
public readonly port: number;
  • Type: number

projectIdRequired
public readonly projectId: string;
  • Type: string

internalValueOptional
public readonly internalValue: GoogleNetworkManagementConnectivityTestSource;

GoogleNetworkManagementConnectivityTestTimeoutsOutputReference

Initializers

import { googleNetworkManagementConnectivityTest } from '@cdktf/provider-google-beta'

new googleNetworkManagementConnectivityTest.GoogleNetworkManagementConnectivityTestTimeoutsOutputReference(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.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • 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.
resetCreate No description.
resetDelete No description.
resetUpdate No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate
public resetCreate(): void
resetDelete
public resetDelete(): void
resetUpdate
public resetUpdate(): 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.
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 | GoogleNetworkManagementConnectivityTestTimeouts No description.

creationStackRequired
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.


fqnRequired
public readonly fqn: string;
  • Type: string

createInputOptional
public readonly createInput: string;
  • Type: string

deleteInputOptional
public readonly deleteInput: string;
  • Type: string

updateInputOptional
public readonly updateInput: string;
  • Type: string

createRequired
public readonly create: string;
  • Type: string

deleteRequired
public readonly delete: string;
  • Type: string

updateRequired
public readonly update: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | GoogleNetworkManagementConnectivityTestTimeouts;