copy_db_cluster_parameter_group ¶

def copy_db_cluster_parameter_group(
    self,
    *,
    config_overrides: Optional[DocDBClientConfig] = None,
    source_db_cluster_parameter_group_identifier: Optional[
        "capo_docdb.types.string.String"
    ] = None,
    target_db_cluster_parameter_group_identifier: Optional[
        "capo_docdb.types.string.String"
    ] = None,
    target_db_cluster_parameter_group_description: Optional[
        "capo_docdb.types.string.String"
    ] = None,
    tags: Optional["capo_docdb.types.tag_list.TagList"] = None,
) -> "capo_docdb.types.copy_db_cluster_parameter_group_result.CopyDBClusterParameterGroupResult":
    """<p>Copies the specified cluster parameter group.</p>

    Args:
        source_db_cluster_parameter_group_identifier: <p>The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must specify a valid cluster parameter group.</p> </li> <li> <p>If the source cluster parameter group is in the same Amazon Web Services Region as the copy, specify a valid parameter group identifier; for example, <code>my-db-cluster-param-group</code>, or a valid ARN.</p> </li> <li> <p>If the source parameter group is in a different Amazon Web Services Region than the copy, specify a valid cluster parameter group ARN; for example, <code>arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group</code>.</p> </li> </ul>
        target_db_cluster_parameter_group_identifier: <p>The identifier for the copied cluster parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Cannot be null, empty, or blank.</p> </li> <li> <p>Must contain from 1 to 255 letters, numbers, or hyphens. </p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens. </p> </li> </ul> <p>Example: <code>my-cluster-param-group1</code> </p>
        target_db_cluster_parameter_group_description: <p>A description for the copied cluster parameter group.</p>
        tags: <p>The tags that are to be assigned to the 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_not_found_fault.DBParameterGroupNotFoundFault: <p> <code>DBParameterGroupName</code> doesn't refer to an existing parameter group. </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.copy_db_cluster_parameter_group_message.CopyDBClusterParameterGroupMessage]",
    ) -> OperationResponse[
        "capo_docdb.types.copy_db_cluster_parameter_group_result.CopyDBClusterParameterGroupResult"
    ]:
        import capo_docdb._operations.amazon_rd_sv19.copy_db_cluster_parameter_group

        output, http_response = (
            capo_docdb._operations.amazon_rd_sv19.copy_db_cluster_parameter_group.copy_db_cluster_parameter_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CopyDBClusterParameterGroup")
    )
    input_: capo_docdb.types.copy_db_cluster_parameter_group_message.CopyDBClusterParameterGroupMessage = {}
    if source_db_cluster_parameter_group_identifier is not None:
        input_["source_db_cluster_parameter_group_identifier"] = (
            source_db_cluster_parameter_group_identifier
        )
    if target_db_cluster_parameter_group_identifier is not None:
        input_["target_db_cluster_parameter_group_identifier"] = (
            target_db_cluster_parameter_group_identifier
        )
    if target_db_cluster_parameter_group_description is not None:
        input_["target_db_cluster_parameter_group_description"] = (
            target_db_cluster_parameter_group_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