com.pulumi.kubernetes.networking.v1.kotlin.Ingress.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
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.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.kubernetes.networking.v1.kotlin
import com.pulumi.core.Output
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.kubernetes.meta.v1.kotlin.outputs.ObjectMeta
import com.pulumi.kubernetes.networking.v1.kotlin.outputs.IngressSpec
import com.pulumi.kubernetes.networking.v1.kotlin.outputs.IngressStatus
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import com.pulumi.kubernetes.meta.v1.kotlin.outputs.ObjectMeta.Companion.toKotlin as objectMetaToKotlin
import com.pulumi.kubernetes.networking.v1.kotlin.outputs.IngressSpec.Companion.toKotlin as ingressSpecToKotlin
import com.pulumi.kubernetes.networking.v1.kotlin.outputs.IngressStatus.Companion.toKotlin as ingressStatusToKotlin
/**
* Builder for [Ingress].
*/
@PulumiTagMarker
public class IngressResourceBuilder internal constructor() {
public var name: String? = null
public var args: IngressArgs = IngressArgs()
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 IngressArgsBuilder.() -> Unit) {
val builder = IngressArgsBuilder()
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(): Ingress {
val builtJavaResource = com.pulumi.kubernetes.networking.v1.Ingress(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Ingress(builtJavaResource)
}
}
/**
* 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());
* }
* }
* ```
*/
public class Ingress internal constructor(
override val javaResource: com.pulumi.kubernetes.networking.v1.Ingress,
) : KotlinCustomResource(javaResource, IngressMapper) {
/**
* 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
*/
public val apiVersion: Output
get() = javaResource.apiVersion().applyValue({ args0 -> args0 })
/**
* 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
*/
public val kind: Output
get() = javaResource.kind().applyValue({ args0 -> args0 })
/**
* Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*/
public val metadata: Output
get() = javaResource.metadata().applyValue({ args0 ->
args0.let({ args0 ->
objectMetaToKotlin(args0)
})
})
/**
* 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 val spec: Output
get() = javaResource.spec().applyValue({ args0 ->
args0.let({ args0 ->
ingressSpecToKotlin(args0)
})
})
/**
* status is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
*/
public val status: Output?
get() = javaResource.status().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
ingressStatusToKotlin(args0)
})
}).orElse(null)
})
}
public object IngressMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.kubernetes.networking.v1.Ingress::class == javaResource::class
override fun map(javaResource: Resource): Ingress = Ingress(
javaResource as
com.pulumi.kubernetes.networking.v1.Ingress,
)
}
/**
* @see [Ingress].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Ingress].
*/
public suspend fun ingress(name: String, block: suspend IngressResourceBuilder.() -> Unit): Ingress {
val builder = IngressResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Ingress].
* @param name The _unique_ name of the resulting resource.
*/
public fun ingress(name: String): Ingress {
val builder = IngressResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy