Skip to content

Latest commit

 

History

History
3660 lines (2348 loc) · 180 KB

computeForwardingRule.java.md

File metadata and controls

3660 lines (2348 loc) · 180 KB
Raw

computeForwardingRule Submodule

Constructs

ComputeForwardingRule

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

Initializers 

import com.hashicorp.cdktf.providers.google.compute_forwarding_rule.ComputeForwardingRule;

ComputeForwardingRule.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .name(java.lang.String)
//  .allowGlobalAccess(java.lang.Boolean)
//  .allowGlobalAccess(IResolvable)
//  .allowPscGlobalAccess(java.lang.Boolean)
//  .allowPscGlobalAccess(IResolvable)
//  .allPorts(java.lang.Boolean)
//  .allPorts(IResolvable)
//  .backendService(java.lang.String)
//  .description(java.lang.String)
//  .id(java.lang.String)
//  .ipAddress(java.lang.String)
//  .ipProtocol(java.lang.String)
//  .ipVersion(java.lang.String)
//  .isMirroringCollector(java.lang.Boolean)
//  .isMirroringCollector(IResolvable)
//  .labels(java.util.Map<java.lang.String, java.lang.String>)
//  .loadBalancingScheme(java.lang.String)
//  .network(java.lang.String)
//  .networkTier(java.lang.String)
//  .noAutomateDnsZone(java.lang.Boolean)
//  .noAutomateDnsZone(IResolvable)
//  .portRange(java.lang.String)
//  .ports(java.util.List<java.lang.String>)
//  .project(java.lang.String)
//  .recreateClosedPsc(java.lang.Boolean)
//  .recreateClosedPsc(IResolvable)
//  .region(java.lang.String)
//  .serviceDirectoryRegistrations(ComputeForwardingRuleServiceDirectoryRegistrations)
//  .serviceLabel(java.lang.String)
//  .sourceIpRanges(java.util.List<java.lang.String>)
//  .subnetwork(java.lang.String)
//  .target(java.lang.String)
//  .timeouts(ComputeForwardingRuleTimeouts)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
name java.lang.String Name of the resource;
allowGlobalAccess java.lang.Boolean OR com.hashicorp.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 java.lang.Boolean OR com.hashicorp.cdktf.IResolvable This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
allPorts java.lang.Boolean OR com.hashicorp.cdktf.IResolvable The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
backendService java.lang.String Identifies the backend service to which the forwarding rule sends traffic.
description java.lang.String An optional description of this resource. Provide this property when you create the resource.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#id ComputeForwardingRule#id}.
ipAddress java.lang.String IP address for which this forwarding rule accepts traffic.
ipProtocol java.lang.String The IP protocol to which this rule applies.
ipVersion java.lang.String The IP address version that will be used by this forwarding rule. Valid options are IPV4 and IPV6.
isMirroringCollector java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Indicates whether or not this load balancer can be used as a collector for packet mirroring.
labels java.util.Map<java.lang.String, java.lang.String> Labels to apply to this forwarding rule. A list of key->value pairs.
loadBalancingScheme java.lang.String Specifies the forwarding rule type.
network java.lang.String This field is not used for external load balancing.
networkTier java.lang.String This signifies the networking tier used for configuring this load balancer and can only take the following values: 'PREMIUM', 'STANDARD'.
noAutomateDnsZone java.lang.Boolean OR com.hashicorp.cdktf.IResolvable This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not.
portRange java.lang.String The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
ports java.util.List<java.lang.String> The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
project java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#project ComputeForwardingRule#project}.
recreateClosedPsc java.lang.Boolean OR com.hashicorp.cdktf.IResolvable This is used in PSC consumer ForwardingRule to make terraform recreate the ForwardingRule when the status is closed.
region java.lang.String A reference to the region where the regional forwarding rule resides.
serviceDirectoryRegistrations ComputeForwardingRuleServiceDirectoryRegistrations service_directory_registrations block.
serviceLabel java.lang.String An optional prefix to the service name for this Forwarding Rule.
sourceIpRanges java.util.List<java.lang.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 java.lang.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 java.lang.String The URL of the target resource to receive the matched traffic.
timeouts ComputeForwardingRuleTimeouts timeouts block.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
nameRequired
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#name ComputeForwardingRule#name}

allowGlobalAccessOptional
  • Type: java.lang.Boolean OR com.hashicorp.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.14.1/docs/resources/compute_forwarding_rule#allow_global_access ComputeForwardingRule#allow_global_access}

allowPscGlobalAccessOptional
  • Type: java.lang.Boolean OR com.hashicorp.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.14.1/docs/resources/compute_forwarding_rule#allow_psc_global_access ComputeForwardingRule#allow_psc_global_access}

allPortsOptional
  • Type: java.lang.Boolean OR com.hashicorp.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.14.1/docs/resources/compute_forwarding_rule#all_ports ComputeForwardingRule#all_ports}

backendServiceOptional
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#backend_service ComputeForwardingRule#backend_service}

descriptionOptional
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#description ComputeForwardingRule#description}

idOptional
  • Type: java.lang.String

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

ipAddressOptional
  • Type: java.lang.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:

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.14.1/docs/resources/compute_forwarding_rule#ip_address ComputeForwardingRule#ip_address}

ipProtocolOptional
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#ip_protocol ComputeForwardingRule#ip_protocol}

ipVersionOptional
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#ip_version ComputeForwardingRule#ip_version}

isMirroringCollectorOptional
  • Type: java.lang.Boolean OR com.hashicorp.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.14.1/docs/resources/compute_forwarding_rule#is_mirroring_collector ComputeForwardingRule#is_mirroring_collector}

labelsOptional
  • Type: java.util.Map<java.lang.String, java.lang.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.14.1/docs/resources/compute_forwarding_rule#labels ComputeForwardingRule#labels}

loadBalancingSchemeOptional
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#load_balancing_scheme ComputeForwardingRule#load_balancing_scheme}

networkOptional
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#network ComputeForwardingRule#network}

networkTierOptional
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#network_tier ComputeForwardingRule#network_tier}

noAutomateDnsZoneOptional
  • Type: java.lang.Boolean OR com.hashicorp.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.14.1/docs/resources/compute_forwarding_rule#no_automate_dns_zone ComputeForwardingRule#no_automate_dns_zone}

portRangeOptional
  • Type: java.lang.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.

portsOptional
  • Type: java.util.List<java.lang.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.

projectOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#project ComputeForwardingRule#project}.

recreateClosedPscOptional
  • Type: java.lang.Boolean OR com.hashicorp.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.14.1/docs/resources/compute_forwarding_rule#recreate_closed_psc ComputeForwardingRule#recreate_closed_psc}

regionOptional
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#region ComputeForwardingRule#region}

serviceDirectoryRegistrationsOptional

service_directory_registrations block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#service_directory_registrations ComputeForwardingRule#service_directory_registrations}

serviceLabelOptional
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#service_label ComputeForwardingRule#service_label}

sourceIpRangesOptional
  • Type: java.util.List<java.lang.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.14.1/docs/resources/compute_forwarding_rule#source_ip_ranges ComputeForwardingRule#source_ip_ranges}

subnetworkOptional
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#subnetwork ComputeForwardingRule#subnetwork}

targetOptional
  • Type: java.lang.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 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.14.1/docs/resources/compute_forwarding_rule#target ComputeForwardingRule#target}

timeoutsOptional

timeouts block.

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

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
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.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

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

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

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

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

putServiceDirectoryRegistrations 
public void putServiceDirectoryRegistrations(ComputeForwardingRuleServiceDirectoryRegistrations value)
valueRequired
putTimeouts 
public void putTimeouts(ComputeForwardingRuleTimeouts value)
valueRequired
resetAllowGlobalAccess 
public void resetAllowGlobalAccess()
resetAllowPscGlobalAccess 
public void resetAllowPscGlobalAccess()
resetAllPorts 
public void resetAllPorts()
resetBackendService 
public void resetBackendService()
resetDescription 
public void resetDescription()
resetId 
public void resetId()
resetIpAddress 
public void resetIpAddress()
resetIpProtocol 
public void resetIpProtocol()
resetIpVersion 
public void resetIpVersion()
resetIsMirroringCollector 
public void resetIsMirroringCollector()
resetLabels 
public void resetLabels()
resetLoadBalancingScheme 
public void resetLoadBalancingScheme()
resetNetwork 
public void resetNetwork()
resetNetworkTier 
public void resetNetworkTier()
resetNoAutomateDnsZone 
public void resetNoAutomateDnsZone()
resetPortRange 
public void resetPortRange()
resetPorts 
public void resetPorts()
resetProject 
public void resetProject()
resetRecreateClosedPsc 
public void resetRecreateClosedPsc()
resetRegion 
public void resetRegion()
resetServiceDirectoryRegistrations 
public void resetServiceDirectoryRegistrations()
resetServiceLabel 
public void resetServiceLabel()
resetSourceIpRanges 
public void resetSourceIpRanges()
resetSubnetwork 
public void resetSubnetwork()
resetTarget 
public void resetTarget()
resetTimeouts 
public void resetTimeouts()

Static Functions

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 ".
isConstruct 
import com.hashicorp.cdktf.providers.google.compute_forwarding_rule.ComputeForwardingRule;

ComputeForwardingRule.isConstruct(java.lang.Object x)

Checks if x is a construct.

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

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

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.google.compute_forwarding_rule.ComputeForwardingRule;

ComputeForwardingRule.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.google.compute_forwarding_rule.ComputeForwardingRule;

ComputeForwardingRule.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.google.compute_forwarding_rule.ComputeForwardingRule;

ComputeForwardingRule.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),ComputeForwardingRule.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing ComputeForwardingRule that should be imported.

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

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
baseForwardingRule java.lang.String No description.
creationTimestamp java.lang.String No description.
effectiveLabels com.hashicorp.cdktf.StringMap No description.
forwardingRuleId java.lang.Number No description.
labelFingerprint java.lang.String No description.
pscConnectionId java.lang.String No description.
pscConnectionStatus java.lang.String No description.
selfLink java.lang.String No description.
serviceDirectoryRegistrations ComputeForwardingRuleServiceDirectoryRegistrationsOutputReference No description.
serviceName java.lang.String No description.
terraformLabels com.hashicorp.cdktf.StringMap No description.
timeouts ComputeForwardingRuleTimeoutsOutputReference No description.
allowGlobalAccessInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
allowPscGlobalAccessInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
allPortsInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
backendServiceInput java.lang.String No description.
descriptionInput java.lang.String No description.
idInput java.lang.String No description.
ipAddressInput java.lang.String No description.
ipProtocolInput java.lang.String No description.
ipVersionInput java.lang.String No description.
isMirroringCollectorInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
labelsInput java.util.Map<java.lang.String, java.lang.String> No description.
loadBalancingSchemeInput java.lang.String No description.
nameInput java.lang.String No description.
networkInput java.lang.String No description.
networkTierInput java.lang.String No description.
noAutomateDnsZoneInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
portRangeInput java.lang.String No description.
portsInput java.util.List<java.lang.String> No description.
projectInput java.lang.String No description.
recreateClosedPscInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
regionInput java.lang.String No description.
serviceDirectoryRegistrationsInput ComputeForwardingRuleServiceDirectoryRegistrations No description.
serviceLabelInput java.lang.String No description.
sourceIpRangesInput java.util.List<java.lang.String> No description.
subnetworkInput java.lang.String No description.
targetInput java.lang.String No description.
timeoutsInput com.hashicorp.cdktf.IResolvable OR ComputeForwardingRuleTimeouts No description.
allowGlobalAccess java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
allowPscGlobalAccess java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
allPorts java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
backendService java.lang.String No description.
description java.lang.String No description.
id java.lang.String No description.
ipAddress java.lang.String No description.
ipProtocol java.lang.String No description.
ipVersion java.lang.String No description.
isMirroringCollector java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
labels java.util.Map<java.lang.String, java.lang.String> No description.
loadBalancingScheme java.lang.String No description.
name java.lang.String No description.
network java.lang.String No description.
networkTier java.lang.String No description.
noAutomateDnsZone java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
portRange java.lang.String No description.
ports java.util.List<java.lang.String> No description.
project java.lang.String No description.
recreateClosedPsc java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
region java.lang.String No description.
serviceLabel java.lang.String No description.
sourceIpRanges java.util.List<java.lang.String> No description.
subnetwork java.lang.String No description.
target java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
baseForwardingRuleRequired 
public java.lang.String getBaseForwardingRule();
  • Type: java.lang.String
creationTimestampRequired 
public java.lang.String getCreationTimestamp();
  • Type: java.lang.String
effectiveLabelsRequired 
public StringMap getEffectiveLabels();
  • Type: com.hashicorp.cdktf.StringMap
forwardingRuleIdRequired 
public java.lang.Number getForwardingRuleId();
  • Type: java.lang.Number
labelFingerprintRequired 
public java.lang.String getLabelFingerprint();
  • Type: java.lang.String
pscConnectionIdRequired 
public java.lang.String getPscConnectionId();
  • Type: java.lang.String
pscConnectionStatusRequired 
public java.lang.String getPscConnectionStatus();
  • Type: java.lang.String
selfLinkRequired 
public java.lang.String getSelfLink();
  • Type: java.lang.String
serviceDirectoryRegistrationsRequired 
public ComputeForwardingRuleServiceDirectoryRegistrationsOutputReference getServiceDirectoryRegistrations();
serviceNameRequired 
public java.lang.String getServiceName();
  • Type: java.lang.String
terraformLabelsRequired 
public StringMap getTerraformLabels();
  • Type: com.hashicorp.cdktf.StringMap
timeoutsRequired 
public ComputeForwardingRuleTimeoutsOutputReference getTimeouts();
allowGlobalAccessInputOptional 
public java.lang.Object getAllowGlobalAccessInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
allowPscGlobalAccessInputOptional 
public java.lang.Object getAllowPscGlobalAccessInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
allPortsInputOptional 
public java.lang.Object getAllPortsInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
backendServiceInputOptional 
public java.lang.String getBackendServiceInput();
  • Type: java.lang.String
descriptionInputOptional 
public java.lang.String getDescriptionInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
ipAddressInputOptional 
public java.lang.String getIpAddressInput();
  • Type: java.lang.String
ipProtocolInputOptional 
public java.lang.String getIpProtocolInput();
  • Type: java.lang.String
ipVersionInputOptional 
public java.lang.String getIpVersionInput();
  • Type: java.lang.String
isMirroringCollectorInputOptional 
public java.lang.Object getIsMirroringCollectorInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
labelsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getLabelsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
loadBalancingSchemeInputOptional 
public java.lang.String getLoadBalancingSchemeInput();
  • Type: java.lang.String
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
networkInputOptional 
public java.lang.String getNetworkInput();
  • Type: java.lang.String
networkTierInputOptional 
public java.lang.String getNetworkTierInput();
  • Type: java.lang.String
noAutomateDnsZoneInputOptional 
public java.lang.Object getNoAutomateDnsZoneInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
portRangeInputOptional 
public java.lang.String getPortRangeInput();
  • Type: java.lang.String
portsInputOptional 
public java.util.List<java.lang.String> getPortsInput();
  • Type: java.util.List<java.lang.String>
projectInputOptional 
public java.lang.String getProjectInput();
  • Type: java.lang.String
recreateClosedPscInputOptional 
public java.lang.Object getRecreateClosedPscInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
regionInputOptional 
public java.lang.String getRegionInput();
  • Type: java.lang.String
serviceDirectoryRegistrationsInputOptional 
public ComputeForwardingRuleServiceDirectoryRegistrations getServiceDirectoryRegistrationsInput();
serviceLabelInputOptional 
public java.lang.String getServiceLabelInput();
  • Type: java.lang.String
sourceIpRangesInputOptional 
public java.util.List<java.lang.String> getSourceIpRangesInput();
  • Type: java.util.List<java.lang.String>
subnetworkInputOptional 
public java.lang.String getSubnetworkInput();
  • Type: java.lang.String
targetInputOptional 
public java.lang.String getTargetInput();
  • Type: java.lang.String
timeoutsInputOptional 
public java.lang.Object getTimeoutsInput();
allowGlobalAccessRequired 
public java.lang.Object getAllowGlobalAccess();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
allowPscGlobalAccessRequired 
public java.lang.Object getAllowPscGlobalAccess();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
allPortsRequired 
public java.lang.Object getAllPorts();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
backendServiceRequired 
public java.lang.String getBackendService();
  • Type: java.lang.String
descriptionRequired 
public java.lang.String getDescription();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
ipAddressRequired 
public java.lang.String getIpAddress();
  • Type: java.lang.String
ipProtocolRequired 
public java.lang.String getIpProtocol();
  • Type: java.lang.String
ipVersionRequired 
public java.lang.String getIpVersion();
  • Type: java.lang.String
isMirroringCollectorRequired 
public java.lang.Object getIsMirroringCollector();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
labelsRequired 
public java.util.Map<java.lang.String, java.lang.String> getLabels();
  • Type: java.util.Map<java.lang.String, java.lang.String>
loadBalancingSchemeRequired 
public java.lang.String getLoadBalancingScheme();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
networkRequired 
public java.lang.String getNetwork();
  • Type: java.lang.String
networkTierRequired 
public java.lang.String getNetworkTier();
  • Type: java.lang.String
noAutomateDnsZoneRequired 
public java.lang.Object getNoAutomateDnsZone();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
portRangeRequired 
public java.lang.String getPortRange();
  • Type: java.lang.String
portsRequired 
public java.util.List<java.lang.String> getPorts();
  • Type: java.util.List<java.lang.String>
projectRequired 
public java.lang.String getProject();
  • Type: java.lang.String
recreateClosedPscRequired 
public java.lang.Object getRecreateClosedPsc();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
regionRequired 
public java.lang.String getRegion();
  • Type: java.lang.String
serviceLabelRequired 
public java.lang.String getServiceLabel();
  • Type: java.lang.String
sourceIpRangesRequired 
public java.util.List<java.lang.String> getSourceIpRanges();
  • Type: java.util.List<java.lang.String>
subnetworkRequired 
public java.lang.String getSubnetwork();
  • Type: java.lang.String
targetRequired 
public java.lang.String getTarget();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

ComputeForwardingRuleConfig

Initializer 

import com.hashicorp.cdktf.providers.google.compute_forwarding_rule.ComputeForwardingRuleConfig;

ComputeForwardingRuleConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .name(java.lang.String)
//  .allowGlobalAccess(java.lang.Boolean)
//  .allowGlobalAccess(IResolvable)
//  .allowPscGlobalAccess(java.lang.Boolean)
//  .allowPscGlobalAccess(IResolvable)
//  .allPorts(java.lang.Boolean)
//  .allPorts(IResolvable)
//  .backendService(java.lang.String)
//  .description(java.lang.String)
//  .id(java.lang.String)
//  .ipAddress(java.lang.String)
//  .ipProtocol(java.lang.String)
//  .ipVersion(java.lang.String)
//  .isMirroringCollector(java.lang.Boolean)
//  .isMirroringCollector(IResolvable)
//  .labels(java.util.Map<java.lang.String, java.lang.String>)
//  .loadBalancingScheme(java.lang.String)
//  .network(java.lang.String)
//  .networkTier(java.lang.String)
//  .noAutomateDnsZone(java.lang.Boolean)
//  .noAutomateDnsZone(IResolvable)
//  .portRange(java.lang.String)
//  .ports(java.util.List<java.lang.String>)
//  .project(java.lang.String)
//  .recreateClosedPsc(java.lang.Boolean)
//  .recreateClosedPsc(IResolvable)
//  .region(java.lang.String)
//  .serviceDirectoryRegistrations(ComputeForwardingRuleServiceDirectoryRegistrations)
//  .serviceLabel(java.lang.String)
//  .sourceIpRanges(java.util.List<java.lang.String>)
//  .subnetwork(java.lang.String)
//  .target(java.lang.String)
//  .timeouts(ComputeForwardingRuleTimeouts)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
name java.lang.String Name of the resource;
allowGlobalAccess java.lang.Boolean OR com.hashicorp.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 java.lang.Boolean OR com.hashicorp.cdktf.IResolvable This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
allPorts java.lang.Boolean OR com.hashicorp.cdktf.IResolvable The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
backendService java.lang.String Identifies the backend service to which the forwarding rule sends traffic.
description java.lang.String An optional description of this resource. Provide this property when you create the resource.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#id ComputeForwardingRule#id}.
ipAddress java.lang.String IP address for which this forwarding rule accepts traffic.
ipProtocol java.lang.String The IP protocol to which this rule applies.
ipVersion java.lang.String The IP address version that will be used by this forwarding rule. Valid options are IPV4 and IPV6.
isMirroringCollector java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Indicates whether or not this load balancer can be used as a collector for packet mirroring.
labels java.util.Map<java.lang.String, java.lang.String> Labels to apply to this forwarding rule. A list of key->value pairs.
loadBalancingScheme java.lang.String Specifies the forwarding rule type.
network java.lang.String This field is not used for external load balancing.
networkTier java.lang.String This signifies the networking tier used for configuring this load balancer and can only take the following values: 'PREMIUM', 'STANDARD'.
noAutomateDnsZone java.lang.Boolean OR com.hashicorp.cdktf.IResolvable This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not.
portRange java.lang.String The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
ports java.util.List<java.lang.String> The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
project java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#project ComputeForwardingRule#project}.
recreateClosedPsc java.lang.Boolean OR com.hashicorp.cdktf.IResolvable This is used in PSC consumer ForwardingRule to make terraform recreate the ForwardingRule when the status is closed.
region java.lang.String A reference to the region where the regional forwarding rule resides.
serviceDirectoryRegistrations ComputeForwardingRuleServiceDirectoryRegistrations service_directory_registrations block.
serviceLabel java.lang.String An optional prefix to the service name for this Forwarding Rule.
sourceIpRanges java.util.List<java.lang.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 java.lang.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 java.lang.String The URL of the target resource to receive the matched traffic.
timeouts ComputeForwardingRuleTimeouts timeouts block.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
nameRequired 
public java.lang.String getName();
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#name ComputeForwardingRule#name}

allowGlobalAccessOptional 
public java.lang.Object getAllowGlobalAccess();
  • Type: java.lang.Boolean OR com.hashicorp.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.14.1/docs/resources/compute_forwarding_rule#allow_global_access ComputeForwardingRule#allow_global_access}

allowPscGlobalAccessOptional 
public java.lang.Object getAllowPscGlobalAccess();
  • Type: java.lang.Boolean OR com.hashicorp.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.14.1/docs/resources/compute_forwarding_rule#allow_psc_global_access ComputeForwardingRule#allow_psc_global_access}

allPortsOptional 
public java.lang.Object getAllPorts();
  • Type: java.lang.Boolean OR com.hashicorp.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.14.1/docs/resources/compute_forwarding_rule#all_ports ComputeForwardingRule#all_ports}

backendServiceOptional 
public java.lang.String getBackendService();
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#backend_service ComputeForwardingRule#backend_service}

descriptionOptional 
public java.lang.String getDescription();
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#description ComputeForwardingRule#description}

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

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

ipAddressOptional 
public java.lang.String getIpAddress();
  • Type: java.lang.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:

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.14.1/docs/resources/compute_forwarding_rule#ip_address ComputeForwardingRule#ip_address}

ipProtocolOptional 
public java.lang.String getIpProtocol();
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#ip_protocol ComputeForwardingRule#ip_protocol}

ipVersionOptional 
public java.lang.String getIpVersion();
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#ip_version ComputeForwardingRule#ip_version}

isMirroringCollectorOptional 
public java.lang.Object getIsMirroringCollector();
  • Type: java.lang.Boolean OR com.hashicorp.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.14.1/docs/resources/compute_forwarding_rule#is_mirroring_collector ComputeForwardingRule#is_mirroring_collector}

labelsOptional 
public java.util.Map<java.lang.String, java.lang.String> getLabels();
  • Type: java.util.Map<java.lang.String, java.lang.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.14.1/docs/resources/compute_forwarding_rule#labels ComputeForwardingRule#labels}

loadBalancingSchemeOptional 
public java.lang.String getLoadBalancingScheme();
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#load_balancing_scheme ComputeForwardingRule#load_balancing_scheme}

networkOptional 
public java.lang.String getNetwork();
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#network ComputeForwardingRule#network}

networkTierOptional 
public java.lang.String getNetworkTier();
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#network_tier ComputeForwardingRule#network_tier}

noAutomateDnsZoneOptional 
public java.lang.Object getNoAutomateDnsZone();
  • Type: java.lang.Boolean OR com.hashicorp.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.14.1/docs/resources/compute_forwarding_rule#no_automate_dns_zone ComputeForwardingRule#no_automate_dns_zone}

portRangeOptional 
public java.lang.String getPortRange();
  • Type: java.lang.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.

portsOptional 
public java.util.List<java.lang.String> getPorts();
  • Type: java.util.List<java.lang.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.

projectOptional 
public java.lang.String getProject();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#project ComputeForwardingRule#project}.

recreateClosedPscOptional 
public java.lang.Object getRecreateClosedPsc();
  • Type: java.lang.Boolean OR com.hashicorp.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.14.1/docs/resources/compute_forwarding_rule#recreate_closed_psc ComputeForwardingRule#recreate_closed_psc}

regionOptional 
public java.lang.String getRegion();
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#region ComputeForwardingRule#region}

serviceDirectoryRegistrationsOptional 
public ComputeForwardingRuleServiceDirectoryRegistrations getServiceDirectoryRegistrations();

service_directory_registrations block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#service_directory_registrations ComputeForwardingRule#service_directory_registrations}

serviceLabelOptional 
public java.lang.String getServiceLabel();
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#service_label ComputeForwardingRule#service_label}

sourceIpRangesOptional 
public java.util.List<java.lang.String> getSourceIpRanges();
  • Type: java.util.List<java.lang.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.14.1/docs/resources/compute_forwarding_rule#source_ip_ranges ComputeForwardingRule#source_ip_ranges}

subnetworkOptional 
public java.lang.String getSubnetwork();
  • Type: java.lang.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.14.1/docs/resources/compute_forwarding_rule#subnetwork ComputeForwardingRule#subnetwork}

targetOptional 
public java.lang.String getTarget();
  • Type: java.lang.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 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.14.1/docs/resources/compute_forwarding_rule#target ComputeForwardingRule#target}

timeoutsOptional 
public ComputeForwardingRuleTimeouts getTimeouts();

timeouts block.

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

ComputeForwardingRuleServiceDirectoryRegistrations

Initializer 

import com.hashicorp.cdktf.providers.google.compute_forwarding_rule.ComputeForwardingRuleServiceDirectoryRegistrations;

ComputeForwardingRuleServiceDirectoryRegistrations.builder()
//  .namespace(java.lang.String)
//  .service(java.lang.String)
    .build();

Properties

Name Type Description
namespace java.lang.String Service Directory namespace to register the forwarding rule under.
service java.lang.String Service Directory service to register the forwarding rule under.
namespaceOptional 
public java.lang.String getNamespace();
  • Type: java.lang.String

Service Directory namespace to register the forwarding rule under.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#namespace ComputeForwardingRule#namespace}

serviceOptional 
public java.lang.String getService();
  • Type: java.lang.String

Service Directory service to register the forwarding rule under.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#service ComputeForwardingRule#service}

ComputeForwardingRuleTimeouts

Initializer 

import com.hashicorp.cdktf.providers.google.compute_forwarding_rule.ComputeForwardingRuleTimeouts;

ComputeForwardingRuleTimeouts.builder()
//  .create(java.lang.String)
//  .delete(java.lang.String)
//  .update(java.lang.String)
    .build();

Properties

Name Type Description
create java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#create ComputeForwardingRule#create}.
delete java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#delete ComputeForwardingRule#delete}.
update java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/compute_forwarding_rule#update ComputeForwardingRule#update}.
createOptional 
public java.lang.String getCreate();
  • Type: java.lang.String

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

deleteOptional 
public java.lang.String getDelete();
  • Type: java.lang.String

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

updateOptional 
public java.lang.String getUpdate();
  • Type: java.lang.String

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

Classes

ComputeForwardingRuleServiceDirectoryRegistrationsOutputReference

Initializers 

import com.hashicorp.cdktf.providers.google.compute_forwarding_rule.ComputeForwardingRuleServiceDirectoryRegistrationsOutputReference;

new ComputeForwardingRuleServiceDirectoryRegistrationsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.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.
resetNamespace No description.
resetService No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetNamespace 
public void resetNamespace()
resetService 
public void resetService()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
namespaceInput java.lang.String No description.
serviceInput java.lang.String No description.
namespace java.lang.String No description.
service java.lang.String No description.
internalValue ComputeForwardingRuleServiceDirectoryRegistrations No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

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

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

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
namespaceInputOptional 
public java.lang.String getNamespaceInput();
  • Type: java.lang.String
serviceInputOptional 
public java.lang.String getServiceInput();
  • Type: java.lang.String
namespaceRequired 
public java.lang.String getNamespace();
  • Type: java.lang.String
serviceRequired 
public java.lang.String getService();
  • Type: java.lang.String
internalValueOptional 
public ComputeForwardingRuleServiceDirectoryRegistrations getInternalValue();

ComputeForwardingRuleTimeoutsOutputReference

Initializers 

import com.hashicorp.cdktf.providers.google.compute_forwarding_rule.ComputeForwardingRuleTimeoutsOutputReference;

new ComputeForwardingRuleTimeoutsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.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 java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate 
public void resetCreate()
resetDelete 
public void resetDelete()
resetUpdate 
public void resetUpdate()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
createInput java.lang.String No description.
deleteInput java.lang.String No description.
updateInput java.lang.String No description.
create java.lang.String No description.
delete java.lang.String No description.
update java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR ComputeForwardingRuleTimeouts No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.String>

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

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

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
createInputOptional 
public java.lang.String getCreateInput();
  • Type: java.lang.String
deleteInputOptional 
public java.lang.String getDeleteInput();
  • Type: java.lang.String
updateInputOptional 
public java.lang.String getUpdateInput();
  • Type: java.lang.String
createRequired 
public java.lang.String getCreate();
  • Type: java.lang.String
deleteRequired 
public java.lang.String getDelete();
  • Type: java.lang.String
updateRequired 
public java.lang.String getUpdate();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();