DocDB / Client / modify_db_cluster_parameter_group

modify_db_cluster_parameter_group

DocDB.Client.modify_db_cluster_parameter_group(**kwargs)

Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Note

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.

Warning

After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.

See also: AWS API Documentation

Request Syntax

response = client.modify_db_cluster_parameter_group(
    DBClusterParameterGroupName='string',
    Parameters=[
        {
            'ParameterName': 'string',
            'ParameterValue': 'string',
            'Description': 'string',
            'Source': 'string',
            'ApplyType': 'string',
            'DataType': 'string',
            'AllowedValues': 'string',
            'IsModifiable': True|False,
            'MinimumEngineVersion': 'string',
            'ApplyMethod': 'immediate'|'pending-reboot'
        },
    ]
)
Parameters:

  • DBClusterParameterGroupName (string) –

    [REQUIRED]

    The name of the cluster parameter group to modify.

  • Parameters (list) –

    [REQUIRED]

    A list of parameters in the cluster parameter group to modify.

    • (dict) –

      Detailed information about an individual parameter.

      • ParameterName (string) –

        Specifies the name of the parameter.

      • ParameterValue (string) –

        Specifies the value of the parameter. Must be one or more of the cluster parameter’s AllowedValues in CSV format:

        Valid values are:

        • enabled: The cluster accepts secure connections using TLS version 1.0 through 1.3.

        • disabled: The cluster does not accept secure connections using TLS.

        • fips-140-3: The cluster only accepts secure connections per the requirements of the Federal Information Processing Standards (FIPS) publication 140-3. Only supported starting with Amazon DocumentDB 5.0 (engine version 3.0.3727) clusters in these regions: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1.

        • tls1.2+: The cluster accepts secure connections using TLS version 1.2 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).

        • tls1.3+: The cluster accepts secure connections using TLS version 1.3 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).

      • Description (string) –

        Provides a description of the parameter.

      • Source (string) –

        Indicates the source of the parameter value.

      • ApplyType (string) –

        Specifies the engine-specific parameters type.

      • DataType (string) –

        Specifies the valid data type for the parameter.

      • AllowedValues (string) –

        Specifies the valid range of values for the parameter.

      • IsModifiable (boolean) –

        Indicates whether ( true) or not ( false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

      • MinimumEngineVersion (string) –

        The earliest engine version to which the parameter can apply.

      • ApplyMethod (string) –

        Indicates when to apply parameter updates.

Return type:

dict

Returns:

Response Syntax

{
    'DBClusterParameterGroupName': 'string'
}

Response Structure

  • (dict) –

    Contains the name of a cluster parameter group.

    • DBClusterParameterGroupName (string) –

      The name of a cluster parameter group.

      Constraints:

      • Must be from 1 to 255 letters or numbers.

      • The first character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

      Note

      This value is stored as a lowercase string.

Exceptions

  • DocDB.Client.exceptions.DBParameterGroupNotFoundFault

  • DocDB.Client.exceptions.InvalidDBParameterGroupStateFault