Skip to content

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

Description

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

Usage

redshift_describe_node_configuration_options(ActionType,
  ClusterIdentifier, SnapshotIdentifier, SnapshotArn, OwnerAccount,
  Filters, Marker, MaxRecords)

Arguments

  • ActionType

    [required] 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.

  • ClusterIdentifier

    The identifier of the cluster to evaluate for possible node configurations.

  • SnapshotIdentifier

    The identifier of the snapshot to evaluate for possible node configurations.

  • SnapshotArn

    The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.

  • OwnerAccount

    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.

  • Filters

    A set of name, operator, and value items to filter the results.

  • Marker

    An optional parameter that specifies the starting point to return a set of response records. When the results of a describe_node_configuration_options 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

    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.

Value

A list with the following syntax:

list(
  NodeConfigurationOptionList = list(
    list(
      NodeType = "string",
      NumberOfNodes = 123,
      EstimatedDiskUtilizationPercent = 123.0,
      Mode = "standard"|"high-performance"
    )
  ),
  Marker = "string"
)

Request syntax

svc$describe_node_configuration_options(
  ActionType = "restore-cluster"|"recommend-node-config"|"resize-cluster",
  ClusterIdentifier = "string",
  SnapshotIdentifier = "string",
  SnapshotArn = "string",
  OwnerAccount = "string",
  Filters = list(
    list(
      Name = "NodeType"|"NumberOfNodes"|"EstimatedDiskUtilizationPercent"|"Mode",
      Operator = "eq"|"lt"|"gt"|"le"|"ge"|"in"|"between",
      Values = list(
        "string"
      )
    )
  ),
  Marker = "string",
  MaxRecords = 123
)