Class ComputeForwardingRule.Builder
- java.lang.Object
-
- com.hashicorp.cdktf.providers.google.compute_forwarding_rule.ComputeForwardingRule.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<ComputeForwardingRule>
- Enclosing class:
- ComputeForwardingRule
@Stability(Stable) public static final class ComputeForwardingRule.Builder extends Object implements software.amazon.jsii.Builder<ComputeForwardingRule>
A fluent builder forComputeForwardingRule.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ComputeForwardingRule.BuilderallowGlobalAccess(com.hashicorp.cdktf.IResolvable allowGlobalAccess)This field is used along with the 'backend_service' field for internal load balancing or with the 'target' field for internal TargetInstance.ComputeForwardingRule.BuilderallowGlobalAccess(Boolean allowGlobalAccess)This field is used along with the 'backend_service' field for internal load balancing or with the 'target' field for internal TargetInstance.ComputeForwardingRule.BuilderallowPscGlobalAccess(com.hashicorp.cdktf.IResolvable allowPscGlobalAccess)This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.ComputeForwardingRule.BuilderallowPscGlobalAccess(Boolean allowPscGlobalAccess)This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.ComputeForwardingRule.BuilderallPorts(com.hashicorp.cdktf.IResolvable allPorts)The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.ComputeForwardingRule.BuilderallPorts(Boolean allPorts)The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.ComputeForwardingRule.BuilderbackendService(String backendService)Identifies the backend service to which the forwarding rule sends traffic.ComputeForwardingRulebuild()ComputeForwardingRule.Builderconnection(com.hashicorp.cdktf.SSHProvisionerConnection connection)ComputeForwardingRule.Builderconnection(com.hashicorp.cdktf.WinrmProvisionerConnection connection)ComputeForwardingRule.Buildercount(com.hashicorp.cdktf.TerraformCount count)ComputeForwardingRule.Buildercount(Number count)static ComputeForwardingRule.Buildercreate(software.constructs.Construct scope, String id)ComputeForwardingRule.BuilderdependsOn(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)ComputeForwardingRule.Builderdescription(String description)An optional description of this resource.ComputeForwardingRule.BuilderforEach(com.hashicorp.cdktf.ITerraformIterator forEach)ComputeForwardingRule.Builderid(String id)Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_forwarding_rule#id ComputeForwardingRule#id}.ComputeForwardingRule.BuilderipAddress(String ipAddress)IP address for which this forwarding rule accepts traffic.ComputeForwardingRule.BuilderipProtocol(String ipProtocol)The IP protocol to which this rule applies.ComputeForwardingRule.BuilderipVersion(String ipVersion)The IP address version that will be used by this forwarding rule.ComputeForwardingRule.BuilderisMirroringCollector(com.hashicorp.cdktf.IResolvable isMirroringCollector)Indicates whether or not this load balancer can be used as a collector for packet mirroring.ComputeForwardingRule.BuilderisMirroringCollector(Boolean isMirroringCollector)Indicates whether or not this load balancer can be used as a collector for packet mirroring.ComputeForwardingRule.Builderlabels(Map<String,String> labels)Labels to apply to this forwarding rule.ComputeForwardingRule.Builderlifecycle(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)ComputeForwardingRule.BuilderloadBalancingScheme(String loadBalancingScheme)Specifies the forwarding rule type.ComputeForwardingRule.Buildername(String name)Name of the resource;ComputeForwardingRule.Buildernetwork(String network)This field is not used for external load balancing.ComputeForwardingRule.BuildernetworkTier(String networkTier)This signifies the networking tier used for configuring this load balancer and can only take the following values: 'PREMIUM', 'STANDARD'.ComputeForwardingRule.BuildernoAutomateDnsZone(com.hashicorp.cdktf.IResolvable noAutomateDnsZone)This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not.ComputeForwardingRule.BuildernoAutomateDnsZone(Boolean noAutomateDnsZone)This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not.ComputeForwardingRule.BuilderportRange(String portRange)The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.ComputeForwardingRule.Builderports(List<String> ports)The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.ComputeForwardingRule.Builderproject(String project)Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_forwarding_rule#project ComputeForwardingRule#project}.ComputeForwardingRule.Builderprovider(com.hashicorp.cdktf.TerraformProvider provider)ComputeForwardingRule.Builderprovisioners(List<? extends Object> provisioners)ComputeForwardingRule.BuilderrecreateClosedPsc(com.hashicorp.cdktf.IResolvable recreateClosedPsc)This is used in PSC consumer ForwardingRule to make terraform recreate the ForwardingRule when the status is closed.ComputeForwardingRule.BuilderrecreateClosedPsc(Boolean recreateClosedPsc)This is used in PSC consumer ForwardingRule to make terraform recreate the ForwardingRule when the status is closed.ComputeForwardingRule.Builderregion(String region)A reference to the region where the regional forwarding rule resides.ComputeForwardingRule.BuilderserviceDirectoryRegistrations(ComputeForwardingRuleServiceDirectoryRegistrations serviceDirectoryRegistrations)service_directory_registrations block.ComputeForwardingRule.BuilderserviceLabel(String serviceLabel)An optional prefix to the service name for this Forwarding Rule.ComputeForwardingRule.BuildersourceIpRanges(List<String> sourceIpRanges)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.ComputeForwardingRule.Buildersubnetwork(String subnetwork)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.ComputeForwardingRule.Buildertarget(String target)The URL of the target resource to receive the matched traffic.ComputeForwardingRule.Buildertimeouts(ComputeForwardingRuleTimeouts timeouts)timeouts block.
-
-
-
Method Detail
-
create
@Stability(Stable) public static ComputeForwardingRule.Builder create(software.constructs.Construct scope, String id)
- Parameters:
scope- The scope in which to define this construct. This parameter is required.id- The scoped construct ID. This parameter is required.- Returns:
- a new instance of
ComputeForwardingRule.Builder.
-
connection
@Stability(Experimental) public ComputeForwardingRule.Builder connection(com.hashicorp.cdktf.SSHProvisionerConnection connection)
- Parameters:
connection- This parameter is required.- Returns:
this
-
connection
@Stability(Experimental) public ComputeForwardingRule.Builder connection(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
- Parameters:
connection- This parameter is required.- Returns:
this
-
count
@Stability(Experimental) public ComputeForwardingRule.Builder count(Number count)
- Parameters:
count- This parameter is required.- Returns:
this
-
count
@Stability(Experimental) public ComputeForwardingRule.Builder count(com.hashicorp.cdktf.TerraformCount count)
- Parameters:
count- This parameter is required.- Returns:
this
-
dependsOn
@Stability(Experimental) public ComputeForwardingRule.Builder dependsOn(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
- Parameters:
dependsOn- This parameter is required.- Returns:
this
-
forEach
@Stability(Experimental) public ComputeForwardingRule.Builder forEach(com.hashicorp.cdktf.ITerraformIterator forEach)
- Parameters:
forEach- This parameter is required.- Returns:
this
-
lifecycle
@Stability(Experimental) public ComputeForwardingRule.Builder lifecycle(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
- Parameters:
lifecycle- This parameter is required.- Returns:
this
-
provider
@Stability(Experimental) public ComputeForwardingRule.Builder provider(com.hashicorp.cdktf.TerraformProvider provider)
- Parameters:
provider- This parameter is required.- Returns:
this
-
provisioners
@Stability(Experimental) public ComputeForwardingRule.Builder provisioners(List<? extends Object> provisioners)
- Parameters:
provisioners- This parameter is required.- Returns:
this
-
name
@Stability(Stable) public ComputeForwardingRule.Builder name(String name)
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](https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1-63 characters long and match the regular expression '[a-z](%5B-a-z0-9%5D*%5Ba-z0-9%5D)?' 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/5.43.1/docs/resources/compute_forwarding_rule#name ComputeForwardingRule#name}
- Parameters:
name- Name of the resource;. This parameter is required.- Returns:
this
-
allowGlobalAccess
@Stability(Stable) public ComputeForwardingRule.Builder allowGlobalAccess(Boolean allowGlobalAccess)
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/5.43.1/docs/resources/compute_forwarding_rule#allow_global_access ComputeForwardingRule#allow_global_access}
- Parameters:
allowGlobalAccess- This field is used along with the 'backend_service' field for internal load balancing or with the 'target' field for internal TargetInstance. This parameter is required.- Returns:
this
-
allowGlobalAccess
@Stability(Stable) public ComputeForwardingRule.Builder allowGlobalAccess(com.hashicorp.cdktf.IResolvable allowGlobalAccess)
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/5.43.1/docs/resources/compute_forwarding_rule#allow_global_access ComputeForwardingRule#allow_global_access}
- Parameters:
allowGlobalAccess- This field is used along with the 'backend_service' field for internal load balancing or with the 'target' field for internal TargetInstance. This parameter is required.- Returns:
this
-
allowPscGlobalAccess
@Stability(Stable) public ComputeForwardingRule.Builder allowPscGlobalAccess(Boolean allowPscGlobalAccess)
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/5.43.1/docs/resources/compute_forwarding_rule#allow_psc_global_access ComputeForwardingRule#allow_psc_global_access}
- Parameters:
allowPscGlobalAccess- This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. This parameter is required.- Returns:
this
-
allowPscGlobalAccess
@Stability(Stable) public ComputeForwardingRule.Builder allowPscGlobalAccess(com.hashicorp.cdktf.IResolvable allowPscGlobalAccess)
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/5.43.1/docs/resources/compute_forwarding_rule#allow_psc_global_access ComputeForwardingRule#allow_psc_global_access}
- Parameters:
allowPscGlobalAccess- This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. This parameter is required.- Returns:
this
-
allPorts
@Stability(Stable) public ComputeForwardingRule.Builder allPorts(Boolean allPorts)
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/5.43.1/docs/resources/compute_forwarding_rule#all_ports ComputeForwardingRule#all_ports}
- Parameters:
allPorts- The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. This parameter is required.- Returns:
this
-
allPorts
@Stability(Stable) public ComputeForwardingRule.Builder allPorts(com.hashicorp.cdktf.IResolvable allPorts)
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/5.43.1/docs/resources/compute_forwarding_rule#all_ports ComputeForwardingRule#all_ports}
- Parameters:
allPorts- The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. This parameter is required.- Returns:
this
-
backendService
@Stability(Stable) public ComputeForwardingRule.Builder backendService(String backendService)
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/5.43.1/docs/resources/compute_forwarding_rule#backend_service ComputeForwardingRule#backend_service}
- Parameters:
backendService- Identifies the backend service to which the forwarding rule sends traffic. This parameter is required.- Returns:
this
-
description
@Stability(Stable) public ComputeForwardingRule.Builder description(String description)
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/5.43.1/docs/resources/compute_forwarding_rule#description ComputeForwardingRule#description}
- Parameters:
description- An optional description of this resource. Provide this property when you create the resource. This parameter is required.- Returns:
this
-
id
@Stability(Stable) public ComputeForwardingRule.Builder id(String id)
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.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.
- Parameters:
id- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_forwarding_rule#id ComputeForwardingRule#id}. This parameter is required.- Returns:
this
-
ipAddress
@Stability(Stable) public ComputeForwardingRule.Builder ipAddress(String ipAddress)
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](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#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/5.43.1/docs/resources/compute_forwarding_rule#ip_address ComputeForwardingRule#ip_address}
- Parameters:
ipAddress- IP address for which this forwarding rule accepts traffic. This parameter is required.- Returns:
this
-
ipProtocol
@Stability(Stable) public ComputeForwardingRule.Builder ipProtocol(String ipProtocol)
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](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). 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/5.43.1/docs/resources/compute_forwarding_rule#ip_protocol ComputeForwardingRule#ip_protocol}
- Parameters:
ipProtocol- The IP protocol to which this rule applies. This parameter is required.- Returns:
this
-
ipVersion
@Stability(Stable) public ComputeForwardingRule.Builder ipVersion(String ipVersion)
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/5.43.1/docs/resources/compute_forwarding_rule#ip_version ComputeForwardingRule#ip_version}
- Parameters:
ipVersion- The IP address version that will be used by this forwarding rule. Valid options are IPV4 and IPV6. This parameter is required.- Returns:
this
-
isMirroringCollector
@Stability(Stable) public ComputeForwardingRule.Builder isMirroringCollector(Boolean isMirroringCollector)
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/5.43.1/docs/resources/compute_forwarding_rule#is_mirroring_collector ComputeForwardingRule#is_mirroring_collector}
- Parameters:
isMirroringCollector- Indicates whether or not this load balancer can be used as a collector for packet mirroring. This parameter is required.- Returns:
this
-
isMirroringCollector
@Stability(Stable) public ComputeForwardingRule.Builder isMirroringCollector(com.hashicorp.cdktf.IResolvable isMirroringCollector)
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/5.43.1/docs/resources/compute_forwarding_rule#is_mirroring_collector ComputeForwardingRule#is_mirroring_collector}
- Parameters:
isMirroringCollector- Indicates whether or not this load balancer can be used as a collector for packet mirroring. This parameter is required.- Returns:
this
-
labels
@Stability(Stable) public ComputeForwardingRule.Builder labels(Map<String,String> labels)
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/5.43.1/docs/resources/compute_forwarding_rule#labels ComputeForwardingRule#labels}
- Parameters:
labels- Labels to apply to this forwarding rule. A list of key->value pairs. This parameter is required.- Returns:
this
-
loadBalancingScheme
@Stability(Stable) public ComputeForwardingRule.Builder loadBalancingScheme(String loadBalancingScheme)
Specifies the forwarding rule type.For more information about forwarding rules, refer to [Forwarding rule concepts](https://cloud.google.com/load-balancing/docs/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/5.43.1/docs/resources/compute_forwarding_rule#load_balancing_scheme ComputeForwardingRule#load_balancing_scheme}
- Parameters:
loadBalancingScheme- Specifies the forwarding rule type. This parameter is required.- Returns:
this
-
network
@Stability(Stable) public ComputeForwardingRule.Builder network(String network)
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/5.43.1/docs/resources/compute_forwarding_rule#network ComputeForwardingRule#network}
- Parameters:
network- This field is not used for external load balancing. This parameter is required.- Returns:
this
-
networkTier
@Stability(Stable) public ComputeForwardingRule.Builder networkTier(String networkTier)
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/5.43.1/docs/resources/compute_forwarding_rule#network_tier ComputeForwardingRule#network_tier}
- Parameters:
networkTier- This signifies the networking tier used for configuring this load balancer and can only take the following values: 'PREMIUM', 'STANDARD'. This parameter is required.- Returns:
this
-
noAutomateDnsZone
@Stability(Stable) public ComputeForwardingRule.Builder noAutomateDnsZone(Boolean noAutomateDnsZone)
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/5.43.1/docs/resources/compute_forwarding_rule#no_automate_dns_zone ComputeForwardingRule#no_automate_dns_zone}
- Parameters:
noAutomateDnsZone- This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. This parameter is required.- Returns:
this
-
noAutomateDnsZone
@Stability(Stable) public ComputeForwardingRule.Builder noAutomateDnsZone(com.hashicorp.cdktf.IResolvable noAutomateDnsZone)
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/5.43.1/docs/resources/compute_forwarding_rule#no_automate_dns_zone ComputeForwardingRule#no_automate_dns_zone}
- Parameters:
noAutomateDnsZone- This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. This parameter is required.- Returns:
this
-
portRange
@Stability(Stable) public ComputeForwardingRule.Builder portRange(String portRange)
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.
- Parameters:
portRange- The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. This parameter is required.- Returns:
this
-
ports
@Stability(Stable) public ComputeForwardingRule.Builder ports(List<String> ports)
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.
- Parameters:
ports- The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive. This parameter is required.- Returns:
this
-
project
@Stability(Stable) public ComputeForwardingRule.Builder project(String project)
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_forwarding_rule#project ComputeForwardingRule#project}.- Parameters:
project- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_forwarding_rule#project ComputeForwardingRule#project}. This parameter is required.- Returns:
this
-
recreateClosedPsc
@Stability(Stable) public ComputeForwardingRule.Builder recreateClosedPsc(Boolean recreateClosedPsc)
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/5.43.1/docs/resources/compute_forwarding_rule#recreate_closed_psc ComputeForwardingRule#recreate_closed_psc}
- Parameters:
recreateClosedPsc- This is used in PSC consumer ForwardingRule to make terraform recreate the ForwardingRule when the status is closed. This parameter is required.- Returns:
this
-
recreateClosedPsc
@Stability(Stable) public ComputeForwardingRule.Builder recreateClosedPsc(com.hashicorp.cdktf.IResolvable recreateClosedPsc)
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/5.43.1/docs/resources/compute_forwarding_rule#recreate_closed_psc ComputeForwardingRule#recreate_closed_psc}
- Parameters:
recreateClosedPsc- This is used in PSC consumer ForwardingRule to make terraform recreate the ForwardingRule when the status is closed. This parameter is required.- Returns:
this
-
region
@Stability(Stable) public ComputeForwardingRule.Builder region(String region)
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/5.43.1/docs/resources/compute_forwarding_rule#region ComputeForwardingRule#region}
- Parameters:
region- A reference to the region where the regional forwarding rule resides. This parameter is required.- Returns:
this
-
serviceDirectoryRegistrations
@Stability(Stable) public ComputeForwardingRule.Builder serviceDirectoryRegistrations(ComputeForwardingRuleServiceDirectoryRegistrations serviceDirectoryRegistrations)
service_directory_registrations block.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_forwarding_rule#service_directory_registrations ComputeForwardingRule#service_directory_registrations}
- Parameters:
serviceDirectoryRegistrations- service_directory_registrations block. This parameter is required.- Returns:
this
-
serviceLabel
@Stability(Stable) public ComputeForwardingRule.Builder serviceLabel(String serviceLabel)
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](%5B-a-z0-9%5D*%5Ba-z0-9%5D)?' 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/5.43.1/docs/resources/compute_forwarding_rule#service_label ComputeForwardingRule#service_label}
- Parameters:
serviceLabel- An optional prefix to the service name for this Forwarding Rule. This parameter is required.- Returns:
this
-
sourceIpRanges
@Stability(Stable) public ComputeForwardingRule.Builder sourceIpRanges(List<String> sourceIpRanges)
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/5.43.1/docs/resources/compute_forwarding_rule#source_ip_ranges ComputeForwardingRule#source_ip_ranges}
- Parameters:
sourceIpRanges- 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. This parameter is required.- Returns:
this
-
subnetwork
@Stability(Stable) public ComputeForwardingRule.Builder subnetwork(String subnetwork)
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/5.43.1/docs/resources/compute_forwarding_rule#subnetwork ComputeForwardingRule#subnetwork}
- Parameters:
subnetwork- 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. This parameter is required.- Returns:
this
-
target
@Stability(Stable) public ComputeForwardingRule.Builder target(String target)
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](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_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](https://cloud.google.com/vpc-service-controls/docs/supported-products). * 'all-apis' - [All supported Google APIs](https://cloud.google.com/vpc/docs/private-service-connect#supported-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/5.43.1/docs/resources/compute_forwarding_rule#target ComputeForwardingRule#target}
- Parameters:
target- The URL of the target resource to receive the matched traffic. This parameter is required.- Returns:
this
-
timeouts
@Stability(Stable) public ComputeForwardingRule.Builder timeouts(ComputeForwardingRuleTimeouts timeouts)
timeouts block.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_forwarding_rule#timeouts ComputeForwardingRule#timeouts}
- Parameters:
timeouts- timeouts block. This parameter is required.- Returns:
this
-
build
@Stability(Stable) public ComputeForwardingRule build()
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<ComputeForwardingRule>- Returns:
- a newly built instance of
ComputeForwardingRule.
-
-