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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-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: 1.24.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.rds.kotlin

import com.pulumi.awsnative.kotlin.inputs.TagArgs
import com.pulumi.awsnative.kotlin.inputs.TagArgsBuilder
import com.pulumi.awsnative.rds.DbClusterParameterGroupArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Any
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName

/**
 * 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 update stack waits until the DB cluster is started.
 * @property dbClusterParameterGroupName The name of the DB cluster parameter group.
 *  Constraints:
 *   +  Must not match the name of an existing DB cluster parameter group.
 *  If you don't specify a value for ``DBClusterParameterGroupName`` property, a name is automatically created for the DB cluster parameter group.
 *   This value is stored as a lowercase string.
 * @property description A friendly description for this DB cluster parameter group.
 * @property family 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 DB engine and engine version compatible with that DB cluster parameter group family.
 *   The DB cluster parameter group family can't be changed when updating a DB cluster parameter group.
 *   To list all of the available parameter group families, use the following command:
 *   ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"``
 *  The output contains duplicates.
 *  For more information, see ``CreateDBClusterParameterGroup``.
 * @property parameters 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.
 * @property tags An optional array of key-value pairs to apply to this DB cluster parameter group.
 */
public data class DbClusterParameterGroupArgs(
    public val dbClusterParameterGroupName: Output? = null,
    public val description: Output? = null,
    public val family: Output? = null,
    public val parameters: Output? = null,
    public val tags: Output>? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.awsnative.rds.DbClusterParameterGroupArgs =
        com.pulumi.awsnative.rds.DbClusterParameterGroupArgs.builder()
            .dbClusterParameterGroupName(dbClusterParameterGroupName?.applyValue({ args0 -> args0 }))
            .description(description?.applyValue({ args0 -> args0 }))
            .family(family?.applyValue({ args0 -> args0 }))
            .parameters(parameters?.applyValue({ args0 -> args0 }))
            .tags(
                tags?.applyValue({ args0 ->
                    args0.map({ args0 ->
                        args0.let({ args0 ->
                            args0.toJava()
                        })
                    })
                }),
            ).build()
}

/**
 * Builder for [DbClusterParameterGroupArgs].
 */
@PulumiTagMarker
public class DbClusterParameterGroupArgsBuilder internal constructor() {
    private var dbClusterParameterGroupName: Output? = null

    private var description: Output? = null

    private var family: Output? = null

    private var parameters: Output? = null

    private var tags: Output>? = null

    /**
     * @param value The name of the DB cluster parameter group.
     *  Constraints:
     *   +  Must not match the name of an existing DB cluster parameter group.
     *  If you don't specify a value for ``DBClusterParameterGroupName`` property, a name is automatically created for the DB cluster parameter group.
     *   This value is stored as a lowercase string.
     */
    @JvmName("hpojskfodfyjdmxw")
    public suspend fun dbClusterParameterGroupName(`value`: Output) {
        this.dbClusterParameterGroupName = value
    }

    /**
     * @param value A friendly description for this DB cluster parameter group.
     */
    @JvmName("hgufqfbsjckivomh")
    public suspend fun description(`value`: Output) {
        this.description = value
    }

    /**
     * @param value 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 DB engine and engine version compatible with that DB cluster parameter group family.
     *   The DB cluster parameter group family can't be changed when updating a DB cluster parameter group.
     *   To list all of the available parameter group families, use the following command:
     *   ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"``
     *  The output contains duplicates.
     *  For more information, see ``CreateDBClusterParameterGroup``.
     */
    @JvmName("fyhemfcxhscpgxmt")
    public suspend fun family(`value`: Output) {
        this.family = value
    }

    /**
     * @param value 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.
     */
    @JvmName("rixhlrvyetwprqee")
    public suspend fun parameters(`value`: Output) {
        this.parameters = value
    }

    /**
     * @param value An optional array of key-value pairs to apply to this DB cluster parameter group.
     */
    @JvmName("hcrcomkxmhvwapih")
    public suspend fun tags(`value`: Output>) {
        this.tags = value
    }

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

    /**
     * @param values An optional array of key-value pairs to apply to this DB cluster parameter group.
     */
    @JvmName("neuiueemrdkefypc")
    public suspend fun tags(values: List>) {
        this.tags = Output.all(values)
    }

    /**
     * @param value The name of the DB cluster parameter group.
     *  Constraints:
     *   +  Must not match the name of an existing DB cluster parameter group.
     *  If you don't specify a value for ``DBClusterParameterGroupName`` property, a name is automatically created for the DB cluster parameter group.
     *   This value is stored as a lowercase string.
     */
    @JvmName("pfhpdfpfhuslxjad")
    public suspend fun dbClusterParameterGroupName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.dbClusterParameterGroupName = mapped
    }

    /**
     * @param value A friendly description for this DB cluster parameter group.
     */
    @JvmName("cdbfuimdwstcaalq")
    public suspend fun description(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.description = mapped
    }

    /**
     * @param value 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 DB engine and engine version compatible with that DB cluster parameter group family.
     *   The DB cluster parameter group family can't be changed when updating a DB cluster parameter group.
     *   To list all of the available parameter group families, use the following command:
     *   ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"``
     *  The output contains duplicates.
     *  For more information, see ``CreateDBClusterParameterGroup``.
     */
    @JvmName("fwaqmnylgjqckkvg")
    public suspend fun family(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.family = mapped
    }

    /**
     * @param value 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.
     */
    @JvmName("pnjgotcwovdibcfe")
    public suspend fun parameters(`value`: Any?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.parameters = mapped
    }

    /**
     * @param value An optional array of key-value pairs to apply to this DB cluster parameter group.
     */
    @JvmName("xnhptsesndisekqa")
    public suspend fun tags(`value`: List?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.tags = mapped
    }

    /**
     * @param argument An optional array of key-value pairs to apply to this DB cluster parameter group.
     */
    @JvmName("mvjftxykrcnqtynp")
    public suspend fun tags(argument: List Unit>) {
        val toBeMapped = argument.toList().map { TagArgsBuilder().applySuspend { it() }.build() }
        val mapped = of(toBeMapped)
        this.tags = mapped
    }

    /**
     * @param argument An optional array of key-value pairs to apply to this DB cluster parameter group.
     */
    @JvmName("fclkodltysnrloql")
    public suspend fun tags(vararg argument: suspend TagArgsBuilder.() -> Unit) {
        val toBeMapped = argument.toList().map { TagArgsBuilder().applySuspend { it() }.build() }
        val mapped = of(toBeMapped)
        this.tags = mapped
    }

    /**
     * @param argument An optional array of key-value pairs to apply to this DB cluster parameter group.
     */
    @JvmName("lrbjfyyptcivejrm")
    public suspend fun tags(argument: suspend TagArgsBuilder.() -> Unit) {
        val toBeMapped = listOf(TagArgsBuilder().applySuspend { argument() }.build())
        val mapped = of(toBeMapped)
        this.tags = mapped
    }

    /**
     * @param values An optional array of key-value pairs to apply to this DB cluster parameter group.
     */
    @JvmName("vhcwwpexstmrcurq")
    public suspend fun tags(vararg values: TagArgs) {
        val toBeMapped = values.toList()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.tags = mapped
    }

    internal fun build(): DbClusterParameterGroupArgs = DbClusterParameterGroupArgs(
        dbClusterParameterGroupName = dbClusterParameterGroupName,
        description = description,
        family = family,
        parameters = parameters,
        tags = tags,
    )
}