com.pulumi.googlenative.compute.v1.kotlin.GlobalForwardingRule.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.googlenative.compute.v1.kotlin
import com.pulumi.core.Output
import com.pulumi.googlenative.compute.v1.kotlin.outputs.ForwardingRuleServiceDirectoryRegistrationResponse
import com.pulumi.googlenative.compute.v1.kotlin.outputs.MetadataFilterResponse
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import com.pulumi.googlenative.compute.v1.kotlin.outputs.ForwardingRuleServiceDirectoryRegistrationResponse.Companion.toKotlin as forwardingRuleServiceDirectoryRegistrationResponseToKotlin
import com.pulumi.googlenative.compute.v1.kotlin.outputs.MetadataFilterResponse.Companion.toKotlin as metadataFilterResponseToKotlin
/**
* Builder for [GlobalForwardingRule].
*/
@PulumiTagMarker
public class GlobalForwardingRuleResourceBuilder internal constructor() {
public var name: String? = null
public var args: GlobalForwardingRuleArgs = GlobalForwardingRuleArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend GlobalForwardingRuleArgsBuilder.() -> Unit) {
val builder = GlobalForwardingRuleArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): GlobalForwardingRule {
val builtJavaResource =
com.pulumi.googlenative.compute.v1.GlobalForwardingRule(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return GlobalForwardingRule(builtJavaResource)
}
}
/**
* Creates a GlobalForwardingRule resource in the specified project using the data included in the request.
*/
public class GlobalForwardingRule internal constructor(
override val javaResource: com.pulumi.googlenative.compute.v1.GlobalForwardingRule,
) : KotlinCustomResource(javaResource, GlobalForwardingRuleMapper) {
/**
* This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based 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 ports, port_range, and allPorts fields are mutually exclusive.
*/
public val allPorts: Output
get() = javaResource.allPorts().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val allowGlobalAccess: Output
get() = javaResource.allowGlobalAccess().applyValue({ args0 -> args0 })
/**
* This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
*/
public val allowPscGlobalAccess: Output
get() = javaResource.allowPscGlobalAccess().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val backendService: Output
get() = javaResource.backendService().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val baseForwardingRule: Output
get() = javaResource.baseForwardingRule().applyValue({ args0 -> args0 })
/**
* Creation timestamp in RFC3339 text format.
*/
public val creationTimestamp: Output
get() = javaResource.creationTimestamp().applyValue({ args0 -> args0 })
/**
* An optional description of this resource. Provide this property when you create the resource.
*/
public val description: Output
get() = javaResource.description().applyValue({ args0 -> args0 })
/**
* Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
*/
public val fingerprint: Output
get() = javaResource.fingerprint().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val ipAddress: Output
get() = javaResource.ipAddress().applyValue({ args0 -> args0 })
/**
* 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).
*/
public val ipProtocol: Output
get() = javaResource.ipProtocol().applyValue({ args0 -> args0 })
/**
* The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.
*/
public val ipVersion: Output
get() = javaResource.ipVersion().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val isMirroringCollector: Output
get() = javaResource.isMirroringCollector().applyValue({ args0 -> args0 })
/**
* Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.
*/
public val kind: Output
get() = javaResource.kind().applyValue({ args0 -> args0 })
/**
* A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.
*/
public val labelFingerprint: Output
get() = javaResource.labelFingerprint().applyValue({ args0 -> args0 })
/**
* Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
*/
public val labels: Output>
get() = javaResource.labels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.
*/
public val loadBalancingScheme: Output
get() = javaResource.loadBalancingScheme().applyValue({ args0 -> args0 })
/**
* Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
*/
public val metadataFilters: Output>
get() = javaResource.metadataFilters().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> metadataFilterResponseToKotlin(args0) })
})
})
/**
* 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]([-a-z0-9]*[a-z0-9])?` 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.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val network: Output
get() = javaResource.network().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val networkTier: Output
get() = javaResource.networkTier().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val noAutomateDnsZone: Output
get() = javaResource.noAutomateDnsZone().applyValue({ args0 -> args0 })
/**
* This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. 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 portRanges. @pattern: \\d+(?:-\\d+)?
*/
public val portRange: Output
get() = javaResource.portRange().applyValue({ args0 -> args0 })
/**
* This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based 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. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)?
*/
public val ports: Output>
get() = javaResource.ports().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
public val project: Output
get() = javaResource.project().applyValue({ args0 -> args0 })
/**
* The PSC connection id of the PSC Forwarding Rule.
*/
public val pscConnectionId: Output
get() = javaResource.pscConnectionId().applyValue({ args0 -> args0 })
public val pscConnectionStatus: Output
get() = javaResource.pscConnectionStatus().applyValue({ args0 -> args0 })
/**
* URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
*/
public val region: Output
get() = javaResource.region().applyValue({ args0 -> args0 })
/**
* An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*/
public val requestId: Output?
get() = javaResource.requestId().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Server-defined URL for the resource.
*/
public val selfLink: Output
get() = javaResource.selfLink().applyValue({ args0 -> args0 })
/**
* Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
*/
public val serviceDirectoryRegistrations:
Output>
get() = javaResource.serviceDirectoryRegistrations().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> forwardingRuleServiceDirectoryRegistrationResponseToKotlin(args0) })
})
})
/**
* An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is 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]([-a-z0-9]*[a-z0-9])?` 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.
*/
public val serviceLabel: Output
get() = javaResource.serviceLabel().applyValue({ args0 -> args0 })
/**
* The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing.
*/
public val serviceName: Output
get() = javaResource.serviceName().applyValue({ args0 -> args0 })
/**
* 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 source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
*/
public val sourceIpRanges: Output>
get() = javaResource.sourceIpRanges().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
/**
* 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.
*/
public val subnetwork: Output
get() = javaResource.subnetwork().applyValue({ args0 -> args0 })
/**
* 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. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.
*/
public val target: Output
get() = javaResource.target().applyValue({ args0 -> args0 })
}
public object GlobalForwardingRuleMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.googlenative.compute.v1.GlobalForwardingRule::class == javaResource::class
override fun map(javaResource: Resource): GlobalForwardingRule = GlobalForwardingRule(
javaResource
as com.pulumi.googlenative.compute.v1.GlobalForwardingRule,
)
}
/**
* @see [GlobalForwardingRule].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [GlobalForwardingRule].
*/
public suspend fun globalForwardingRule(
name: String,
block: suspend GlobalForwardingRuleResourceBuilder.() -> Unit,
): GlobalForwardingRule {
val builder = GlobalForwardingRuleResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [GlobalForwardingRule].
* @param name The _unique_ name of the resulting resource.
*/
public fun globalForwardingRule(name: String): GlobalForwardingRule {
val builder = GlobalForwardingRuleResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy