com.pulumi.kubernetes.apps.v1.kotlin.DeploymentPatch.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.
There is a newer version: 4.18.2.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.kubernetes.apps.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.apps.v1.kotlin.outputs.DeploymentSpecPatch
import com.pulumi.kubernetes.apps.v1.kotlin.outputs.DeploymentStatusPatch
import com.pulumi.kubernetes.meta.v1.kotlin.outputs.ObjectMetaPatch
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import com.pulumi.kubernetes.apps.v1.kotlin.outputs.DeploymentSpecPatch.Companion.toKotlin as deploymentSpecPatchToKotlin
import com.pulumi.kubernetes.apps.v1.kotlin.outputs.DeploymentStatusPatch.Companion.toKotlin as deploymentStatusPatchToKotlin
import com.pulumi.kubernetes.meta.v1.kotlin.outputs.ObjectMetaPatch.Companion.toKotlin as objectMetaPatchToKotlin

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

    public var args: DeploymentPatchArgs = DeploymentPatchArgs()

    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 DeploymentPatchArgsBuilder.() -> Unit) {
        val builder = DeploymentPatchArgsBuilder()
        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(): DeploymentPatch {
        val builtJavaResource = com.pulumi.kubernetes.apps.v1.DeploymentPatch(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return DeploymentPatch(builtJavaResource)
    }
}

/**
 * Patch resources are used to modify existing Kubernetes resources by using
 * Server-Side Apply updates. The name of the resource must be specified, but all other properties are optional. More than
 * one patch may be applied to the same resource, and a random FieldManager name will be used for each Patch resource.
 * Conflicts will result in an error by default, but can be forced using the "pulumi.com/patchForce" annotation. See the
 * [Server-Side Apply Docs](https://www.pulumi.com/registry/packages/kubernetes/how-to-guides/managing-resources-with-server-side-apply/) for
 * additional information about using Server-Side Apply to manage Kubernetes resources with Pulumi.
 * Deployment enables declarative updates for Pods and ReplicaSets.
 * 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. The Deployment has begun to be updated by the Deployment controller. If the current
 *    generation of the Deployment is > 1, then this means that the current generation must
 *    be different from the generation reported by the last outputs.
 * 2. There exists a ReplicaSet whose revision is equal to the current revision of the
 *    Deployment.
 * 3. The Deployment's '.status.conditions' has a status of type 'Available' whose 'status'
 *    member is set to 'True'.
 * 4. If the Deployment has generation > 1, then '.status.conditions' has a status of type
 *    'Progressing', whose 'status' member is set to 'True', and whose 'reason' is
 *    'NewReplicaSetAvailable'. For generation <= 1, this status field does not exist,
 *    because it doesn't do a rollout (i.e., it simply creates the Deployment and
 *    corresponding ReplicaSet), and therefore there is no rollout to mark as 'Progressing'.
 * If the Deployment 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.
 */
public class DeploymentPatch internal constructor(
    override val javaResource: com.pulumi.kubernetes.apps.v1.DeploymentPatch,
) : KotlinCustomResource(javaResource, DeploymentPatchMapper) {
    /**
     * 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.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * 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.map({ args0 -> args0 }).orElse(null) })

    /**
     * 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.map({ args0 ->
                args0.let({ args0 ->
                    objectMetaPatchToKotlin(args0)
                })
            }).orElse(null)
        })

    /**
     * Specification of the desired behavior of the Deployment.
     */
    public val spec: Output?
        get() = javaResource.spec().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    deploymentSpecPatchToKotlin(args0)
                })
            }).orElse(null)
        })

    /**
     * Most recently observed status of the Deployment.
     */
    public val status: Output?
        get() = javaResource.status().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    deploymentStatusPatchToKotlin(args0)
                })
            }).orElse(null)
        })
}

public object DeploymentPatchMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.kubernetes.apps.v1.DeploymentPatch::class == javaResource::class

    override fun map(javaResource: Resource): DeploymentPatch = DeploymentPatch(
        javaResource as
            com.pulumi.kubernetes.apps.v1.DeploymentPatch,
    )
}

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

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