db_cluster_parameters

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

Overview

Name	db_cluster_parameters
Type	Resource
Id	aws.rds.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	The name of the parameter.
parameter_value	string	The value of the parameter.
source	string	The source of the parameter value.
supported_engine_modes	string	The valid DB engine modes.

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 DB cluster parameter group. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
copy_db_cluster_parameter_group	exec	SourceDBClusterParameterGroupIdentifier, TargetDBClusterParameterGroupIdentifier, TargetDBClusterParameterGroupDescription, region	Tags	Copies the specified DB cluster parameter group. You can't copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies the default parameters and values for the specified DB cluster parameter group family.
reset_db_cluster_parameter_group	exec	DBClusterParameterGroupName, region	ResetAllParameters, Parameters	Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

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 DB cluster parameter group to reset.
SourceDBClusterParameterGroupIdentifier	string	The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide. Constraints: Must specify a valid DB cluster parameter group.
TargetDBClusterParameterGroupDescription	string	A description for the copied DB cluster parameter group.
TargetDBClusterParameterGroupIdentifier	string	The identifier for the copied DB cluster parameter group. Constraints: Can't be null, empty, or blank Must contain from 1 to 255 letters, numbers, or hyphens First character must be a letter Can't end with a hyphen or contain two consecutive hyphens Example: my-cluster-param-group1
region	string	AWS region (default: us-east-1)
Filters	array	A filter that specifies one or more DB cluster parameters to describe. The only supported filter is parameter-name. The results list only includes information about the DB cluster parameters with these names.
Marker	string	An optional pagination token provided by a previous DescribeDBClusterParameters 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 called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
Parameters	array	A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is enabled.
ResetAllParameters	boolean	Specifies whether to reset all parameters in the DB cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.
Source	string	A specific source to return parameters for. Valid Values: engine-default system user
Tags	array

SELECT examples

describe_db_cluster_parameters

Returns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

SELECT
allowed_values,
apply_method,
apply_type,
data_type,
description,
is_modifiable,
minimum_engine_version,
parameter_name,
parameter_value,
source,
supported_engine_modes
FROM aws.rds.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 DB cluster parameter group. You can't copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies the default parameters and values for the specified DB cluster parameter group family.

EXEC aws.rds.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 DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

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