relational_database_parameters

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

Overview

Name	relational_database_parameters
Type	Resource
Id	aws.lightsail.relational_database_parameters

Fields

The following fields are returned by SELECT queries:

get_relational_database_parameters

Name	Datatype	Description
allowed_values	string	Specifies the valid range of values for the parameter.
apply_method	string	Indicates when parameter updates are applied. Can be immediate or pending-reboot.
apply_type	string	Specifies the engine-specific parameter type.
data_type	string	Specifies the valid data type for the parameter.
description	string	Provides a description of the parameter.
is_modifiable	boolean	A Boolean value indicating whether the parameter can be modified.
parameter_name	string	Specifies the name of the parameter.
parameter_value	string	Specifies the value of the parameter.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_relational_database_parameters	select	region		Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail. In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.
update_relational_database_parameters	update	region, relationalDatabaseName, parameters		Allows the update of one or more parameters of a database in Amazon Lightsail. Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation. The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer 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
region	string	AWS region (default: us-east-1)

SELECT examples

get_relational_database_parameters

Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail. In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.

SELECT
allowed_values,
apply_method,
apply_type,
data_type,
description,
is_modifiable,
parameter_name,
parameter_value
FROM aws.lightsail.relational_database_parameters
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_relational_database_parameters

Allows the update of one or more parameters of a database in Amazon Lightsail. Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation. The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

UPDATE aws.lightsail.relational_database_parameters
SET 
relationalDatabaseName = '{{ relationalDatabaseName }}',
parameters = '{{ parameters }}'
WHERE 
region = '{{ region }}' --required
AND relationalDatabaseName = '{{ relationalDatabaseName }}' --required
AND parameters = '{{ parameters }}' --required
RETURNING
operations;