com.pulumi.awsnative.rds.kotlin.DbParameterGroupArgs.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
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.
@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.DbParameterGroupArgs.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::DBParameterGroup`` resource creates a custom parameter group for an RDS database family.
* This type can be declared in a template and referenced in the ``DBParameterGroupName`` property of an ``AWS::RDS::DBInstance`` resource.
* For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
* For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
* Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.
* @property dbParameterGroupName The name of the DB parameter group.
* Constraints:
* + Must be 1 to 255 letters, numbers, or hyphens.
* + First character must be a letter
* + Can't end with a hyphen or contain two consecutive hyphens
* If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group.
* This value is stored as a lowercase string.
* @property description Provides the customer-specified description for this DB parameter group.
* @property family The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family.
* The DB parameter group family can't be changed when updating a DB 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 ``CreateDBParameterGroup``.
* @property parameters An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional.
* RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (``rds.ibm_customer_id``) and site number (``rds.ibm_site_id``) before starting a Db2 instance.
* For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
* For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
* AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::RDS::DBParameterGroup` for more information about the expected schema for this property.
* @property tags An optional array of key-value pairs to apply to this DB parameter group.
* Currently, this is the only property that supports drift detection.
*/
public data class DbParameterGroupArgs(
public val dbParameterGroupName: 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.DbParameterGroupArgs =
com.pulumi.awsnative.rds.DbParameterGroupArgs.builder()
.dbParameterGroupName(dbParameterGroupName?.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 [DbParameterGroupArgs].
*/
@PulumiTagMarker
public class DbParameterGroupArgsBuilder internal constructor() {
private var dbParameterGroupName: 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 parameter group.
* Constraints:
* + Must be 1 to 255 letters, numbers, or hyphens.
* + First character must be a letter
* + Can't end with a hyphen or contain two consecutive hyphens
* If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group.
* This value is stored as a lowercase string.
*/
@JvmName("krcykxgxrruhkotm")
public suspend fun dbParameterGroupName(`value`: Output) {
this.dbParameterGroupName = value
}
/**
* @param value Provides the customer-specified description for this DB parameter group.
*/
@JvmName("kjxjxcyxxguwwwsk")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family.
* The DB parameter group family can't be changed when updating a DB 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 ``CreateDBParameterGroup``.
*/
@JvmName("orwmiqgobrsuxary")
public suspend fun family(`value`: Output) {
this.family = value
}
/**
* @param value An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional.
* RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (``rds.ibm_customer_id``) and site number (``rds.ibm_site_id``) before starting a Db2 instance.
* For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
* For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
* AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::RDS::DBParameterGroup` for more information about the expected schema for this property.
*/
@JvmName("tijlibnvnxjfenck")
public suspend fun parameters(`value`: Output) {
this.parameters = value
}
/**
* @param value An optional array of key-value pairs to apply to this DB parameter group.
* Currently, this is the only property that supports drift detection.
*/
@JvmName("yaepigseulmgdqvj")
public suspend fun tags(`value`: Output>) {
this.tags = value
}
@JvmName("rlukgrtlgptcjkim")
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 parameter group.
* Currently, this is the only property that supports drift detection.
*/
@JvmName("uyrxewladsjdgiaa")
public suspend fun tags(values: List>) {
this.tags = Output.all(values)
}
/**
* @param value The name of the DB parameter group.
* Constraints:
* + Must be 1 to 255 letters, numbers, or hyphens.
* + First character must be a letter
* + Can't end with a hyphen or contain two consecutive hyphens
* If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group.
* This value is stored as a lowercase string.
*/
@JvmName("gjlxmtfqfsvwvmhy")
public suspend fun dbParameterGroupName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.dbParameterGroupName = mapped
}
/**
* @param value Provides the customer-specified description for this DB parameter group.
*/
@JvmName("fdhiardkqnsxyfwp")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family.
* The DB parameter group family can't be changed when updating a DB 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 ``CreateDBParameterGroup``.
*/
@JvmName("mqdvauxxtkojaxak")
public suspend fun family(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.family = mapped
}
/**
* @param value An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional.
* RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (``rds.ibm_customer_id``) and site number (``rds.ibm_site_id``) before starting a Db2 instance.
* For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
* For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
* AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::RDS::DBParameterGroup` for more information about the expected schema for this property.
*/
@JvmName("lhjujhmogbrdxxgm")
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 parameter group.
* Currently, this is the only property that supports drift detection.
*/
@JvmName("hdusdnbmupkunxga")
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 parameter group.
* Currently, this is the only property that supports drift detection.
*/
@JvmName("pmbcugxkbrfenjfe")
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 parameter group.
* Currently, this is the only property that supports drift detection.
*/
@JvmName("eshvdwypiuglwlwi")
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 parameter group.
* Currently, this is the only property that supports drift detection.
*/
@JvmName("qsueugffpxkbwjda")
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 parameter group.
* Currently, this is the only property that supports drift detection.
*/
@JvmName("gjbvsmmpaxghvxvp")
public suspend fun tags(vararg values: TagArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.tags = mapped
}
internal fun build(): DbParameterGroupArgs = DbParameterGroupArgs(
dbParameterGroupName = dbParameterGroupName,
description = description,
family = family,
parameters = parameters,
tags = tags,
)
}