Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule google_compute_forwarding_rule}.
import { computeForwardingRule } from '@cdktf/provider-google'
new computeForwardingRule.ComputeForwardingRule(scope: Construct, id: string, config: ComputeForwardingRuleConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
ComputeForwardingRuleConfig |
No description. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
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". |
putServiceDirectoryRegistrations |
No description. |
putTimeouts |
No description. |
resetAllowGlobalAccess |
No description. |
resetAllowPscGlobalAccess |
No description. |
resetAllPorts |
No description. |
resetBackendService |
No description. |
resetDescription |
No description. |
resetId |
No description. |
resetIpAddress |
No description. |
resetIpProtocol |
No description. |
resetIpVersion |
No description. |
resetIsMirroringCollector |
No description. |
resetLabels |
No description. |
resetLoadBalancingScheme |
No description. |
resetNetwork |
No description. |
resetNetworkTier |
No description. |
resetNoAutomateDnsZone |
No description. |
resetPortRange |
No description. |
resetPorts |
No description. |
resetProject |
No description. |
resetRecreateClosedPsc |
No description. |
resetRegion |
No description. |
resetServiceDirectoryRegistrations |
No description. |
resetServiceLabel |
No description. |
resetSourceIpRanges |
No description. |
resetSubnetwork |
No description. |
resetTarget |
No description. |
resetTimeouts |
No description. |
public toString(): string
Returns a string representation of this construct.
public addOverride(path: string, value: any): void
- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
public toHclTerraform(): any
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
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.
- Type: string
The string move target that will correspond to this resource.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
public importFrom(id: string, provider?: TerraformProvider): void
- Type: string
- Type: cdktf.TerraformProvider
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public moveTo(moveTarget: string, index?: string | number): void
Moves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: string | number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public moveToId(id: string): void
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public putServiceDirectoryRegistrations(value: ComputeForwardingRuleServiceDirectoryRegistrations): void
public putTimeouts(value: ComputeForwardingRuleTimeouts): void
public resetAllowGlobalAccess(): void
public resetAllowPscGlobalAccess(): void
public resetAllPorts(): void
public resetBackendService(): void
public resetDescription(): void
public resetId(): void
public resetIpAddress(): void
public resetIpProtocol(): void
public resetIpVersion(): void
public resetIsMirroringCollector(): void
public resetLabels(): void
public resetLoadBalancingScheme(): void
public resetNetwork(): void
public resetNetworkTier(): void
public resetNoAutomateDnsZone(): void
public resetPortRange(): void
public resetPorts(): void
public resetProject(): void
public resetRecreateClosedPsc(): void
public resetRegion(): void
public resetServiceDirectoryRegistrations(): void
public resetServiceLabel(): void
public resetSourceIpRanges(): void
public resetSubnetwork(): void
public resetTarget(): void
public resetTimeouts(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a ComputeForwardingRule resource upon running "cdktf plan ". |
import { computeForwardingRule } from '@cdktf/provider-google'
computeForwardingRule.ComputeForwardingRule.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.
- Type: any
Any object.
import { computeForwardingRule } from '@cdktf/provider-google'
computeForwardingRule.ComputeForwardingRule.isTerraformElement(x: any)
- Type: any
import { computeForwardingRule } from '@cdktf/provider-google'
computeForwardingRule.ComputeForwardingRule.isTerraformResource(x: any)
- Type: any
import { computeForwardingRule } from '@cdktf/provider-google'
computeForwardingRule.ComputeForwardingRule.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a ComputeForwardingRule resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the ComputeForwardingRule to import.
- Type: string
The id of the existing ComputeForwardingRule that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the ComputeForwardingRule to import is found.
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. |
baseForwardingRule |
string |
No description. |
creationTimestamp |
string |
No description. |
effectiveLabels |
cdktf.StringMap |
No description. |
forwardingRuleId |
number |
No description. |
labelFingerprint |
string |
No description. |
pscConnectionId |
string |
No description. |
pscConnectionStatus |
string |
No description. |
selfLink |
string |
No description. |
serviceDirectoryRegistrations |
ComputeForwardingRuleServiceDirectoryRegistrationsOutputReference |
No description. |
serviceName |
string |
No description. |
terraformLabels |
cdktf.StringMap |
No description. |
timeouts |
ComputeForwardingRuleTimeoutsOutputReference |
No description. |
allowGlobalAccessInput |
boolean | cdktf.IResolvable |
No description. |
allowPscGlobalAccessInput |
boolean | cdktf.IResolvable |
No description. |
allPortsInput |
boolean | cdktf.IResolvable |
No description. |
backendServiceInput |
string |
No description. |
descriptionInput |
string |
No description. |
idInput |
string |
No description. |
ipAddressInput |
string |
No description. |
ipProtocolInput |
string |
No description. |
ipVersionInput |
string |
No description. |
isMirroringCollectorInput |
boolean | cdktf.IResolvable |
No description. |
labelsInput |
{[ key: string ]: string} |
No description. |
loadBalancingSchemeInput |
string |
No description. |
nameInput |
string |
No description. |
networkInput |
string |
No description. |
networkTierInput |
string |
No description. |
noAutomateDnsZoneInput |
boolean | cdktf.IResolvable |
No description. |
portRangeInput |
string |
No description. |
portsInput |
string[] |
No description. |
projectInput |
string |
No description. |
recreateClosedPscInput |
boolean | cdktf.IResolvable |
No description. |
regionInput |
string |
No description. |
serviceDirectoryRegistrationsInput |
ComputeForwardingRuleServiceDirectoryRegistrations |
No description. |
serviceLabelInput |
string |
No description. |
sourceIpRangesInput |
string[] |
No description. |
subnetworkInput |
string |
No description. |
targetInput |
string |
No description. |
timeoutsInput |
cdktf.IResolvable | ComputeForwardingRuleTimeouts |
No description. |
allowGlobalAccess |
boolean | cdktf.IResolvable |
No description. |
allowPscGlobalAccess |
boolean | cdktf.IResolvable |
No description. |
allPorts |
boolean | cdktf.IResolvable |
No description. |
backendService |
string |
No description. |
description |
string |
No description. |
id |
string |
No description. |
ipAddress |
string |
No description. |
ipProtocol |
string |
No description. |
ipVersion |
string |
No description. |
isMirroringCollector |
boolean | cdktf.IResolvable |
No description. |
labels |
{[ key: string ]: string} |
No description. |
loadBalancingScheme |
string |
No description. |
name |
string |
No description. |
network |
string |
No description. |
networkTier |
string |
No description. |
noAutomateDnsZone |
boolean | cdktf.IResolvable |
No description. |
portRange |
string |
No description. |
ports |
string[] |
No description. |
project |
string |
No description. |
recreateClosedPsc |
boolean | cdktf.IResolvable |
No description. |
region |
string |
No description. |
serviceLabel |
string |
No description. |
sourceIpRanges |
string[] |
No description. |
subnetwork |
string |
No description. |
target |
string |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;
- Type: cdktf.TerraformStack
public readonly fqn: string;
- Type: string
public readonly friendlyUniqueId: string;
- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];
- Type: string[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly baseForwardingRule: string;
- Type: string
public readonly creationTimestamp: string;
- Type: string
public readonly effectiveLabels: StringMap;
- Type: cdktf.StringMap
public readonly forwardingRuleId: number;
- Type: number
public readonly labelFingerprint: string;
- Type: string
public readonly pscConnectionId: string;
- Type: string
public readonly pscConnectionStatus: string;
- Type: string
public readonly selfLink: string;
- Type: string
public readonly serviceDirectoryRegistrations: ComputeForwardingRuleServiceDirectoryRegistrationsOutputReference;
public readonly serviceName: string;
- Type: string
public readonly terraformLabels: StringMap;
- Type: cdktf.StringMap
public readonly timeouts: ComputeForwardingRuleTimeoutsOutputReference;
public readonly allowGlobalAccessInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly allowPscGlobalAccessInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly allPortsInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly backendServiceInput: string;
- Type: string
public readonly descriptionInput: string;
- Type: string
public readonly idInput: string;
- Type: string
public readonly ipAddressInput: string;
- Type: string
public readonly ipProtocolInput: string;
- Type: string
public readonly ipVersionInput: string;
- Type: string
public readonly isMirroringCollectorInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly labelsInput: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly loadBalancingSchemeInput: string;
- Type: string
public readonly nameInput: string;
- Type: string
public readonly networkInput: string;
- Type: string
public readonly networkTierInput: string;
- Type: string
public readonly noAutomateDnsZoneInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly portRangeInput: string;
- Type: string
public readonly portsInput: string[];
- Type: string[]
public readonly projectInput: string;
- Type: string
public readonly recreateClosedPscInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly regionInput: string;
- Type: string
public readonly serviceDirectoryRegistrationsInput: ComputeForwardingRuleServiceDirectoryRegistrations;
public readonly serviceLabelInput: string;
- Type: string
public readonly sourceIpRangesInput: string[];
- Type: string[]
public readonly subnetworkInput: string;
- Type: string
public readonly targetInput: string;
- Type: string
public readonly timeoutsInput: IResolvable | ComputeForwardingRuleTimeouts;
- Type: cdktf.IResolvable | ComputeForwardingRuleTimeouts
public readonly allowGlobalAccess: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly allowPscGlobalAccess: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly allPorts: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly backendService: string;
- Type: string
public readonly description: string;
- Type: string
public readonly id: string;
- Type: string
public readonly ipAddress: string;
- Type: string
public readonly ipProtocol: string;
- Type: string
public readonly ipVersion: string;
- Type: string
public readonly isMirroringCollector: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly labels: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly loadBalancingScheme: string;
- Type: string
public readonly name: string;
- Type: string
public readonly network: string;
- Type: string
public readonly networkTier: string;
- Type: string
public readonly noAutomateDnsZone: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly portRange: string;
- Type: string
public readonly ports: string[];
- Type: string[]
public readonly project: string;
- Type: string
public readonly recreateClosedPsc: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly region: string;
- Type: string
public readonly serviceLabel: string;
- Type: string
public readonly sourceIpRanges: string[];
- Type: string[]
public readonly subnetwork: string;
- Type: string
public readonly target: string;
- Type: string
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { computeForwardingRule } from '@cdktf/provider-google'
const computeForwardingRuleConfig: computeForwardingRule.ComputeForwardingRuleConfig = { ... }
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. |
name |
string |
Name of the resource; |
allowGlobalAccess |
boolean | cdktf.IResolvable |
This field is used along with the 'backend_service' field for internal load balancing or with the 'target' field for internal TargetInstance. |
allowPscGlobalAccess |
boolean | cdktf.IResolvable |
This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. |
allPorts |
boolean | cdktf.IResolvable |
The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. |
backendService |
string |
Identifies the backend service to which the forwarding rule sends traffic. |
description |
string |
An optional description of this resource. Provide this property when you create the resource. |
id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#id ComputeForwardingRule#id}. |
ipAddress |
string |
IP address for which this forwarding rule accepts traffic. |
ipProtocol |
string |
The IP protocol to which this rule applies. |
ipVersion |
string |
The IP address version that will be used by this forwarding rule. Valid options are IPV4 and IPV6. |
isMirroringCollector |
boolean | cdktf.IResolvable |
Indicates whether or not this load balancer can be used as a collector for packet mirroring. |
labels |
{[ key: string ]: string} |
Labels to apply to this forwarding rule. A list of key->value pairs. |
loadBalancingScheme |
string |
Specifies the forwarding rule type. |
network |
string |
This field is not used for external load balancing. |
networkTier |
string |
This signifies the networking tier used for configuring this load balancer and can only take the following values: 'PREMIUM', 'STANDARD'. |
noAutomateDnsZone |
boolean | cdktf.IResolvable |
This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. |
portRange |
string |
The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. |
ports |
string[] |
The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. |
project |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#project ComputeForwardingRule#project}. |
recreateClosedPsc |
boolean | cdktf.IResolvable |
This is used in PSC consumer ForwardingRule to make terraform recreate the ForwardingRule when the status is closed. |
region |
string |
A reference to the region where the regional forwarding rule resides. |
serviceDirectoryRegistrations |
ComputeForwardingRuleServiceDirectoryRegistrations |
service_directory_registrations block. |
serviceLabel |
string |
An optional prefix to the service name for this Forwarding Rule. |
sourceIpRanges |
string[] |
If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. |
subnetwork |
string |
This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. |
target |
string |
The URL of the target resource to receive the matched traffic. |
timeouts |
ComputeForwardingRuleTimeouts |
timeouts block. |
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];
- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly name: string;
- Type: string
Name of the resource;
provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
Specifically, the name must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#name ComputeForwardingRule#name}
public readonly allowGlobalAccess: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
This field is used along with the 'backend_service' field for internal load balancing or with the 'target' field for internal TargetInstance.
If the field is set to 'TRUE', clients can access ILB from all regions.
Otherwise only allows access from clients in the same region as the internal load balancer.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#allow_global_access ComputeForwardingRule#allow_global_access}
public readonly allowPscGlobalAccess: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#allow_psc_global_access ComputeForwardingRule#allow_psc_global_access}
public readonly allPorts: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.
The 'allPorts' field has the following limitations:
- It requires that the forwarding rule 'IPProtocol' be TCP, UDP, SCTP, or L3_DEFAULT.
- It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal and external protocol forwarding.
- Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The L3_DEFAULT protocol requires 'allPorts' be set to true.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#all_ports ComputeForwardingRule#all_ports}
public readonly backendService: string;
- Type: string
Identifies the backend service to which the forwarding rule sends traffic.
Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#backend_service ComputeForwardingRule#backend_service}
public readonly description: string;
- Type: string
An optional description of this resource. Provide this property when you create the resource.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#description ComputeForwardingRule#description}
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#id ComputeForwardingRule#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.
public readonly ipAddress: string;
- Type: string
IP address for which this forwarding rule accepts traffic.
When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced 'target' or 'backendService'.
While creating a forwarding rule, specifying an 'IPAddress' is required under the following circumstances:
- When the 'target' is set to 'targetGrpcProxy' and 'validateForProxyless' is set to 'true', the 'IPAddress' should be set to '0.0.0.0'.
- When the 'target' is a Private Service Connect Google APIs bundle, you must specify an 'IPAddress'.
Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address.
Use one of the following formats to specify an IP address while creating a forwarding rule:
- IP address number, as in '100.1.2.3'
- IPv6 address range, as in '2600:1234::/96'
- Full resource URL, as in 'https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name'
- Partial URL or by name, as in:
- 'projects/project_id/regions/region/addresses/address-name'
- 'regions/region/addresses/address-name'
- 'global/addresses/address-name'
- 'address-name'
The forwarding rule's 'target' or 'backendService', and in most cases, also the 'loadBalancingScheme', determine the type of IP address that you can use. For detailed information, see IP address specifications.
When reading an 'IPAddress', the API always returns the IP address number.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#ip_address ComputeForwardingRule#ip_address}
public readonly ipProtocol: string;
- Type: string
The IP protocol to which this rule applies.
For protocol forwarding, valid options are 'TCP', 'UDP', 'ESP', 'AH', 'SCTP', 'ICMP' and 'L3_DEFAULT'.
The valid IP protocols are different for different load balancing products as described in Load balancing features.
A Forwarding Rule with protocol L3_DEFAULT can attach with target instance or backend service with UNSPECIFIED protocol. A forwarding rule with "L3_DEFAULT" IPProtocal cannot be attached to a backend service with TCP or UDP. Possible values: ["TCP", "UDP", "ESP", "AH", "SCTP", "ICMP", "L3_DEFAULT"]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#ip_protocol ComputeForwardingRule#ip_protocol}
public readonly ipVersion: string;
- Type: string
The IP address version that will be used by this forwarding rule. Valid options are IPV4 and IPV6.
If not set, the IPv4 address will be used by default. Possible values: ["IPV4", "IPV6"]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#ip_version ComputeForwardingRule#ip_version}
public readonly isMirroringCollector: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Indicates whether or not this load balancer can be used as a collector for packet mirroring.
To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a 'PacketMirroring' rule applies to them.
This can only be set to true for load balancers that have their 'loadBalancingScheme' set to 'INTERNAL'.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#is_mirroring_collector ComputeForwardingRule#is_mirroring_collector}
public readonly labels: {[ key: string ]: string};
- Type: {[ key: string ]: string}
Labels to apply to this forwarding rule. A list of key->value pairs.
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/6.15.0/docs/resources/compute_forwarding_rule#labels ComputeForwardingRule#labels}
public readonly loadBalancingScheme: string;
- Type: string
Specifies the forwarding rule type.
For more information about forwarding rules, refer to Forwarding rule concepts. Default value: "EXTERNAL" Possible values: ["EXTERNAL", "EXTERNAL_MANAGED", "INTERNAL", "INTERNAL_MANAGED"]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#load_balancing_scheme ComputeForwardingRule#load_balancing_scheme}
public readonly network: string;
- Type: string
This field is not used for external load balancing.
For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used.
For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#network ComputeForwardingRule#network}
public readonly networkTier: string;
- Type: string
This signifies the networking tier used for configuring this load balancer and can only take the following values: 'PREMIUM', 'STANDARD'.
For regional ForwardingRule, the valid values are 'PREMIUM' and 'STANDARD'. For GlobalForwardingRule, the valid value is 'PREMIUM'.
If this field is not specified, it is assumed to be 'PREMIUM'. If 'IPAddress' is specified, this value must be equal to the networkTier of the Address. Possible values: ["PREMIUM", "STANDARD"]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#network_tier ComputeForwardingRule#network_tier}
public readonly noAutomateDnsZone: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not.
Non-PSC forwarding rules do not use this field.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#no_automate_dns_zone ComputeForwardingRule#no_automate_dns_zone}
public readonly portRange: string;
- Type: string
The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.
The 'portRange' field has the following limitations:
- It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
- It's applicable only to the following products: external passthrough Network Load Balancers, internal and external proxy Network Load Balancers, internal and external Application Load Balancers, external protocol forwarding, and Classic VPN.
- Some products have restrictions on what ports can be used. See port specifications for details.
For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.
For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair, and cannot have overlapping 'portRange's.
public readonly ports: string[];
- Type: string[]
The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule.
The 'ports' field has the following limitations:
- It requires that the forwarding rule 'IPProtocol' be TCP, UDP, or SCTP, and
- It's applicable only to the following products: internal passthrough Network Load Balancers, backend service-based external passthrough Network Load Balancers, and internal protocol forwarding.
- You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous.
For external forwarding rules, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.
For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same '[IPAddress, IPProtocol]' pair if they share at least one port number.
public readonly project: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#project ComputeForwardingRule#project}.
public readonly recreateClosedPsc: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
This is used in PSC consumer ForwardingRule to make terraform recreate the ForwardingRule when the status is closed.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#recreate_closed_psc ComputeForwardingRule#recreate_closed_psc}
public readonly region: string;
- Type: string
A reference to the region where the regional forwarding rule resides.
This field is not applicable to global forwarding rules.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#region ComputeForwardingRule#region}
public readonly serviceDirectoryRegistrations: ComputeForwardingRuleServiceDirectoryRegistrations;
service_directory_registrations block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#service_directory_registrations ComputeForwardingRule#service_directory_registrations}
public readonly serviceLabel: string;
- Type: string
An optional prefix to the service name for this Forwarding Rule.
If specified, will be the first label of the fully qualified service name.
The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
This field is only used for INTERNAL load balancing.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#service_label ComputeForwardingRule#service_label}
public readonly sourceIpRanges: string[];
- Type: string[]
If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here.
Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each sourceIpRange entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#source_ip_ranges ComputeForwardingRule#source_ip_ranges}
public readonly subnetwork: string;
- Type: string
This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6.
If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#subnetwork ComputeForwardingRule#subnetwork}
public readonly target: string;
- Type: string
The URL of the target resource to receive the matched traffic.
For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource.
The forwarded traffic must be of a type appropriate to the target object.
- For load balancers, see the "Target" column in Port specifications.
- For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:
- 'vpc-sc' - APIs that support VPC Service Controls.
- 'all-apis' - All supported Google APIs.
For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#target ComputeForwardingRule#target}
public readonly timeouts: ComputeForwardingRuleTimeouts;
timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#timeouts ComputeForwardingRule#timeouts}
import { computeForwardingRule } from '@cdktf/provider-google'
const computeForwardingRuleServiceDirectoryRegistrations: computeForwardingRule.ComputeForwardingRuleServiceDirectoryRegistrations = { ... }
Name | Type | Description |
---|---|---|
namespace |
string |
Service Directory namespace to register the forwarding rule under. |
service |
string |
Service Directory service to register the forwarding rule under. |
public readonly namespace: string;
- Type: string
Service Directory namespace to register the forwarding rule under.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#namespace ComputeForwardingRule#namespace}
public readonly service: string;
- Type: string
Service Directory service to register the forwarding rule under.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#service ComputeForwardingRule#service}
import { computeForwardingRule } from '@cdktf/provider-google'
const computeForwardingRuleTimeouts: computeForwardingRule.ComputeForwardingRuleTimeouts = { ... }
Name | Type | Description |
---|---|---|
create |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#create ComputeForwardingRule#create}. |
delete |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#delete ComputeForwardingRule#delete}. |
update |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#update ComputeForwardingRule#update}. |
public readonly create: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#create ComputeForwardingRule#create}.
public readonly delete: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#delete ComputeForwardingRule#delete}.
public readonly update: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/compute_forwarding_rule#update ComputeForwardingRule#update}.
import { computeForwardingRule } from '@cdktf/provider-google'
new computeForwardingRule.ComputeForwardingRuleServiceDirectoryRegistrationsOutputReference(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. |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
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. |
resetNamespace |
No description. |
resetService |
No description. |
public computeFqn(): string
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(property: string): IResolvable
- Type: string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
public resetNamespace(): void
public resetService(): void
Name | Type | Description |
---|---|---|
creationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
string |
No description. |
namespaceInput |
string |
No description. |
serviceInput |
string |
No description. |
namespace |
string |
No description. |
service |
string |
No description. |
internalValue |
ComputeForwardingRuleServiceDirectoryRegistrations |
No description. |
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.
public readonly fqn: string;
- Type: string
public readonly namespaceInput: string;
- Type: string
public readonly serviceInput: string;
- Type: string
public readonly namespace: string;
- Type: string
public readonly service: string;
- Type: string
public readonly internalValue: ComputeForwardingRuleServiceDirectoryRegistrations;
import { computeForwardingRule } from '@cdktf/provider-google'
new computeForwardingRule.ComputeForwardingRuleTimeoutsOutputReference(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. |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
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. |
public computeFqn(): string
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(property: string): IResolvable
- Type: string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
public resetCreate(): void
public resetDelete(): void
public resetUpdate(): void
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 | ComputeForwardingRuleTimeouts |
No description. |
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.
public readonly fqn: string;
- Type: string
public readonly createInput: string;
- Type: string
public readonly deleteInput: string;
- Type: string
public readonly updateInput: string;
- Type: string
public readonly create: string;
- Type: string
public readonly delete: string;
- Type: string
public readonly update: string;
- Type: string
public readonly internalValue: IResolvable | ComputeForwardingRuleTimeouts;
- Type: cdktf.IResolvable | ComputeForwardingRuleTimeouts