com.pulumi.awsnative.cloudformation.kotlin.ModuleVersion.kt Maven / Gradle / Ivy

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

package com.pulumi.awsnative.cloudformation.kotlin

import com.pulumi.awsnative.cloudformation.kotlin.enums.ModuleVersionVisibility
import com.pulumi.awsnative.cloudformation.kotlin.enums.ModuleVersionVisibility.Companion.toKotlin
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 [ModuleVersion].
 */
@PulumiTagMarker
public class ModuleVersionResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: ModuleVersionArgs = ModuleVersionArgs()

    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 ModuleVersionArgsBuilder.() -> Unit) {
        val builder = ModuleVersionArgsBuilder()
        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(): ModuleVersion {
        val builtJavaResource =
            com.pulumi.awsnative.cloudformation.ModuleVersion(
                this.name,
                this.args.toJava(),
                this.opts.toJava(),
            )
        return ModuleVersion(builtJavaResource)
    }
}

/**
 * A module that has been registered in the CloudFormation registry.
 * ## Example Usage
 * ### Example
 * No Java example available.
 * ### Example
 * No Java example available.
 * ### Example
 * No Java example available.
 * ### Example
 * No Java example available.
 * ### Example
 * No Java example available.
 * ### Example
 * No Java example available.
 */
public class ModuleVersion internal constructor(
    override val javaResource: com.pulumi.awsnative.cloudformation.ModuleVersion,
) : KotlinCustomResource(javaResource, ModuleVersionMapper) {
    /**
     * The Amazon Resource Name (ARN) of the module.
     */
    public val arn: Output
        get() = javaResource.arn().applyValue({ args0 -> args0 })

    /**
     * The description of the registered module.
     */
    public val description: Output
        get() = javaResource.description().applyValue({ args0 -> args0 })

    /**
     * The URL of a page providing detailed documentation for this module.
     */
    public val documentationUrl: Output
        get() = javaResource.documentationUrl().applyValue({ args0 -> args0 })

    /**
     * Indicator of whether this module version is the current default version
     */
    public val isDefaultVersion: Output
        get() = javaResource.isDefaultVersion().applyValue({ args0 -> args0 })

    /**
     * The name of the module being registered.
     * Recommended module naming pattern: company_or_organization::service::type::MODULE.
     */
    public val moduleName: Output
        get() = javaResource.moduleName().applyValue({ args0 -> args0 })

    /**
     * The url to the S3 bucket containing the schema and template fragment for the module you want to register.
     */
    public val modulePackage: Output
        get() = javaResource.modulePackage().applyValue({ args0 -> args0 })

    /**
     * The schema defining input parameters to and resources generated by the module.
     */
    public val schema: Output
        get() = javaResource.schema().applyValue({ args0 -> args0 })

    /**
     * The time that the specified module version was registered.
     */
    public val timeCreated: Output
        get() = javaResource.timeCreated().applyValue({ args0 -> args0 })

    /**
     * The version ID of the module represented by this module instance.
     */
    public val versionId: Output
        get() = javaResource.versionId().applyValue({ args0 -> args0 })

    /**
     * The scope at which the type is visible and usable in CloudFormation operations.
     * The only allowed value at present is:
     * PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.
     */
    public val visibility: Output
        get() = javaResource.visibility().applyValue({ args0 -> args0.let({ args0 -> toKotlin(args0) }) })
}

public object ModuleVersionMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.awsnative.cloudformation.ModuleVersion::class == javaResource::class

    override fun map(javaResource: Resource): ModuleVersion = ModuleVersion(
        javaResource as
            com.pulumi.awsnative.cloudformation.ModuleVersion,
    )
}

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

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