Skip to content

create_parameter_group

create_parameter_group(
    parameter_group_name: String,
    *,
    config_overrides: Optional[DAXClientConfig] = None,
    description: Optional[String] = None,
) -> CreateParameterGroupResponse

Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX cluster.

Parameters:

  • parameter_group_name (String) –

    The name of the parameter group to apply to all of the clusters in this replication group.

  • description (Optional[String], default: None ) –

    A description of the parameter group.

Raises:

Source code in docs_src/capo_dax/_services/dax.py
def create_parameter_group(
    self,
    parameter_group_name: "capo_dax.types.string.String",
    *,
    config_overrides: Optional[DAXClientConfig] = None,
    description: Optional["capo_dax.types.string.String"] = None,
) -> "capo_dax.types.create_parameter_group_response.CreateParameterGroupResponse":
    """<p>Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX cluster.</p>

    Args:
        parameter_group_name: <p>The name of the parameter group to apply to all of the clusters in this replication group.</p>
        description: <p>A description of the parameter group.</p>

    Raises:
        capo_dax.errors.invalid_parameter_combination_exception.InvalidParameterCombinationException: <p>Two or more incompatible parameters were specified.</p>
        capo_dax.errors.invalid_parameter_group_state_fault.InvalidParameterGroupStateFault: <p>One or more parameters in a parameter group are in an invalid state.</p>
        capo_dax.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value for a parameter is invalid.</p>
        capo_dax.errors.parameter_group_already_exists_fault.ParameterGroupAlreadyExistsFault: <p>The specified parameter group already exists.</p>
        capo_dax.errors.parameter_group_quota_exceeded_fault.ParameterGroupQuotaExceededFault: <p>You have attempted to exceed the maximum number of parameter groups.</p>
        capo_dax.errors.service_linked_role_not_found_fault.ServiceLinkedRoleNotFoundFault: <p>The specified service linked role (SLR) was not found.</p>
        capo_dax.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_dax.types.create_parameter_group_request.CreateParameterGroupRequest]",
    ) -> OperationResponse[
        "capo_dax.types.create_parameter_group_response.CreateParameterGroupResponse"
    ]:
        import capo_dax._operations.amazon_daxv3.create_parameter_group

        output, http_response = (
            capo_dax._operations.amazon_daxv3.create_parameter_group.create_parameter_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateParameterGroup")
    )
    input_: capo_dax.types.create_parameter_group_request.CreateParameterGroupRequest = {
        "parameter_group_name": parameter_group_name
    }
    if description is not None:
        input_["description"] = description

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output