`googleNetworkServicesGateway` Submodule

Constructs

GoogleNetworkServicesGateway

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

Initializers

import { googleNetworkServicesGateway } from '@cdktn/provider-google-beta'

new googleNetworkServicesGateway.GoogleNetworkServicesGateway(scope: Construct, id: string, config: GoogleNetworkServicesGatewayConfig)

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

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`addOverride`	No description.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`resetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`toHclTerraform`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`addMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`getAnyMapAttribute`	No description.
`getBooleanAttribute`	No description.
`getBooleanMapAttribute`	No description.
`getListAttribute`	No description.
`getNumberAttribute`	No description.
`getNumberListAttribute`	No description.
`getNumberMapAttribute`	No description.
`getStringAttribute`	No description.
`getStringMapAttribute`	No description.
`hasResourceMove`	No description.
`importFrom`	No description.
`interpolationForAttribute`	No description.
`moveFromId`	Move the resource corresponding to "id" to this resource.
`moveTo`	Moves this resource to the target resource given by moveTarget.
`moveToId`	Moves this resource to the resource corresponding to "id".
`putTimeouts`	No description.
`resetAddresses`	No description.
`resetAllPorts`	No description.
`resetCertificateUrls`	No description.
`resetDeleteSwgAutogenRouterOnDestroy`	No description.
`resetDeletionPolicy`	No description.
`resetDescription`	No description.
`resetEnvoyHeaders`	No description.
`resetGatewaySecurityPolicy`	No description.
`resetId`	No description.
`resetIpVersion`	No description.
`resetLabels`	No description.
`resetLocation`	No description.
`resetNetwork`	No description.
`resetPorts`	No description.
`resetProject`	No description.
`resetRoutingMode`	No description.
`resetScope`	No description.
`resetServerTlsPolicy`	No description.
`resetSubnetwork`	No description.
`resetTimeouts`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`addOverride`

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

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

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

`toHclTerraform`

public toHclTerraform(): any

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

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

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

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktn.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

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.

`id`^Required

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.

`moveTarget`^Required

Type: string

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

`index`^Optional

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

`id`^Required

Type: string

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

`putTimeouts`

public putTimeouts(value: GoogleNetworkServicesGatewayTimeouts): void

`value`^Required

Type: GoogleNetworkServicesGatewayTimeouts

`resetAddresses`

public resetAddresses(): void

`resetAllPorts`

public resetAllPorts(): void

`resetCertificateUrls`

public resetCertificateUrls(): void

`resetDeleteSwgAutogenRouterOnDestroy`

public resetDeleteSwgAutogenRouterOnDestroy(): void

`resetDeletionPolicy`

public resetDeletionPolicy(): void

`resetDescription`

public resetDescription(): void

`resetEnvoyHeaders`

public resetEnvoyHeaders(): void

`resetGatewaySecurityPolicy`

public resetGatewaySecurityPolicy(): void

`resetId`

public resetId(): void

`resetIpVersion`

public resetIpVersion(): void

`resetLabels`

public resetLabels(): void

`resetLocation`

public resetLocation(): void

`resetNetwork`

public resetNetwork(): void

`resetPorts`

public resetPorts(): void

`resetProject`

public resetProject(): void

`resetRoutingMode`

public resetRoutingMode(): void

`resetScope`

public resetScope(): void

`resetServerTlsPolicy`

public resetServerTlsPolicy(): void

`resetSubnetwork`

public resetSubnetwork(): void

`resetTimeouts`

public resetTimeouts(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTN code for importing a GoogleNetworkServicesGateway resource upon running "cdktn plan ".

`isConstruct`

import { googleNetworkServicesGateway } from '@cdktn/provider-google-beta'

googleNetworkServicesGateway.GoogleNetworkServicesGateway.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { googleNetworkServicesGateway } from '@cdktn/provider-google-beta'

googleNetworkServicesGateway.GoogleNetworkServicesGateway.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { googleNetworkServicesGateway } from '@cdktn/provider-google-beta'

googleNetworkServicesGateway.GoogleNetworkServicesGateway.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { googleNetworkServicesGateway } from '@cdktn/provider-google-beta'

googleNetworkServicesGateway.GoogleNetworkServicesGateway.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTN code for importing a GoogleNetworkServicesGateway resource upon running "cdktn 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 GoogleNetworkServicesGateway to import.

`importFromId`^Required

Type: string

The id of the existing GoogleNetworkServicesGateway that should be imported.

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

`provider`^Optional

Type: cdktn.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktn.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktn.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktn.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner[]`	No description.
`createTime`	`string`	No description.
`effectiveLabels`	`cdktn.StringMap`	No description.
`selfLink`	`string`	No description.
`terraformLabels`	`cdktn.StringMap`	No description.
`timeouts`	`GoogleNetworkServicesGatewayTimeoutsOutputReference`	No description.
`updateTime`	`string`	No description.
`addressesInput`	`string[]`	No description.
`allPortsInput`	`boolean \| cdktn.IResolvable`	No description.
`certificateUrlsInput`	`string[]`	No description.
`deleteSwgAutogenRouterOnDestroyInput`	`boolean \| cdktn.IResolvable`	No description.
`deletionPolicyInput`	`string`	No description.
`descriptionInput`	`string`	No description.
`envoyHeadersInput`	`string`	No description.
`gatewaySecurityPolicyInput`	`string`	No description.
`idInput`	`string`	No description.
`ipVersionInput`	`string`	No description.
`labelsInput`	`{[ key: string ]: string}`	No description.
`locationInput`	`string`	No description.
`nameInput`	`string`	No description.
`networkInput`	`string`	No description.
`portsInput`	`number[]`	No description.
`projectInput`	`string`	No description.
`routingModeInput`	`string`	No description.
`scopeInput`	`string`	No description.
`serverTlsPolicyInput`	`string`	No description.
`subnetworkInput`	`string`	No description.
`timeoutsInput`	`cdktn.IResolvable \| GoogleNetworkServicesGatewayTimeouts`	No description.
`typeInput`	`string`	No description.
`addresses`	`string[]`	No description.
`allPorts`	`boolean \| cdktn.IResolvable`	No description.
`certificateUrls`	`string[]`	No description.
`deleteSwgAutogenRouterOnDestroy`	`boolean \| cdktn.IResolvable`	No description.
`deletionPolicy`	`string`	No description.
`description`	`string`	No description.
`envoyHeaders`	`string`	No description.
`gatewaySecurityPolicy`	`string`	No description.
`id`	`string`	No description.
`ipVersion`	`string`	No description.
`labels`	`{[ key: string ]: string}`	No description.
`location`	`string`	No description.
`name`	`string`	No description.
`network`	`string`	No description.
`ports`	`number[]`	No description.
`project`	`string`	No description.
`routingMode`	`string`	No description.
`scope`	`string`	No description.
`serverTlsPolicy`	`string`	No description.
`subnetwork`	`string`	No description.
`type`	`string`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktn.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

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

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktn.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktn.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktn.TerraformProvider

`provisioners`^Optional

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

Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

`createTime`^Required

public readonly createTime: string;

Type: string

`effectiveLabels`^Required

public readonly effectiveLabels: StringMap;

Type: cdktn.StringMap

`selfLink`^Required

public readonly selfLink: string;

Type: string

`terraformLabels`^Required

public readonly terraformLabels: StringMap;

Type: cdktn.StringMap

`timeouts`^Required

public readonly timeouts: GoogleNetworkServicesGatewayTimeoutsOutputReference;

Type: GoogleNetworkServicesGatewayTimeoutsOutputReference

`updateTime`^Required

public readonly updateTime: string;

Type: string

`addressesInput`^Optional

public readonly addressesInput: string[];

Type: string[]

`allPortsInput`^Optional

public readonly allPortsInput: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

`certificateUrlsInput`^Optional

public readonly certificateUrlsInput: string[];

Type: string[]

`deleteSwgAutogenRouterOnDestroyInput`^Optional

public readonly deleteSwgAutogenRouterOnDestroyInput: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

`deletionPolicyInput`^Optional

public readonly deletionPolicyInput: string;

Type: string

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`envoyHeadersInput`^Optional

public readonly envoyHeadersInput: string;

Type: string

`gatewaySecurityPolicyInput`^Optional

public readonly gatewaySecurityPolicyInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`ipVersionInput`^Optional

public readonly ipVersionInput: string;

Type: string

`labelsInput`^Optional

public readonly labelsInput: {[ key: string ]: string};

Type: {[ key: string ]: string}

`locationInput`^Optional

public readonly locationInput: string;

Type: string

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`networkInput`^Optional

public readonly networkInput: string;

Type: string

`portsInput`^Optional

public readonly portsInput: number[];

Type: number[]

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`routingModeInput`^Optional

public readonly routingModeInput: string;

Type: string

`scopeInput`^Optional

public readonly scopeInput: string;

Type: string

`serverTlsPolicyInput`^Optional

public readonly serverTlsPolicyInput: string;

Type: string

`subnetworkInput`^Optional

public readonly subnetworkInput: string;

Type: string

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | GoogleNetworkServicesGatewayTimeouts;

Type: cdktn.IResolvable | GoogleNetworkServicesGatewayTimeouts

`typeInput`^Optional

public readonly typeInput: string;

Type: string

`addresses`^Required

public readonly addresses: string[];

Type: string[]

`allPorts`^Required

public readonly allPorts: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

`certificateUrls`^Required

public readonly certificateUrls: string[];

Type: string[]

`deleteSwgAutogenRouterOnDestroy`^Required

public readonly deleteSwgAutogenRouterOnDestroy: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

`deletionPolicy`^Required

public readonly deletionPolicy: string;

Type: string

`description`^Required

public readonly description: string;

Type: string

`envoyHeaders`^Required

public readonly envoyHeaders: string;

Type: string

`gatewaySecurityPolicy`^Required

public readonly gatewaySecurityPolicy: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`ipVersion`^Required

public readonly ipVersion: string;

Type: string

`labels`^Required

public readonly labels: {[ key: string ]: string};

Type: {[ key: string ]: string}

`location`^Required

public readonly location: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`network`^Required

public readonly network: string;

Type: string

`ports`^Required

public readonly ports: number[];

Type: number[]

`project`^Required

public readonly project: string;

Type: string

`routingMode`^Required

public readonly routingMode: string;

Type: string

`scope`^Required

public readonly scope: string;

Type: string

`serverTlsPolicy`^Required

public readonly serverTlsPolicy: string;

Type: string

`subnetwork`^Required

public readonly subnetwork: string;

Type: string

`type`^Required

public readonly type: string;

Type: string

Constants

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

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

GoogleNetworkServicesGatewayConfig

Initializer

import { googleNetworkServicesGateway } from '@cdktn/provider-google-beta'

const googleNetworkServicesGatewayConfig: googleNetworkServicesGateway.GoogleNetworkServicesGatewayConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktn.TerraformCount`	No description.
`dependsOn`	`cdktn.ITerraformDependable[]`	No description.
`forEach`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner[]`	No description.
`name`	`string`	Name of the Gateway resource.
`type`	`string`	Immutable. The type of the customer managed gateway. Possible values: ["OPEN_MESH", "SECURE_WEB_GATEWAY"].
`addresses`	`string[]`	Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic.
`allPorts`	`boolean \| cdktn.IResolvable`	Configures this gateway to listen on all ports.
`certificateUrls`	`string[]`	A fully-qualified Certificates URL reference.
`deleteSwgAutogenRouterOnDestroy`	`boolean \| cdktn.IResolvable`	When deleting a gateway of type 'SECURE_WEB_GATEWAY', this boolean option will also delete auto generated router by the gateway creation.
`deletionPolicy`	`string`	Whether Terraform will be prevented from destroying the instance.
`description`	`string`	A free-text description of the resource. Max length 1024 characters.
`envoyHeaders`	`string`	Determines if envoy will insert internal debug headers into upstream requests.
`gatewaySecurityPolicy`	`string`	A fully-qualified GatewaySecurityPolicy URL reference.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_services_gateway#id GoogleNetworkServicesGateway#id}.
`ipVersion`	`string`	The IP Version that will be used by this gateway. Possible values: ["IPV4", "IPV6"].
`labels`	`{[ key: string ]: string}`	Set of label tags associated with the Gateway resource.
`location`	`string`	The location of the gateway. The default value is 'global'.
`network`	`string`	The relative resource name identifying the VPC network that is using this configuration. For example: 'projects/* /global/networks/network-1'.
`ports`	`number[]`	One or more port numbers (1-65535), on which the Gateway will receive traffic.
`project`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_services_gateway#project GoogleNetworkServicesGateway#project}.
`routingMode`	`string`	The routing mode of the Gateway.
`scope`	`string`	Immutable.
`serverTlsPolicy`	`string`	A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
`subnetwork`	`string`	The relative resource name identifying the subnetwork in which this SWG is allocated. For example: projects/* /regions/us-central1/subnetworks/network-1.
`timeouts`	`GoogleNetworkServicesGatewayTimeouts`	timeouts block.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktn.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktn.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktn.TerraformProvider

`provisioners`^Optional

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

Type: cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner[]

`name`^Required

public readonly name: string;

Type: string

Name of the Gateway resource.

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

`type`^Required

public readonly type: string;

Type: string

Immutable. The type of the customer managed gateway. Possible values: ["OPEN_MESH", "SECURE_WEB_GATEWAY"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_services_gateway#type GoogleNetworkServicesGateway#type}

`addresses`^Optional

public readonly addresses: string[];

Type: string[]

Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic.

When no address is provided, an IP from the subnetwork is allocated.

This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_services_gateway#addresses GoogleNetworkServicesGateway#addresses}

`allPorts`^Optional

public readonly allPorts: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

Configures this gateway to listen on all ports.

By enabling the wildcard ports feature on your Secure Web Proxy Gateway, it will accept traffic destined for any port (1-65535) on its assigned IP address. This field is configurable only for gateways of type SECURE_WEB_GATEWAY.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_services_gateway#all_ports GoogleNetworkServicesGateway#all_ports}

`certificateUrls`^Optional

public readonly certificateUrls: string[];

Type: string[]

A fully-qualified Certificates URL reference.

The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_services_gateway#certificate_urls GoogleNetworkServicesGateway#certificate_urls}

`deleteSwgAutogenRouterOnDestroy`^Optional

public readonly deleteSwgAutogenRouterOnDestroy: boolean | IResolvable;

Type: boolean | cdktn.IResolvable

When deleting a gateway of type 'SECURE_WEB_GATEWAY', this boolean option will also delete auto generated router by the gateway creation.

If there is no other gateway of type 'SECURE_WEB_GATEWAY' remaining for that region and network it will be deleted.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_services_gateway#delete_swg_autogen_router_on_destroy GoogleNetworkServicesGateway#delete_swg_autogen_router_on_destroy}

`deletionPolicy`^Optional

public readonly deletionPolicy: string;

Type: string

Whether Terraform will be prevented from destroying the instance.

Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_services_gateway#deletion_policy GoogleNetworkServicesGateway#deletion_policy}

`description`^Optional

public readonly description: string;

Type: string

A free-text description of the resource. Max length 1024 characters.

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

`envoyHeaders`^Optional

public readonly envoyHeaders: string;

Type: string

Determines if envoy will insert internal debug headers into upstream requests.

Other Envoy headers may still be injected. By default, envoy will not insert any debug headers. Possible values: ["NONE", "DEBUG_HEADERS"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_services_gateway#envoy_headers GoogleNetworkServicesGateway#envoy_headers}

`gatewaySecurityPolicy`^Optional

public readonly gatewaySecurityPolicy: string;

Type: string

A fully-qualified GatewaySecurityPolicy URL reference.

Defines how a server should apply security policy to inbound (VM to Proxy) initiated connections. For example: 'projects/* /locations/* /gatewaySecurityPolicies/swg-policy'. This policy is specific to gateways of type 'SECURE_WEB_GATEWAY'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_services_gateway#gateway_security_policy GoogleNetworkServicesGateway#gateway_security_policy}

Note: The above comment contained a comment block ending sequence (* followed by /). We have introduced a space between to prevent syntax errors. Please ignore the space.

`id`^Optional

public readonly id: string;

Type: string

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

`ipVersion`^Optional

public readonly ipVersion: string;

Type: string

The IP Version that will be used by this gateway. Possible values: ["IPV4", "IPV6"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_services_gateway#ip_version GoogleNetworkServicesGateway#ip_version}

`labels`^Optional

public readonly labels: {[ key: string ]: string};

Type: {[ key: string ]: string}

Set of label tags associated with the Gateway resource.

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/7.40.0/docs/resources/google_network_services_gateway#labels GoogleNetworkServicesGateway#labels}

`location`^Optional

public readonly location: string;

Type: string

The location of the gateway. The default value is 'global'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_services_gateway#location GoogleNetworkServicesGateway#location}

`network`^Optional

public readonly network: string;

Type: string

The relative resource name identifying the VPC network that is using this configuration. For example: 'projects/* /global/networks/network-1'.

Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'.

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

Note: The above comment contained a comment block ending sequence (* followed by /). We have introduced a space between to prevent syntax errors. Please ignore the space.

`ports`^Optional

public readonly ports: number[];

Type: number[]

One or more port numbers (1-65535), on which the Gateway will receive traffic.

The proxy binds to the specified ports. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_services_gateway#ports GoogleNetworkServicesGateway#ports}

`project`^Optional

public readonly project: string;

Type: string

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

`routingMode`^Optional

public readonly routingMode: string;

Type: string

The routing mode of the Gateway.

This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. Possible values: ["NEXT_HOP_ROUTING_MODE", "EXPLICIT_ROUTING_MODE"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_services_gateway#routing_mode GoogleNetworkServicesGateway#routing_mode}

`scope`^Optional

public readonly scope: string;

Type: string

Immutable.

Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer.

Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_services_gateway#scope GoogleNetworkServicesGateway#scope}

`serverTlsPolicy`^Optional

public readonly serverTlsPolicy: string;

Type: string

A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_services_gateway#server_tls_policy GoogleNetworkServicesGateway#server_tls_policy}

`subnetwork`^Optional

public readonly subnetwork: string;

Type: string

The relative resource name identifying the subnetwork in which this SWG is allocated. For example: projects/* /regions/us-central1/subnetworks/network-1.

Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/7.40.0/docs/resources/google_network_services_gateway#subnetwork GoogleNetworkServicesGateway#subnetwork}

Note: The above comment contained a comment block ending sequence (* followed by /). We have introduced a space between to prevent syntax errors. Please ignore the space.

`timeouts`^Optional

public readonly timeouts: GoogleNetworkServicesGatewayTimeouts;

Type: GoogleNetworkServicesGatewayTimeouts

timeouts block.

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

GoogleNetworkServicesGatewayTimeouts

Initializer

import { googleNetworkServicesGateway } from '@cdktn/provider-google-beta'

const googleNetworkServicesGatewayTimeouts: googleNetworkServicesGateway.GoogleNetworkServicesGatewayTimeouts = { ... }

Properties

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

`create`^Optional

public readonly create: string;

Type: string

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

`delete`^Optional

public readonly delete: string;

Type: string

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

`update`^Optional

public readonly update: string;

Type: string

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

Classes

GoogleNetworkServicesGatewayTimeoutsOutputReference

Initializers

import { googleNetworkServicesGateway } from '@cdktn/provider-google-beta'

new googleNetworkServicesGateway.GoogleNetworkServicesGatewayTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

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

`terraformResource`^Required

Type: cdktn.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.
`resetCreate`	No description.
`resetDelete`	No description.
`resetUpdate`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

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

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

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

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktn.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`	`cdktn.IResolvable \| GoogleNetworkServicesGatewayTimeouts`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

public readonly fqn: string;

Type: string

`createInput`^Optional

public readonly createInput: string;

Type: string

`deleteInput`^Optional

public readonly deleteInput: string;

Type: string

`updateInput`^Optional

public readonly updateInput: string;

Type: string

`create`^Required

public readonly create: string;

Type: string

`delete`^Required

public readonly delete: string;

Type: string

`update`^Required

public readonly update: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleNetworkServicesGatewayTimeouts;

Type: cdktn.IResolvable | GoogleNetworkServicesGatewayTimeouts

Uh oh!

FilesExpand file tree

googleNetworkServicesGateway.typescript.md

Latest commit

History

googleNetworkServicesGateway.typescript.md

File metadata and controls

googleNetworkServicesGateway Submodule

Constructs