node_configuration_options

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

Overview

Name	node_configuration_options
Type	Resource
Id	aws.redshift.node_configuration_options

Fields

The following fields are returned by SELECT queries:

describe_node_configuration_options

Name	Datatype	Description
estimated_disk_utilization_percent	number	The estimated disk utilizaton percentage.
mode	string	The category of the node configuration recommendation.
node_type	string	The node type, such as, "ra3.4xlarge".
number_of_nodes	integer	The number of nodes.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_node_configuration_options	select	ActionType, region	ClusterIdentifier, SnapshotIdentifier, SnapshotArn, OwnerAccount, Filter, Marker, MaxRecords	Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.

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
ActionType	string	The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.
region	string	AWS region (default: us-east-1)
ClusterIdentifier	string	The identifier of the cluster to evaluate for possible node configurations.
Filter	array	A set of name, operator, and value items to filter the results.
Marker	string	An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeNodeConfigurationOptions 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: 500 Constraints: minimum 100, maximum 500.
OwnerAccount	string	The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
SnapshotArn	string	The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.
SnapshotIdentifier	string	The identifier of the snapshot to evaluate for possible node configurations.

SELECT examples

describe_node_configuration_options

Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.

SELECT
estimated_disk_utilization_percent,
mode,
node_type,
number_of_nodes
FROM aws.redshift.node_configuration_options
WHERE ActionType = '{{ ActionType }}' -- required
AND region = '{{ region }}' -- required
AND ClusterIdentifier = '{{ ClusterIdentifier }}'
AND SnapshotIdentifier = '{{ SnapshotIdentifier }}'
AND SnapshotArn = '{{ SnapshotArn }}'
AND OwnerAccount = '{{ OwnerAccount }}'
AND Filter = '{{ Filter }}'
AND Marker = '{{ Marker }}'
AND MaxRecords = '{{ MaxRecords }}'
;