[ aws . redshift ]

describe-node-configuration-options

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-node-configuration-options is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: NodeConfigurationOptionList

Synopsis

  describe-node-configuration-options
--action-type <value>
[--cluster-identifier <value>]
[--snapshot-identifier <value>]
[--owner-account <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--action-type (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.

Possible values:

• restore-cluster

• recommend-node-config

• resize-cluster

--cluster-identifier (string)

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

--snapshot-identifier (string)

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

--owner-account (string)

The AWS customer 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 (list)

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

(structure)

A set of elements to filter the returned node configurations.

Name -> (string)

The name of the element to filter.

Operator -> (string)

The filter operator. If filter Name is NodeType only the ‘in’ operator is supported. Provide one value to evaluate for ‘eq’, ‘lt’, ‘le’, ‘gt’, and ‘ge’. Provide two values to evaluate for ‘between’. Provide a list of values for ‘in’.

Values -> (list)

List of values. Compare Name using Operator to Values. If filter Name is NumberOfNodes, then values can range from 0 to 200. If filter Name is EstimatedDiskUtilizationPercent, then values can range from 0 to 100. For example, filter NumberOfNodes (name) GT (operator) 3 (values).

(string)

Shorthand Syntax:

Name=string,Operator=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "NodeType"|"NumberOfNodes"|"EstimatedDiskUtilizationPercent"|"Mode",
    "Operator": "eq"|"lt"|"gt"|"le"|"ge"|"in"|"between",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe node configuration options

The following describe-node-configuration-options example displays the properties of possible node configurations such as node type, number of nodes, and disk usage for the specified cluster snapshot.

aws redshift describe-node-configuration-options \
    --action-type restore-cluster \
    --snapshot-identifier rs:mycluster-2019-12-09-16-42-43

Output:

{
    "NodeConfigurationOptionList": [
        {
            "NodeType": "dc2.large",
            "NumberOfNodes": 2,
            "EstimatedDiskUtilizationPercent": 19.61
        },
        {
            "NodeType": "dc2.large",
            "NumberOfNodes": 4,
            "EstimatedDiskUtilizationPercent": 9.96
        },
        {
            "NodeType": "ds2.xlarge",
            "NumberOfNodes": 2,
            "EstimatedDiskUtilizationPercent": 1.53
        },
        {
            "NodeType": "ds2.xlarge",
            "NumberOfNodes": 4,
            "EstimatedDiskUtilizationPercent": 0.78
        }
    ]
}

For more information, see Purchasing Amazon Redshift Reserved Nodes in the Amazon Redshift Cluster Management Guide.

Output

NodeConfigurationOptionList -> (list)

A list of valid node configurations.

(structure)

A list of node configurations.

NodeType -> (string)

The node type, such as, “ds2.8xlarge”.

NumberOfNodes -> (integer)

The number of nodes.

EstimatedDiskUtilizationPercent -> (double)

The estimated disk utilizaton percentage.

Mode -> (string)

The category of the node configuration recommendation.

Marker -> (string)

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.