com.pulumi.gcp.securityposture.kotlin.PostureDeployment.kt Maven / Gradle / Ivy

Go to download
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.securityposture.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.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit

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

    public var args: PostureDeploymentArgs = PostureDeploymentArgs()

    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 PostureDeploymentArgsBuilder.() -> Unit) {
        val builder = PostureDeploymentArgsBuilder()
        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(): PostureDeployment {
        val builtJavaResource =
            com.pulumi.gcp.securityposture.PostureDeployment(
                this.name,
                this.args.toJava(),
                this.opts.toJava(),
            )
        return PostureDeployment(builtJavaResource)
    }
}

/**
 * Represents a deployment of a security posture on a resource. A posture contains user curated policy sets. A posture can
 * be deployed on a project or on a folder or on an organization. To deploy a posture we need to populate the posture's name
 * and its revision_id in the posture deployment configuration. Every update to a deployed posture generates a new revision_id.
 * Thus, the updated revision_id should be used in the respective posture deployment's configuration to deploy that posture
 * on a resource.
 * To get more information about PostureDeployment, see:
 * * How-to Guides
 *     * [Create and deploy a posture](https://cloud.google.com/security-command-center/docs/how-to-use-security-posture)
 * ## Import
 * PostureDeployment can be imported using any of these accepted formats:
 * * `{{parent}}/locations/{{location}}/postureDeployments/{{posture_deployment_id}}`
 * When using the `pulumi import` command, PostureDeployment can be imported using one of the formats above. For example:
 * ```sh
 * $ pulumi import gcp:securityposture/postureDeployment:PostureDeployment default {{parent}}/locations/{{location}}/postureDeployments/{{posture_deployment_id}}
 * ```
 */
public class PostureDeployment internal constructor(
    override val javaResource: com.pulumi.gcp.securityposture.PostureDeployment,
) : KotlinCustomResource(javaResource, PostureDeploymentMapper) {
    /**
     * Time the posture deployment was created in UTC.
     */
    public val createTime: Output
        get() = javaResource.createTime().applyValue({ args0 -> args0 })

    /**
     * Description of the posture deployment.
     */
    public val description: Output?
        get() = javaResource.description().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * This is an output only optional field which will be filled in case when
     * PostureDeployment state is UPDATE_FAILED or CREATE_FAILED or DELETE_FAILED.
     * It denotes the desired posture to be deployed.
     */
    public val desiredPostureId: Output
        get() = javaResource.desiredPostureId().applyValue({ args0 -> args0 })

    /**
     * This is an output only optional field which will be filled in case when
     * PostureDeployment state is UPDATE_FAILED or CREATE_FAILED or DELETE_FAILED.
     * It denotes the desired posture revision_id to be deployed.
     */
    public val desiredPostureRevisionId: Output
        get() = javaResource.desiredPostureRevisionId().applyValue({ args0 -> args0 })

    /**
     * For Resource freshness validation (https://google.aip.dev/154)
     */
    public val etag: Output
        get() = javaResource.etag().applyValue({ args0 -> args0 })

    /**
     * This is a output only optional field which will be filled in case where
     * PostureDeployment enters a failure state like UPDATE_FAILED or
     * CREATE_FAILED or DELETE_FAILED. It will have the failure message for posture deployment's
     * CREATE/UPDATE/DELETE methods.
     */
    public val failureMessage: Output
        get() = javaResource.failureMessage().applyValue({ args0 -> args0 })

    /**
     * The location of the resource, eg. global`.
     */
    public val location: Output
        get() = javaResource.location().applyValue({ args0 -> args0 })

    /**
     * Name of the posture deployment instance.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The parent of the resource, an organization. Format should be `organizations/{organization_id}`.
     */
    public val parent: Output
        get() = javaResource.parent().applyValue({ args0 -> args0 })

    /**
     * ID of the posture deployment.
     * - - -
     */
    public val postureDeploymentId: Output
        get() = javaResource.postureDeploymentId().applyValue({ args0 -> args0 })

    /**
     * Relative name of the posture which needs to be deployed. It should be in the format:
     * organizations/{organization_id}/locations/{location}/postures/{posture_id}
     */
    public val postureId: Output
        get() = javaResource.postureId().applyValue({ args0 -> args0 })

    /**
     * Revision_id the posture which needs to be deployed.
     */
    public val postureRevisionId: Output
        get() = javaResource.postureRevisionId().applyValue({ args0 -> args0 })

    /**
     * If set, there are currently changes in flight to the posture deployment.
     */
    public val reconciling: Output
        get() = javaResource.reconciling().applyValue({ args0 -> args0 })

    /**
     * State of the posture deployment. A posture deployment can be in the following terminal states:
     * ACTIVE, CREATE_FAILED, UPDATE_FAILED, DELETE_FAILED.
     */
    public val state: Output
        get() = javaResource.state().applyValue({ args0 -> args0 })

    /**
     * The resource on which the posture should be deployed. This can be in one of the following formats:
     * projects/{project_number},
     * folders/{folder_number},
     * organizations/{organization_id}
     */
    public val targetResource: Output
        get() = javaResource.targetResource().applyValue({ args0 -> args0 })

    /**
     * Time the posture deployment was updated in UTC.
     */
    public val updateTime: Output
        get() = javaResource.updateTime().applyValue({ args0 -> args0 })
}

public object PostureDeploymentMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.gcp.securityposture.PostureDeployment::class == javaResource::class

    override fun map(javaResource: Resource): PostureDeployment = PostureDeployment(
        javaResource as
            com.pulumi.gcp.securityposture.PostureDeployment,
    )
}

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

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