com.pulumi.kubernetes.apps.v1beta2.kotlin.inputs.StatefulSetSpecArgs.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.apps.v1beta2.kotlin.inputs

import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiNullFieldException
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import com.pulumi.kubernetes.apps.v1beta2.inputs.StatefulSetSpecArgs.builder
import com.pulumi.kubernetes.core.v1.kotlin.inputs.PersistentVolumeClaimArgs
import com.pulumi.kubernetes.core.v1.kotlin.inputs.PersistentVolumeClaimArgsBuilder
import com.pulumi.kubernetes.core.v1.kotlin.inputs.PodTemplateSpecArgs
import com.pulumi.kubernetes.core.v1.kotlin.inputs.PodTemplateSpecArgsBuilder
import com.pulumi.kubernetes.meta.v1.kotlin.inputs.LabelSelectorArgs
import com.pulumi.kubernetes.meta.v1.kotlin.inputs.LabelSelectorArgsBuilder
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName

/**
 * A StatefulSetSpec is the specification of a StatefulSet.
 * @property podManagementPolicy podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
 * @property replicas replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
 * @property revisionHistoryLimit revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
 * @property selector selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
 * @property serviceName serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
 * @property template template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
 * @property updateStrategy updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
 * @property volumeClaimTemplates volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
 */
public data class StatefulSetSpecArgs(
    public val podManagementPolicy: Output? = null,
    public val replicas: Output? = null,
    public val revisionHistoryLimit: Output? = null,
    public val selector: Output,
    public val serviceName: Output,
    public val template: Output,
    public val updateStrategy: Output? = null,
    public val volumeClaimTemplates: Output>? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.kubernetes.apps.v1beta2.inputs.StatefulSetSpecArgs =
        com.pulumi.kubernetes.apps.v1beta2.inputs.StatefulSetSpecArgs.builder()
            .podManagementPolicy(podManagementPolicy?.applyValue({ args0 -> args0 }))
            .replicas(replicas?.applyValue({ args0 -> args0 }))
            .revisionHistoryLimit(revisionHistoryLimit?.applyValue({ args0 -> args0 }))
            .selector(selector.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .serviceName(serviceName.applyValue({ args0 -> args0 }))
            .template(template.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .updateStrategy(updateStrategy?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .volumeClaimTemplates(
                volumeClaimTemplates?.applyValue({ args0 ->
                    args0.map({ args0 ->
                        args0.let({ args0 -> args0.toJava() })
                    })
                }),
            ).build()
}

/**
 * Builder for [StatefulSetSpecArgs].
 */
@PulumiTagMarker
public class StatefulSetSpecArgsBuilder internal constructor() {
    private var podManagementPolicy: Output? = null

    private var replicas: Output? = null

    private var revisionHistoryLimit: Output? = null

    private var selector: Output? = null

    private var serviceName: Output? = null

    private var template: Output? = null

    private var updateStrategy: Output? = null

    private var volumeClaimTemplates: Output>? = null

    /**
     * @param value podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
     */
    @JvmName("uluxskaxlsyxesku")
    public suspend fun podManagementPolicy(`value`: Output) {
        this.podManagementPolicy = value
    }

    /**
     * @param value replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
     */
    @JvmName("qxpilfbejsbcmjxn")
    public suspend fun replicas(`value`: Output) {
        this.replicas = value
    }

    /**
     * @param value revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
     */
    @JvmName("uixuovghxosrqrvi")
    public suspend fun revisionHistoryLimit(`value`: Output) {
        this.revisionHistoryLimit = value
    }

    /**
     * @param value selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
     */
    @JvmName("rijgtcdftxllewkh")
    public suspend fun selector(`value`: Output) {
        this.selector = value
    }

    /**
     * @param value serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
     */
    @JvmName("ryhwvpciqaxuplwe")
    public suspend fun serviceName(`value`: Output) {
        this.serviceName = value
    }

    /**
     * @param value template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
     */
    @JvmName("gkjljdufajpndlrx")
    public suspend fun template(`value`: Output) {
        this.template = value
    }

    /**
     * @param value updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
     */
    @JvmName("ihnxrwfxhkqpipot")
    public suspend fun updateStrategy(`value`: Output) {
        this.updateStrategy = value
    }

    /**
     * @param value volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
     */
    @JvmName("tebptnaajunhtxce")
    public suspend fun volumeClaimTemplates(`value`: Output>) {
        this.volumeClaimTemplates = value
    }

    @JvmName("kpckqdrdbrabcswn")
    public suspend fun volumeClaimTemplates(vararg values: Output) {
        this.volumeClaimTemplates = Output.all(values.asList())
    }

    /**
     * @param values volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
     */
    @JvmName("ylinfkecodqotrbw")
    public suspend fun volumeClaimTemplates(values: List>) {
        this.volumeClaimTemplates = Output.all(values)
    }

    /**
     * @param value podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once.
     */
    @JvmName("djgvddraixoquhvy")
    public suspend fun podManagementPolicy(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.podManagementPolicy = mapped
    }

    /**
     * @param value replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1.
     */
    @JvmName("kfydoceaotjjdvra")
    public suspend fun replicas(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.replicas = mapped
    }

    /**
     * @param value revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10.
     */
    @JvmName("uiiluosqndrsemng")
    public suspend fun revisionHistoryLimit(`value`: Int?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.revisionHistoryLimit = mapped
    }

    /**
     * @param value selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
     */
    @JvmName("klnjfvebnnbqbjyr")
    public suspend fun selector(`value`: LabelSelectorArgs) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.selector = mapped
    }

    /**
     * @param argument selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
     */
    @JvmName("fdrkraalwsfyyxnn")
    public suspend fun selector(argument: suspend LabelSelectorArgsBuilder.() -> Unit) {
        val toBeMapped = LabelSelectorArgsBuilder().applySuspend { argument() }.build()
        val mapped = of(toBeMapped)
        this.selector = mapped
    }

    /**
     * @param value serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller.
     */
    @JvmName("lycylljorawkvkce")
    public suspend fun serviceName(`value`: String) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.serviceName = mapped
    }

    /**
     * @param value template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
     */
    @JvmName("ggmbrshpmttmfrec")
    public suspend fun template(`value`: PodTemplateSpecArgs) {
        val toBeMapped = value
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.template = mapped
    }

    /**
     * @param argument template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet.
     */
    @JvmName("olewodxuyqwboepd")
    public suspend fun template(argument: suspend PodTemplateSpecArgsBuilder.() -> Unit) {
        val toBeMapped = PodTemplateSpecArgsBuilder().applySuspend { argument() }.build()
        val mapped = of(toBeMapped)
        this.template = mapped
    }

    /**
     * @param value updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
     */
    @JvmName("vebxxkceemvhthyy")
    public suspend fun updateStrategy(`value`: StatefulSetUpdateStrategyArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.updateStrategy = mapped
    }

    /**
     * @param argument updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.
     */
    @JvmName("ksjxnkdkwfdyajgo")
    public suspend fun updateStrategy(argument: suspend StatefulSetUpdateStrategyArgsBuilder.() -> Unit) {
        val toBeMapped = StatefulSetUpdateStrategyArgsBuilder().applySuspend { argument() }.build()
        val mapped = of(toBeMapped)
        this.updateStrategy = mapped
    }

    /**
     * @param value volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
     */
    @JvmName("veuarydjphosvqex")
    public suspend fun volumeClaimTemplates(`value`: List?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.volumeClaimTemplates = mapped
    }

    /**
     * @param argument volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
     */
    @JvmName("jmorycykjoixykkf")
    public suspend fun volumeClaimTemplates(argument: List Unit>) {
        val toBeMapped = argument.toList().map {
            PersistentVolumeClaimArgsBuilder().applySuspend {
                it()
            }.build()
        }
        val mapped = of(toBeMapped)
        this.volumeClaimTemplates = mapped
    }

    /**
     * @param argument volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
     */
    @JvmName("fckxpnjcgfvefudg")
    public suspend fun volumeClaimTemplates(vararg argument: suspend PersistentVolumeClaimArgsBuilder.() -> Unit) {
        val toBeMapped = argument.toList().map {
            PersistentVolumeClaimArgsBuilder().applySuspend {
                it()
            }.build()
        }
        val mapped = of(toBeMapped)
        this.volumeClaimTemplates = mapped
    }

    /**
     * @param argument volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
     */
    @JvmName("cfmtjcjogoisqvun")
    public suspend fun volumeClaimTemplates(argument: suspend PersistentVolumeClaimArgsBuilder.() -> Unit) {
        val toBeMapped = listOf(PersistentVolumeClaimArgsBuilder().applySuspend { argument() }.build())
        val mapped = of(toBeMapped)
        this.volumeClaimTemplates = mapped
    }

    /**
     * @param values volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name.
     */
    @JvmName("ykwmjdfarrivjlan")
    public suspend fun volumeClaimTemplates(vararg values: PersistentVolumeClaimArgs) {
        val toBeMapped = values.toList()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.volumeClaimTemplates = mapped
    }

    internal fun build(): StatefulSetSpecArgs = StatefulSetSpecArgs(
        podManagementPolicy = podManagementPolicy,
        replicas = replicas,
        revisionHistoryLimit = revisionHistoryLimit,
        selector = selector ?: throw PulumiNullFieldException("selector"),
        serviceName = serviceName ?: throw PulumiNullFieldException("serviceName"),
        template = template ?: throw PulumiNullFieldException("template"),
        updateStrategy = updateStrategy,
        volumeClaimTemplates = volumeClaimTemplates,
    )
}