• Home
• org.virtuslab
• pulumi-google-native-kotlin
• 0.31.1.2
• source code
• UrlMap.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.pulumi.googlenative.compute.alpha.kotlin.UrlMap.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.googlenative.compute.alpha.kotlin

import com.pulumi.core.Output
import com.pulumi.googlenative.compute.alpha.kotlin.outputs.CustomErrorResponsePolicyResponse
import com.pulumi.googlenative.compute.alpha.kotlin.outputs.HostRuleResponse
import com.pulumi.googlenative.compute.alpha.kotlin.outputs.HttpHeaderActionResponse
import com.pulumi.googlenative.compute.alpha.kotlin.outputs.HttpRedirectActionResponse
import com.pulumi.googlenative.compute.alpha.kotlin.outputs.HttpRouteActionResponse
import com.pulumi.googlenative.compute.alpha.kotlin.outputs.PathMatcherResponse
import com.pulumi.googlenative.compute.alpha.kotlin.outputs.UrlMapTestResponse
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 com.pulumi.googlenative.compute.alpha.kotlin.outputs.CustomErrorResponsePolicyResponse.Companion.toKotlin as customErrorResponsePolicyResponseToKotlin
import com.pulumi.googlenative.compute.alpha.kotlin.outputs.HostRuleResponse.Companion.toKotlin as hostRuleResponseToKotlin
import com.pulumi.googlenative.compute.alpha.kotlin.outputs.HttpHeaderActionResponse.Companion.toKotlin as httpHeaderActionResponseToKotlin
import com.pulumi.googlenative.compute.alpha.kotlin.outputs.HttpRedirectActionResponse.Companion.toKotlin as httpRedirectActionResponseToKotlin
import com.pulumi.googlenative.compute.alpha.kotlin.outputs.HttpRouteActionResponse.Companion.toKotlin as httpRouteActionResponseToKotlin
import com.pulumi.googlenative.compute.alpha.kotlin.outputs.PathMatcherResponse.Companion.toKotlin as pathMatcherResponseToKotlin
import com.pulumi.googlenative.compute.alpha.kotlin.outputs.UrlMapTestResponse.Companion.toKotlin as urlMapTestResponseToKotlin

/**
 * Builder for [UrlMap].
 */
@PulumiTagMarker
public class UrlMapResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: UrlMapArgs = UrlMapArgs()

    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 UrlMapArgsBuilder.() -> Unit) {
        val builder = UrlMapArgsBuilder()
        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(): UrlMap {
        val builtJavaResource = com.pulumi.googlenative.compute.alpha.UrlMap(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return UrlMap(builtJavaResource)
    }
}

/**
 * Creates a UrlMap resource in the specified project using the data included in the request.
 */
public class UrlMap internal constructor(
    override val javaResource: com.pulumi.googlenative.compute.alpha.UrlMap,
) : KotlinCustomResource(javaResource, UrlMapMapper) {
    /**
     * Creation timestamp in RFC3339 text format.
     */
    public val creationTimestamp: Output
        get() = javaResource.creationTimestamp().applyValue({ args0 -> args0 })

    /**
     * defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceor BackendBucket responds with an error. This policy takes effect at the Load Balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for *.example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a 404, the policy in pathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a 502, the policy in UrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a 404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for Global External HTTP(S) load balancing.
     */
    public val defaultCustomErrorResponsePolicy: Output
        get() = javaResource.defaultCustomErrorResponsePolicy().applyValue({ args0 ->
            args0.let({ args0 ->
                customErrorResponsePolicyResponseToKotlin(args0)
            })
        })

    /**
     * defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
     */
    public val defaultRouteAction: Output
        get() = javaResource.defaultRouteAction().applyValue({ args0 ->
            args0.let({ args0 ->
                httpRouteActionResponseToKotlin(args0)
            })
        })

    /**
     * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
     */
    public val defaultService: Output
        get() = javaResource.defaultService().applyValue({ args0 -> args0 })

    /**
     * When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy.
     */
    public val defaultUrlRedirect: Output
        get() = javaResource.defaultUrlRedirect().applyValue({ args0 ->
            args0.let({ args0 ->
                httpRedirectActionResponseToKotlin(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 is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap.
     */
    public val fingerprint: Output
        get() = javaResource.fingerprint().applyValue({ args0 -> args0 })

    /**
     * Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.
     */
    public val headerAction: Output
        get() = javaResource.headerAction().applyValue({ args0 ->
            args0.let({ args0 ->
                httpHeaderActionResponseToKotlin(args0)
            })
        })

    /**
     * The list of host rules to use against the URL.
     */
    public val hostRules: Output>
        get() = javaResource.hostRules().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    hostRuleResponseToKotlin(args0)
                })
            })
        })

    /**
     * Type of the resource. Always compute#urlMaps for url maps.
     */
    public val kind: Output
        get() = javaResource.kind().applyValue({ args0 -> 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.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The list of named PathMatchers to use against the URL.
     */
    public val pathMatchers: Output>
        get() = javaResource.pathMatchers().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    pathMatcherResponseToKotlin(args0)
                })
            })
        })

    public val project: Output
        get() = javaResource.project().applyValue({ args0 -> args0 })

    /**
     * URL of the region where the regional URL map resides. This field is not applicable to global URL maps. 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 })

    /**
     * The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.
     */
    public val tests: Output>
        get() = javaResource.tests().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    urlMapTestResponseToKotlin(args0)
                })
            })
        })
}

public object UrlMapMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.googlenative.compute.alpha.UrlMap::class == javaResource::class

    override fun map(javaResource: Resource): UrlMap = UrlMap(
        javaResource as
            com.pulumi.googlenative.compute.alpha.UrlMap,
    )
}

/**
 * @see [UrlMap].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [UrlMap].
 */
public suspend fun urlMap(name: String, block: suspend UrlMapResourceBuilder.() -> Unit): UrlMap {
    val builder = UrlMapResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [UrlMap].
 * @param name The _unique_ name of the resulting resource.
 */
public fun urlMap(name: String): UrlMap {
    val builder = UrlMapResourceBuilder()
    builder.name(name)
    return builder.build()
}