DbParameterGroupArgs

data class DbParameterGroupArgs(val dbParameterGroupName: Output<String>? = null, val description: Output<String>? = null, val family: Output<String>? = null, val parameters: Output<Any>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<DbParameterGroupArgs>

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 in the Amazon RDS User Guide. For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups 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.

Constructors

Link copied to clipboard
constructor(dbParameterGroupName: Output<String>? = null, description: Output<String>? = null, family: Output<String>? = null, parameters: Output<Any>? = null, tags: Output<List<TagArgs>>? = null)

Properties

Link copied to clipboard
val dbParameterGroupName: Output<String>? = null

The name of the DB parameter group. Constraints:

Link copied to clipboard
val description: Output<String>? = null

Provides the customer-specified description for this DB parameter group.

Link copied to clipboard
val family: Output<String>? = null

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 database engine and engine version compatible with that DB parameter group family. 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 <engine>` For example, to list all of the available parameter group families for the MySQL DB engine, use the following command: `aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql` The output contains duplicates. The following are the valid DB engine values:

Link copied to clipboard
val parameters: Output<Any>? = null

An array of parameter names and values for the parameter update. You must specify at least one parameter name and value. For more information about parameter groups, see Working with parameter groups in the Amazon RDS User Guide, or Working with parameter groups 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 for AWS::RDS::DBParameterGroup for more information about the expected schema for this property.

Link copied to clipboard
val tags: Output<List<TagArgs>>? = null

Tags to assign to the DB parameter group.

Functions

Link copied to clipboard
open override fun toJava(): DbParameterGroupArgs