GetForwardingRulesRule class
Constructors
-
GetForwardingRulesRule({required Input<bool> allPorts, required Input<bool> allowGlobalAccess, required Input<bool> allowPscGlobalAccess, required Input<String> backendService, required Input<String> baseForwardingRule, required Input<String> creationTimestamp, required Input<String> deletionPolicy, required Input<String> description, required Input<Map<String, String>> effectiveLabels, required Input<int> forwardingRuleId, required Input<String> ipAddress, required Input<String> ipCollection, required Input<String> ipProtocol, required Input<String> ipVersion, required Input<bool> isMirroringCollector, required Input<String> labelFingerprint, required Input<Map<String, String>> labels, required Input<String> loadBalancingScheme, required Input<String> name, required Input<String> network, required Input<String> networkTier, required Input<bool> noAutomateDnsZone, required Input<String> portRange, required Input<List<String>> ports, required Input<String> project, required Input<String> pscConnectionId, required Input<String> pscConnectionStatus, required Input<Map<String, String>> pulumiLabels, required Input<bool> recreateClosedPsc, required Input<String> region, required Input<String> selfLink, required Input<List<GetForwardingRulesRuleServiceDirectoryRegistration>> serviceDirectoryRegistrations, required Input<String> serviceLabel, required Input<String> serviceName, required Input<List<String>> sourceIpRanges, required Input<String> subnetwork, required Input<String> target})
-
Creates a new GetForwardingRulesRule.
allPorts The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
allowGlobalAccess This field is used along with the 'backend_service' field for
allowPscGlobalAccess This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
backendService Identifies the backend service to which the forwarding rule sends traffic.
baseForwardingRule Output Only The URL for the corresponding base Forwarding Rule. By base Forwarding Rule, we mean the Forwarding Rule that has the same IP address, protocol, and port settings with the current Forwarding Rule, but without sourceIPRanges specified. Always empty if the current Forwarding Rule does not have sourceIPRanges specified.
creationTimestamp Creation timestamp in RFC3339 text format.
deletionPolicy Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE".
description An optional description of this resource. Provide this property when
effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services.
forwardingRuleId The unique identifier number for the resource. This identifier is defined by the server.
ipAddress IP address for which this forwarding rule accepts traffic. When a client
ipCollection Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP
ipProtocol The IP protocol to which this rule applies.
ipVersion The IP address version that will be used by this forwarding rule.
isMirroringCollector Indicates whether or not this load balancer can be used as a collector for
labelFingerprint The fingerprint used for optimistic locking of this resource. Used
labels Labels to apply to this forwarding rule. A list of key->value pairs.
loadBalancingScheme Specifies the forwarding rule type.
name Name of the resource; provided by the client when the resource is created.
network This field is not used for external load balancing.
networkTier This signifies the networking tier used for configuring
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.
portRange The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
ports The 'ports', 'portRange', and 'allPorts' fields are mutually exclusive.
project The name of the project.
pscConnectionId The PSC connection id of the PSC Forwarding Rule.
pscConnectionStatus The PSC connection status of the PSC Forwarding Rule. Possible values: 'STATUS_UNSPECIFIED', 'PENDING', 'ACCEPTED', 'REJECTED', 'CLOSED'
pulumiLabels The combination of labels configured directly on the resource
recreateClosedPsc This is used in PSC consumer ForwardingRule to make terraform recreate the ForwardingRule when the status is closed
region The region you want to get the forwarding rules from.
selfLink The URI of the resource.
serviceDirectoryRegistrations Service Directory resources to register this forwarding rule with.
serviceLabel An optional prefix to the service name for this Forwarding Rule.
serviceName The internal fully qualified service name for this Forwarding Rule.
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).
subnetwork This field identifies the subnetwork that the load balanced IP should
target The URL of the target resource to receive the matched traffic. For
const
-
GetForwardingRulesRule.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
allowGlobalAccess
→ Input<bool>
-
This field is used along with the 'backend_service' field for
internal load balancing or with the 'target' field for internal
TargetInstance.
final
-
allowPscGlobalAccess
→ Input<bool>
-
This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
final
-
allPorts
→ Input<bool>
-
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.
final
-
backendService
→ Input<String>
-
Identifies the backend service to which the forwarding rule sends traffic.
final
-
baseForwardingRule
→ Input<String>
-
Output Only The URL for the corresponding base Forwarding Rule. By base Forwarding Rule, we mean the Forwarding Rule that has the same IP address, protocol, and port settings with the current Forwarding Rule, but without sourceIPRanges specified. Always empty if the current Forwarding Rule does not have sourceIPRanges specified.
final
-
creationTimestamp
→ Input<String>
-
Creation timestamp in RFC3339 text format.
final
-
deletionPolicy
→ Input<String>
-
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE".
When a 'terraform destroy' or 'terraform apply' would delete the instance,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
final
-
description
→ Input<String>
-
An optional description of this resource. Provide this property when
you create the resource.
final
-
effectiveLabels
→ Input<Map<String, String>>
-
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services.
final
-
forwardingRuleId
→ Input<int>
-
The unique identifier number for the resource. This identifier is defined by the server.
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
ipAddress
→ Input<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'.
final
-
ipCollection
→ Input<String>
-
Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP
in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.
Use one of the following formats to specify a sub-PDP when creating an
IPv6 NetLB forwarding rule using BYOIP:
Full resource URL, as in:
final
-
ipProtocol
→ Input<String>
-
The IP protocol to which this rule applies.
final
-
ipVersion
→ Input<String>
-
The IP address version that will be used by this forwarding rule.
Valid options are IPV4 and IPV6.
final
-
isMirroringCollector
→ Input<bool>
-
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.
final
-
labelFingerprint
→ Input<String>
-
The fingerprint used for optimistic locking of this resource. Used
internally during updates.
final
-
labels
→ Input<Map<String, String>>
-
Labels to apply to this forwarding rule. A list of key->value pairs.
final
-
loadBalancingScheme
→ Input<String>
-
Specifies the forwarding rule type.
final
-
name
→ Input<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.
final
-
network
→ Input<String>
-
This field is not used for external load balancing.
final
-
networkTier
→ Input<String>
-
This signifies the networking tier used for configuring
this load balancer and can only take the following values:
'PREMIUM', 'STANDARD'.
final
-
noAutomateDnsZone
→ Input<bool>
-
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.
final
-
portRange
→ Input<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.
final
-
ports
→ Input<List<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.
final
-
project
→ Input<String>
-
The name of the project.
final
-
pscConnectionId
→ Input<String>
-
The PSC connection id of the PSC Forwarding Rule.
final
-
pscConnectionStatus
→ Input<String>
-
The PSC connection status of the PSC Forwarding Rule. Possible values: 'STATUS_UNSPECIFIED', 'PENDING', 'ACCEPTED', 'REJECTED', 'CLOSED'
final
-
pulumiLabels
→ Input<Map<String, String>>
-
The combination of labels configured directly on the resource
and default labels configured on the provider.
final
-
recreateClosedPsc
→ Input<bool>
-
This is used in PSC consumer ForwardingRule to make terraform recreate the ForwardingRule when the status is closed
final
-
region
→ Input<String>
-
The region you want to get the forwarding rules from.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
selfLink
→ Input<String>
-
The URI of the resource.
final
-
serviceDirectoryRegistrations
→ Input<List<GetForwardingRulesRuleServiceDirectoryRegistration>>
-
Service Directory resources to register this forwarding rule with.
final
-
serviceLabel
→ Input<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.
final
-
serviceName
→ Input<String>
-
The internal fully qualified service name for this Forwarding Rule.
final
-
sourceIpRanges
→ Input<List<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).
final
-
subnetwork
→ Input<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.
final
-
target
→ Input<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.
final
