aws_sdk_rds/client/create_db_cluster_parameter_group.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`CreateDBClusterParameterGroup`](crate::operation::create_db_cluster_parameter_group::builders::CreateDBClusterParameterGroupFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`db_cluster_parameter_group_name(impl Into<String>)`](crate::operation::create_db_cluster_parameter_group::builders::CreateDBClusterParameterGroupFluentBuilder::db_cluster_parameter_group_name) / [`set_db_cluster_parameter_group_name(Option<String>)`](crate::operation::create_db_cluster_parameter_group::builders::CreateDBClusterParameterGroupFluentBuilder::set_db_cluster_parameter_group_name):<br>required: **true**<br><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><br>
7 /// - [`db_parameter_group_family(impl Into<String>)`](crate::operation::create_db_cluster_parameter_group::builders::CreateDBClusterParameterGroupFluentBuilder::db_parameter_group_family) / [`set_db_parameter_group_family(Option<String>)`](crate::operation::create_db_cluster_parameter_group::builders::CreateDBClusterParameterGroupFluentBuilder::set_db_parameter_group_family):<br>required: **true**<br><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</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><br>
8 /// - [`description(impl Into<String>)`](crate::operation::create_db_cluster_parameter_group::builders::CreateDBClusterParameterGroupFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_db_cluster_parameter_group::builders::CreateDBClusterParameterGroupFluentBuilder::set_description):<br>required: **true**<br><p>The description for the DB cluster parameter group.</p><br>
9 /// - [`tags(Tag)`](crate::operation::create_db_cluster_parameter_group::builders::CreateDBClusterParameterGroupFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_db_cluster_parameter_group::builders::CreateDBClusterParameterGroupFluentBuilder::set_tags):<br>required: **false**<br><p>Tags to assign to the DB cluster parameter group.</p><br>
10 /// - On success, responds with [`CreateDbClusterParameterGroupOutput`](crate::operation::create_db_cluster_parameter_group::CreateDbClusterParameterGroupOutput) with field(s):
11 /// - [`db_cluster_parameter_group(Option<DbClusterParameterGroup>)`](crate::operation::create_db_cluster_parameter_group::CreateDbClusterParameterGroupOutput::db_cluster_parameter_group): <p>Contains the details of an Amazon RDS DB cluster parameter group.</p> <p>This data type is used as a response element in the <code>DescribeDBClusterParameterGroups</code> action.</p>
12 /// - On failure, responds with [`SdkError<CreateDBClusterParameterGroupError>`](crate::operation::create_db_cluster_parameter_group::CreateDBClusterParameterGroupError)
13 pub fn create_db_cluster_parameter_group(
14 &self,
15 ) -> crate::operation::create_db_cluster_parameter_group::builders::CreateDBClusterParameterGroupFluentBuilder {
16 crate::operation::create_db_cluster_parameter_group::builders::CreateDBClusterParameterGroupFluentBuilder::new(self.handle.clone())
17 }
18}