cluster_db_revisions

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

Overview

Name	cluster_db_revisions
Type	Resource
Id	aws.redshift.cluster_db_revisions

Fields

The following fields are returned by SELECT queries:

describe_cluster_db_revisions

Name	Datatype	Description
cluster_identifier	string	The unique identifier of the cluster.
current_database_revision	string	A string representing the current cluster version.
database_revision_release_date	string	The date on which the database revision was released.
revision_targets	string	A list of RevisionTarget objects, where each object describes the database revision that a cluster can be updated to.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_cluster_db_revisions	select	region	ClusterIdentifier, MaxRecords, Marker	Returns an array of ClusterDbRevision objects.
modify_cluster_db_revision	update	ClusterIdentifier, RevisionTarget, region		Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.

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
ClusterIdentifier	string	The unique identifier of a cluster whose database revision you want to modify. Example: examplecluster
RevisionTarget	string	The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
region	string	AWS region (default: us-east-1)
ClusterIdentifier	string	A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.
Marker	string	An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both.
MaxRecords	integer	The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. Default: 100 Constraints: minimum 20, maximum 100.

SELECT examples

describe_cluster_db_revisions

Returns an array of ClusterDbRevision objects.

SELECT
cluster_identifier,
current_database_revision,
database_revision_release_date,
revision_targets
FROM aws.redshift.cluster_db_revisions
WHERE region = '{{ region }}' -- required
AND ClusterIdentifier = '{{ ClusterIdentifier }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;

UPDATE examples

modify_cluster_db_revision

Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.

UPDATE aws.redshift.cluster_db_revisions
SET 
-- No updatable properties
WHERE 
ClusterIdentifier = '{{ ClusterIdentifier }}' --required
AND RevisionTarget = '{{ RevisionTarget }}' --required
AND region = '{{ region }}' --required
RETURNING
allow_version_upgrade,
aqua_configuration,
automated_snapshot_retention_period,
availability_zone,
availability_zone_relocation_status,
catalog_arn,
cluster_availability_status,
cluster_create_time,
cluster_identifier,
cluster_namespace_arn,
cluster_nodes,
cluster_parameter_groups,
cluster_public_key,
cluster_revision_number,
cluster_security_groups,
cluster_snapshot_copy_status,
cluster_status,
cluster_subnet_group_name,
cluster_version,
custom_domain_certificate_arn,
custom_domain_certificate_expiry_date,
custom_domain_name,
db_name,
data_transfer_progress,
default_iam_role_arn,
deferred_maintenance_windows,
elastic_ip_status,
elastic_resize_number_of_node_options,
encrypted,
endpoint,
enhanced_vpc_routing,
expected_next_snapshot_schedule_time,
expected_next_snapshot_schedule_time_status,
extra_compute_for_automatic_optimization,
hsm_status,
iam_roles,
ip_address_type,
kms_key_id,
lakehouse_registration_status,
logging_publish_status,
maintenance_track_name,
manual_snapshot_retention_period,
master_password_secret_arn,
master_password_secret_kms_key_id,
master_username,
modify_status,
multi_az,
multi_az_secondary,
next_maintenance_window_start_time,
node_type,
number_of_nodes,
pending_actions,
pending_modified_values,
preferred_maintenance_window,
publicly_accessible,
reserved_node_exchange_status,
resize_info,
restore_status,
snapshot_schedule_identifier,
snapshot_schedule_state,
tags,
total_storage_capacity_in_mega_bytes,
vpc_id,
vpc_security_groups;