com.pulumi.awsnative.rds.kotlin.DbClusterParameterGroup.kt Maven / Gradle / Ivy

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

package com.pulumi.awsnative.rds.kotlin

import com.pulumi.awsnative.kotlin.outputs.Tag
import com.pulumi.awsnative.kotlin.outputs.Tag.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.Any
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List

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

    public var args: DbClusterParameterGroupArgs = DbClusterParameterGroupArgs()

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

/**
 * The ``AWS::RDS::DBClusterParameterGroup`` resource creates a new Amazon RDS DB cluster parameter group.
 *  For information about configuring parameters for Amazon Aurora DB clusters, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
 *   If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
 *  If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started.
 */
public class DbClusterParameterGroup internal constructor(
    override val javaResource: com.pulumi.awsnative.rds.DbClusterParameterGroup,
) : KotlinCustomResource(javaResource, DbClusterParameterGroupMapper) {
    /**
     * The name of the DB cluster parameter group.
     *  Constraints:
     *   +  Must not match the name of an existing DB cluster parameter group.
     *   This value is stored as a lowercase string.
     */
    public val dbClusterParameterGroupName: Output?
        get() = javaResource.dbClusterParameterGroupName().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The description for the DB cluster parameter group.
     */
    public val description: Output
        get() = javaResource.description().applyValue({ args0 -> args0 })

    /**
     * The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
     *   *Aurora MySQL*
     *  Example: ``aurora-mysql5.7``, ``aurora-mysql8.0``
     *   *Aurora PostgreSQL*
     *  Example: ``aurora-postgresql14``
     *   *RDS for MySQL*
     *  Example: ``mysql8.0``
     *   *RDS for PostgreSQL*
     *  Example: ``postgres13``
     *  To list all of the available parameter group families for a DB engine, use the following command:
     *   ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine ``
     *  For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
     *   ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql``
     *   The output contains duplicates.
     *   The following are the valid DB engine values:
     *   +   ``aurora-mysql``
     *   +   ``aurora-postgresql``
     *   +   ``mysql``
     *   +   ``postgres``
     */
    public val family: Output
        get() = javaResource.family().applyValue({ args0 -> args0 })

    /**
     * Provides a list of parameters for the DB cluster parameter group.
     * Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::RDS::DBClusterParameterGroup` for more information about the expected schema for this property.
     */
    public val parameters: Output
        get() = javaResource.parameters().applyValue({ args0 -> args0 })

    /**
     * Tags to assign to the DB cluster parameter group.
     */
    public val tags: Output>?
        get() = javaResource.tags().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.let({ args0 -> toKotlin(args0) })
                })
            }).orElse(null)
        })
}

public object DbClusterParameterGroupMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.awsnative.rds.DbClusterParameterGroup::class == javaResource::class

    override fun map(javaResource: Resource): DbClusterParameterGroup =
        DbClusterParameterGroup(javaResource as com.pulumi.awsnative.rds.DbClusterParameterGroup)
}

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

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