db_cluster_parameters

Creates, updates, deletes, gets or lists a db_cluster_parameters resource.

Overview

Name	db_cluster_parameters
Type	Resource
Id	aws.docdb.db_cluster_parameters

Fields

The following fields are returned by SELECT queries:

describe_db_cluster_parameters

Name	Datatype	Description
allowed_values	string	Specifies the valid range of values for the parameter.
apply_method	string	Indicates when to apply parameter updates.
apply_type	string	Specifies the engine-specific parameters type.
data_type	string	Specifies the valid data type for the parameter.
description	string	Provides a description of the parameter.
is_modifiable	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.
minimum_engine_version	string	The earliest engine version to which the parameter can apply.
parameter_name	string	Specifies the name of the parameter.
parameter_value	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).
source	string	Indicates the source of the parameter value.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_db_cluster_parameters	select	DBClusterParameterGroupName, region	Source, Filters, MaxRecords, Marker	Returns the detailed parameter list for a particular cluster parameter group.
copy_db_cluster_parameter_group	exec	SourceDBClusterParameterGroupIdentifier, TargetDBClusterParameterGroupIdentifier, TargetDBClusterParameterGroupDescription, region	Tags	Copies the specified cluster parameter group.
reset_db_cluster_parameter_group	exec	DBClusterParameterGroupName, region	ResetAllParameters, Parameters	Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
DBClusterParameterGroupName	string	The name of the cluster parameter group to reset.
SourceDBClusterParameterGroupIdentifier	string	The identifier or Amazon Resource Name (ARN) for the source cluster parameter group. Constraints: Must specify a valid cluster parameter group. 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, my-db-cluster-param-group, or a valid ARN. 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, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.
TargetDBClusterParameterGroupDescription	string	A description for the copied cluster parameter group.
TargetDBClusterParameterGroupIdentifier	string	The identifier for the copied cluster parameter group. Constraints: Cannot be null, empty, or blank. Must contain from 1 to 255 letters, numbers, or hyphens. The first character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: my-cluster-param-group1
region	string	AWS region (default: us-east-1)
Filters	array	This parameter is not currently supported.
Marker	string	An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords	integer	The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
Parameters	array	A list of parameter names in the cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.
ResetAllParameters	boolean	A value that is set to true to reset all parameters in the cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.
Source	string	A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.
Tags	array	The tags that are to be assigned to the parameter group.

SELECT examples

describe_db_cluster_parameters

Returns the detailed parameter list for a particular cluster parameter group.

SELECT
allowed_values,
apply_method,
apply_type,
data_type,
description,
is_modifiable,
minimum_engine_version,
parameter_name,
parameter_value,
source
FROM aws.docdb.db_cluster_parameters
WHERE DBClusterParameterGroupName = '{{ DBClusterParameterGroupName }}' -- required
AND region = '{{ region }}' -- required
AND Source = '{{ Source }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;

Lifecycle Methods

copy_db_cluster_parameter_group

Copies the specified cluster parameter group.

EXEC aws.docdb.db_cluster_parameters.copy_db_cluster_parameter_group 
@SourceDBClusterParameterGroupIdentifier='{{ SourceDBClusterParameterGroupIdentifier }}' --required, 
@TargetDBClusterParameterGroupIdentifier='{{ TargetDBClusterParameterGroupIdentifier }}' --required, 
@TargetDBClusterParameterGroupDescription='{{ TargetDBClusterParameterGroupDescription }}' --required, 
@region='{{ region }}' --required, 
@Tags='{{ Tags }}'
;

reset_db_cluster_parameter_group

Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot.

EXEC aws.docdb.db_cluster_parameters.reset_db_cluster_parameter_group 
@DBClusterParameterGroupName='{{ DBClusterParameterGroupName }}' --required, 
@region='{{ region }}' --required, 
@ResetAllParameters={{ ResetAllParameters }}, 
@Parameters='{{ Parameters }}'
;