pulumi-gcp-kotlin/com.pulumi.gcp.compute.kotlin.outputs/GetForwardingRulesRule

GetForwardingRulesRule

data class GetForwardingRulesRule(val allPorts: Boolean, val allowGlobalAccess: Boolean, val allowPscGlobalAccess: Boolean, val backendService: String, val baseForwardingRule: String, val creationTimestamp: String, val description: String, val effectiveLabels: Map<String, String>, val ipAddress: String, val ipProtocol: String, val ipVersion: String, val isMirroringCollector: Boolean, val labelFingerprint: String, val labels: Map<String, String>, val loadBalancingScheme: String, val name: String, val network: String, val networkTier: String, val noAutomateDnsZone: Boolean, val portRange: String, val ports: List<String>, val project: String, val pscConnectionId: String, val pscConnectionStatus: String, val pulumiLabels: Map<String, String>, val recreateClosedPsc: Boolean, val region: String, val selfLink: String, val serviceDirectoryRegistrations: List<GetForwardingRulesRuleServiceDirectoryRegistration>, val serviceLabel: String, val serviceName: String, val sourceIpRanges: List<String>, val subnetwork: String, val target: String)

Constructors

constructor(allPorts: Boolean, allowGlobalAccess: Boolean, allowPscGlobalAccess: Boolean, backendService: String, baseForwardingRule: String, creationTimestamp: String, description: String, effectiveLabels: Map<String, String>, ipAddress: String, ipProtocol: String, ipVersion: String, isMirroringCollector: Boolean, labelFingerprint: String, labels: Map<String, String>, loadBalancingScheme: String, name: String, network: String, networkTier: String, noAutomateDnsZone: Boolean, portRange: String, ports: List<String>, project: String, pscConnectionId: String, pscConnectionStatus: String, pulumiLabels: Map<String, String>, recreateClosedPsc: Boolean, region: String, selfLink: String, serviceDirectoryRegistrations: List<GetForwardingRulesRuleServiceDirectoryRegistration>, serviceLabel: String, serviceName: String, sourceIpRanges: List<String>, subnetwork: String, target: String)

Types

Companion

object Companion

Properties

allowGlobalAccess

val allowGlobalAccess: Boolean

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.

allowPscGlobalAccess

val allowPscGlobalAccess: Boolean

This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

allPorts

val allPorts: Boolean

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:

backendService

val backendService: 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.

baseForwardingRule

val baseForwardingRule: 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.

creationTimestamp

val creationTimestamp: String

Creation timestamp in RFC3339 text format.

description

val description: String

An optional description of this resource. Provide this property when you create the resource.

effectiveLabels

val effectiveLabels: Map<String, String>

ipAddress

val ipAddress: 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:

ipProtocol

val ipProtocol: 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

ipVersion

val ipVersion: 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"

isMirroringCollector

val isMirroringCollector: Boolean

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

labelFingerprint

val labelFingerprint: String

The fingerprint used for optimistic locking of this resource. Used internally during updates.

labels

val labels: Map<String, String>

Labels to apply to this forwarding rule. A list of key->value pairs. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

loadBalancingScheme

val loadBalancingScheme: 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"

name

val name: 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.

network

val network: 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.

networkTier

val networkTier: 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"

noAutomateDnsZone

val noAutomateDnsZone: Boolean

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

val portRange: String

ports

val ports: List<String>

project

val project: String

The name of the project.

pscConnectionId

val pscConnectionId: String

The PSC connection id of the PSC Forwarding Rule.

pscConnectionStatus

val pscConnectionStatus: String

The PSC connection status of the PSC Forwarding Rule. Possible values: 'STATUS_UNSPECIFIED', 'PENDING', 'ACCEPTED', 'REJECTED', 'CLOSED'

pulumiLabels

val pulumiLabels: Map<String, String>

The combination of labels configured directly on the resource and default labels configured on the provider.

recreateClosedPsc

val recreateClosedPsc: Boolean

region

val region: String

The region you want to get the forwarding rules from. These arguments must be set in either the provider or the resouce in order for the information to be queried.

selfLink

val selfLink: String

The URI of the resource.

serviceDirectoryRegistrations

val serviceDirectoryRegistrations: List<GetForwardingRulesRuleServiceDirectoryRegistration>

Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.

serviceLabel

val serviceLabel: 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.

serviceName

val serviceName: String

The internal fully qualified service name for this Forwarding Rule. This field is only used for INTERNAL load balancing.

sourceIpRanges

val sourceIpRanges: 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).

subnetwork

val subnetwork: String

This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. 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.

target

val target: 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.