reserved_nodes

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

Overview

Name	reserved_nodes
Type	Resource
Id	aws.redshift.reserved_nodes

Fields

The following fields are returned by SELECT queries:

describe_reserved_nodes

Name	Datatype	Description
currency_code	string	The currency code for the reserved cluster.
duration	integer	The duration of the node reservation in seconds.
fixed_price	number	The fixed cost Amazon Redshift charges you for this reserved node.
node_count	integer	The number of reserved compute nodes.
node_type	string	The node type of the reserved node.
offering_type	string	The anticipated utilization of the reserved node, as defined in the reserved node offering.
recurring_charges	string	The recurring charges for the reserved node.
reserved_node_id	string	The unique identifier for the reservation.
reserved_node_offering_id	string	The identifier for the reserved node offering.
reserved_node_offering_type	string
start_time	string	The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.
state	string	The state of the reserved compute node. Possible Values: pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed. active-This reserved node is owned by the caller and is available for use. payment-failed-Payment failed for the purchase attempt. retired-The reserved node is no longer available. exchanging-The owner is exchanging the reserved node for another reserved node.
usage_price	number	The hourly rate Amazon Redshift charges you for this reserved node.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_reserved_nodes	select	region	ReservedNodeId, MaxRecords, Marker	Returns the descriptions of the reserved nodes.
accept_reserved_node_exchange	exec	ReservedNodeId, TargetReservedNodeOfferingId, region		Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.

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
ReservedNodeId	string	A string representing the node identifier of the DC1 Reserved Node to be exchanged.
TargetReservedNodeOfferingId	string	The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling GetReservedNodeExchangeOfferings
region	string	AWS region (default: us-east-1)
Marker	string	An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, Amazon Web Services 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.
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 a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
ReservedNodeId	string	Identifier for the node reservation.

SELECT examples

describe_reserved_nodes

Returns the descriptions of the reserved nodes.

SELECT
currency_code,
duration,
fixed_price,
node_count,
node_type,
offering_type,
recurring_charges,
reserved_node_id,
reserved_node_offering_id,
reserved_node_offering_type,
start_time,
state,
usage_price
FROM aws.redshift.reserved_nodes
WHERE region = '{{ region }}' -- required
AND ReservedNodeId = '{{ ReservedNodeId }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;

Lifecycle Methods

accept_reserved_node_exchange

Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.

EXEC aws.redshift.reserved_nodes.accept_reserved_node_exchange 
@ReservedNodeId='{{ ReservedNodeId }}' --required, 
@TargetReservedNodeOfferingId='{{ TargetReservedNodeOfferingId }}' --required, 
@region='{{ region }}' --required
;