Creates a new cluster parameter group.
Parameters in a cluster parameter group apply to all of the instances in a cluster.
A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups.
Parameters:
-
db_cluster_parameter_group_name
(Optional[String], default:
None
)
–
The name of the cluster parameter group.
Constraints:
This value is stored as a lowercase string.
-
db_parameter_group_family
(Optional[String], default:
None
)
–
The cluster parameter group family name.
-
description
(Optional[String], default:
None
)
–
The description for the cluster parameter group.
-
tags
(Optional[TagList], default:
None
)
–
The tags to be assigned to the cluster parameter group.
Raises:
Source code in docs_src/capo_docdb/_services/doc_db.py
| def create_db_cluster_parameter_group(
self,
*,
config_overrides: Optional[DocDBClientConfig] = None,
db_cluster_parameter_group_name: Optional[
"capo_docdb.types.string.String"
] = None,
db_parameter_group_family: Optional["capo_docdb.types.string.String"] = None,
description: Optional["capo_docdb.types.string.String"] = None,
tags: Optional["capo_docdb.types.tag_list.TagList"] = None,
) -> "capo_docdb.types.create_db_cluster_parameter_group_result.CreateDBClusterParameterGroupResult":
"""<p>Creates a new cluster parameter group.</p> <p>Parameters in a cluster parameter group apply to all of the instances in a cluster.</p> <p>A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the <code>default.docdb3.6</code> cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first <a href="https://docs.aws.amazon.com/documentdb/latest/devguide/cluster_parameter_group-create.html"> create a new parameter group</a> or <a href="https://docs.aws.amazon.com/documentdb/latest/devguide/cluster_parameter_group-copy.html"> copy an existing parameter group</a>, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see <a href="https://docs.aws.amazon.com/documentdb/latest/devguide/cluster_parameter_group-modify.html"> Modifying Amazon DocumentDB Cluster Parameter Groups</a>. </p>
Args:
db_cluster_parameter_group_name: <p>The name of the cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must not match the name of an existing <code>DBClusterParameterGroup</code>.</p> </li> </ul> <note> <p>This value is stored as a lowercase string.</p> </note>
db_parameter_group_family: <p>The cluster parameter group family name.</p>
description: <p>The description for the cluster parameter group.</p>
tags: <p>The tags to be assigned to the cluster parameter group.</p>
Raises:
capo_docdb.errors.db_parameter_group_already_exists_fault.DBParameterGroupAlreadyExistsFault: <p>A parameter group with the same name already exists.</p>
capo_docdb.errors.db_parameter_group_quota_exceeded_fault.DBParameterGroupQuotaExceededFault: <p>This request would cause you to exceed the allowed number of parameter groups.</p>
capo_docdb.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_docdb.types.create_db_cluster_parameter_group_message.CreateDBClusterParameterGroupMessage]",
) -> OperationResponse[
"capo_docdb.types.create_db_cluster_parameter_group_result.CreateDBClusterParameterGroupResult"
]:
import capo_docdb._operations.amazon_rd_sv19.create_db_cluster_parameter_group
output, http_response = (
capo_docdb._operations.amazon_rd_sv19.create_db_cluster_parameter_group.create_db_cluster_parameter_group(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("CreateDBClusterParameterGroup")
)
input_: capo_docdb.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 = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|