Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster.
When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Parameters:
-
db_cluster_parameter_group_name
(Optional[String], default:
None
)
–
The name of the DB cluster parameter group.
Constraints:
This value is stored as a lowercase string.
-
db_parameter_group_family
(Optional[String], default:
None
)
–
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 <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
-
description
(Optional[String], default:
None
)
–
The description for the DB cluster parameter group.
-
tags
(Optional[TagList], default:
None
)
–
Tags to assign to the DB cluster parameter group.
Raises:
Examples:
To create a DB cluster parameter group
The following example creates a DB cluster parameter group.
>>> await client.create_db_cluster_parameter_group(db_cluster_parameter_group_name='mydbclusterparametergroup', db_parameter_group_family='aurora5.6', description='My new cluster parameter group')
Source code in docs_src/capo_rds/_services/async_rds.py
| async def create_db_cluster_parameter_group(
self,
*,
config_overrides: Optional[AsyncRDSClientConfig] = None,
db_cluster_parameter_group_name: Optional[
"capo_rds.types.string.String"
] = None,
db_parameter_group_family: Optional["capo_rds.types.string.String"] = None,
description: Optional["capo_rds.types.string.String"] = None,
tags: Optional["capo_rds.types.tag_list.TagList"] = None,
) -> "capo_rds.types.create_db_cluster_parameter_group_result.CreateDBClusterParameterGroupResult":
"""<p>Creates a new DB cluster parameter group.</p> <p>Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.</p> <p>A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using <code>ModifyDBClusterParameterGroup</code>. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using <code>ModifyDBCluster</code>.</p> <p>When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.</p> <p>When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.</p> <important> <p>After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the <code>character_set_database</code> parameter. You can use the <i>Parameter Groups</i> option of the <a href="https://console.aws.amazon.com/rds/">Amazon RDS console</a> or the <code>DescribeDBClusterParameters</code> operation to verify that your DB cluster parameter group has been created or modified.</p> </important> <p>For more information on Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB cluster deployments</a> in the <i>Amazon RDS User Guide</i>.</p>
Args:
db_cluster_parameter_group_name: <p>The name of the DB cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must not match the name of an existing DB cluster parameter group.</p> </li> </ul> <note> <p>This value is stored as a lowercase string.</p> </note>
db_parameter_group_family: <p>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.</p> <p> <b>Aurora MySQL</b> </p> <p>Example: <code>aurora-mysql5.7</code>, <code>aurora-mysql8.0</code> </p> <p> <b>Aurora PostgreSQL</b> </p> <p>Example: <code>aurora-postgresql14</code> </p> <p> <b>RDS for MySQL</b> </p> <p>Example: <code>mysql8.0</code> </p> <p> <b>RDS for PostgreSQL</b> </p> <p>Example: <code>postgres13</code> </p> <p>To list all of the available parameter group families for a DB engine, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine></code> </p> <p>For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql</code> </p> <note> <p>The output contains duplicates.</p> </note> <p>The following are the valid DB engine values:</p> <ul> <li> <p> <code>aurora-mysql</code> </p> </li> <li> <p> <code>aurora-postgresql</code> </p> </li> <li> <p> <code>mysql</code> </p> </li> <li> <p> <code>postgres</code> </p> </li> </ul>
description: <p>The description for the DB cluster parameter group.</p>
tags: <p>Tags to assign to the DB cluster parameter group.</p>
Raises:
capo_rds.errors.db_parameter_group_already_exists_fault.DBParameterGroupAlreadyExistsFault: <p>A DB parameter group with the same name exists.</p>
capo_rds.errors.db_parameter_group_quota_exceeded_fault.DBParameterGroupQuotaExceededFault: <p>The request would result in the user exceeding the allowed number of DB parameter groups.</p>
capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
To create a DB cluster parameter group
The following example creates a DB cluster parameter group.
>>> await client.create_db_cluster_parameter_group(db_cluster_parameter_group_name='mydbclusterparametergroup', db_parameter_group_family='aurora5.6', description='My new cluster parameter group')
"""
async def _handler(
req: "AsyncOperationRequest[capo_rds.types.create_db_cluster_parameter_group_message.CreateDBClusterParameterGroupMessage]",
) -> AsyncOperationResponse[
"capo_rds.types.create_db_cluster_parameter_group_result.CreateDBClusterParameterGroupResult"
]:
import capo_rds._operations.amazon_rd_sv19.create_db_cluster_parameter_group
(
output,
http_response,
) = await capo_rds._operations.amazon_rd_sv19.create_db_cluster_parameter_group.async_create_db_cluster_parameter_group(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("CreateDBClusterParameterGroup")
)
input_: capo_rds.types.create_db_cluster_parameter_group_message.CreateDBClusterParameterGroupMessage = {}
if db_cluster_parameter_group_name is not None:
input_["db_cluster_parameter_group_name"] = db_cluster_parameter_group_name
if db_parameter_group_family is not None:
input_["db_parameter_group_family"] = db_parameter_group_family
if description is not None:
input_["description"] = description
if tags is not None:
input_["tags"] = tags
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|