com.pulumi.kubernetes.networking.v1.kotlin.IngressArgs.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-kubernetes-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
The newest version!
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.kubernetes.networking.v1.kotlin

import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import com.pulumi.kubernetes.meta.v1.kotlin.inputs.ObjectMetaArgs
import com.pulumi.kubernetes.meta.v1.kotlin.inputs.ObjectMetaArgsBuilder
import com.pulumi.kubernetes.networking.v1.IngressArgs.builder
import com.pulumi.kubernetes.networking.v1.kotlin.inputs.IngressSpecArgs
import com.pulumi.kubernetes.networking.v1.kotlin.inputs.IngressSpecArgsBuilder
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.jvm.JvmName

/**
 * Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.
 * This resource waits until its status is ready before registering success
 * for create/update, and populating output properties from the current state of the resource.
 * The following conditions are used to determine whether the resource creation has
 * succeeded or failed:
 * 1.  Ingress object exists.
 * 2.  Endpoint objects exist with matching names for each Ingress path (except when Service
 *     type is ExternalName).
 * 3.  Ingress entry exists for '.status.loadBalancer.ingress'.
 * If the Ingress has not reached a Ready state after 10 minutes, it will
 * time out and mark the resource update as Failed. You can override the default timeout value
 * by setting the 'customTimeouts' option on the resource.
 * ## Example Usage
 * ### Create an Ingress with auto-naming
 * ```java
 * package generated_program;
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.kubernetes.networking.k8s.io_v1.Ingress;
 * import com.pulumi.kubernetes.networking.k8s.io_v1.IngressArgs;
 * import com.pulumi.kubernetes.meta_v1.inputs.ObjectMetaArgs;
 * import com.pulumi.kubernetes.networking.k8s.io_v1.inputs.IngressSpecArgs;
 * import java.util.List;
 * import java.util.ArrayList;
 * import java.util.Map;
 * import java.io.File;
 * import java.nio.file.Files;
 * import java.nio.file.Paths;
 * public class App {
 *     public static void main(String[] args) {
 *         Pulumi.run(App::stack);
 *     }
 *     public static void stack(Context ctx) {
 *         var ingress = new Ingress("ingress", IngressArgs.builder()
 *             .metadata(ObjectMetaArgs.builder()
 *                 .annotations(Map.of("nginx.ingress.kubernetes.io/rewrite-target", "/"))
 *                 .build())
 *             .spec(IngressSpecArgs.builder()
 *                 .rules(IngressRuleArgs.builder()
 *                     .http(HTTPIngressRuleValueArgs.builder()
 *                         .paths(HTTPIngressPathArgs.builder()
 *                             .backend(IngressBackendArgs.builder()
 *                                 .service(IngressServiceBackendArgs.builder()
 *                                     .name("test")
 *                                     .port(ServiceBackendPortArgs.builder()
 *                                         .number(80)
 *                                         .build())
 *                                     .build())
 *                                 .build())
 *                             .path("/testpath")
 *                             .pathType("Prefix")
 *                             .build())
 *                         .build())
 *                     .build())
 *                 .build())
 *             .build());
 *     }
 * }
 * ```
 * ### Create an Ingress with a user-specified name
 * ```java
 * package generated_program;
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.kubernetes.networking.k8s.io_v1.Ingress;
 * import com.pulumi.kubernetes.networking.k8s.io_v1.IngressArgs;
 * import com.pulumi.kubernetes.meta_v1.inputs.ObjectMetaArgs;
 * import com.pulumi.kubernetes.networking.k8s.io_v1.inputs.IngressSpecArgs;
 * import java.util.List;
 * import java.util.ArrayList;
 * import java.util.Map;
 * import java.io.File;
 * import java.nio.file.Files;
 * import java.nio.file.Paths;
 * public class App {
 *     public static void main(String[] args) {
 *         Pulumi.run(App::stack);
 *     }
 *     public static void stack(Context ctx) {
 *         var ingress = new Ingress("ingress", IngressArgs.builder()
 *             .metadata(ObjectMetaArgs.builder()
 *                 .annotations(Map.of("nginx.ingress.kubernetes.io/rewrite-target", "/"))
 *                 .name("minimal-ingress")
 *                 .build())
 *             .spec(IngressSpecArgs.builder()
 *                 .rules(IngressRuleArgs.builder()
 *                     .http(HTTPIngressRuleValueArgs.builder()
 *                         .paths(HTTPIngressPathArgs.builder()
 *                             .backend(IngressBackendArgs.builder()
 *                                 .service(IngressServiceBackendArgs.builder()
 *                                     .name("test")
 *                                     .port(ServiceBackendPortArgs.builder()
 *                                         .number(80)
 *                                         .build())
 *                                     .build())
 *                                 .build())
 *                             .path("/testpath")
 *                             .pathType("Prefix")
 *                             .build())
 *                         .build())
 *                     .build())
 *                 .build())
 *             .build());
 *     }
 * }
 * ```
 * @property apiVersion APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
 * @property kind Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
 * @property metadata Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
 * @property spec spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
 */
public data class IngressArgs(
    public val apiVersion: Output? = null,
    public val kind: Output? = null,
    public val metadata: Output? = null,
    public val spec: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.kubernetes.networking.v1.IngressArgs =
        com.pulumi.kubernetes.networking.v1.IngressArgs.builder()
            .apiVersion(apiVersion?.applyValue({ args0 -> args0 }))
            .kind(kind?.applyValue({ args0 -> args0 }))
            .metadata(metadata?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .spec(spec?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) })).build()
}

/**
 * Builder for [IngressArgs].
 */
@PulumiTagMarker
public class IngressArgsBuilder internal constructor() {
    private var apiVersion: Output? = null

    private var kind: Output? = null

    private var metadata: Output? = null

    private var spec: Output? = null

    /**
     * @param value APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
     */
    @JvmName("shmlyywunjxkbutg")
    public suspend fun apiVersion(`value`: Output) {
        this.apiVersion = value
    }

    /**
     * @param value Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
     */
    @JvmName("irohoapmhdsppfta")
    public suspend fun kind(`value`: Output) {
        this.kind = value
    }

    /**
     * @param value Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
     */
    @JvmName("cvnomvwrjcyuiapb")
    public suspend fun metadata(`value`: Output) {
        this.metadata = value
    }

    /**
     * @param value spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
     */
    @JvmName("njcxbvgqisouesqq")
    public suspend fun spec(`value`: Output) {
        this.spec = value
    }

    /**
     * @param value APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
     */
    @JvmName("xlkfofokpiwrtskv")
    public suspend fun apiVersion(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.apiVersion = mapped
    }

    /**
     * @param value Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
     */
    @JvmName("arebqerjlwjqbgeq")
    public suspend fun kind(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.kind = mapped
    }

    /**
     * @param value Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
     */
    @JvmName("booaivlkrtseneqv")
    public suspend fun metadata(`value`: ObjectMetaArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.metadata = mapped
    }

    /**
     * @param argument Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
     */
    @JvmName("wxbepwhjjlojnbwc")
    public suspend fun metadata(argument: suspend ObjectMetaArgsBuilder.() -> Unit) {
        val toBeMapped = ObjectMetaArgsBuilder().applySuspend { argument() }.build()
        val mapped = of(toBeMapped)
        this.metadata = mapped
    }

    /**
     * @param value spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
     */
    @JvmName("iadyytlbhmekjihk")
    public suspend fun spec(`value`: IngressSpecArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.spec = mapped
    }

    /**
     * @param argument spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
     */
    @JvmName("gevjkfqmybngeila")
    public suspend fun spec(argument: suspend IngressSpecArgsBuilder.() -> Unit) {
        val toBeMapped = IngressSpecArgsBuilder().applySuspend { argument() }.build()
        val mapped = of(toBeMapped)
        this.spec = mapped
    }

    internal fun build(): IngressArgs = IngressArgs(
        apiVersion = apiVersion,
        kind = kind,
        metadata = metadata,
        spec = spec,
    )
}