Skip to content

DescribeNodeConfigurationOptionsMessage

Source code in docs_src/capo_redshift/types/describe_node_configuration_options_message.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class DescribeNodeConfigurationOptionsMessage(TypedDict, closed=True):
    action_type: NotRequired["capo_redshift.types.action_type.ActionType"]
    """<p>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. </p>"""
    cluster_identifier: NotRequired["capo_redshift.types.string.String"]
    """<p>The identifier of the cluster to evaluate for possible node configurations.</p>"""
    snapshot_identifier: NotRequired["capo_redshift.types.string.String"]
    """<p>The identifier of the snapshot to evaluate for possible node configurations.</p>"""
    snapshot_arn: NotRequired["capo_redshift.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.</p>"""
    owner_account: NotRequired["capo_redshift.types.string.String"]
    """<p>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.</p>"""
    filters: NotRequired[
        "capo_redshift.types.node_configuration_options_filter_list.NodeConfigurationOptionsFilterList"
    ]
    """<p>A set of name, operator, and value items to filter the results.</p>"""
    marker: NotRequired["capo_redshift.types.string.String"]
    """<p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeNodeConfigurationOptions</a> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </p>"""
    max_records: NotRequired["capo_redshift.types.integer_optional.IntegerOptional"]
    """<p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </p> <p>Default: <code>500</code> </p> <p>Constraints: minimum 100, maximum 500.</p>"""

action_type instance-attribute 

action_type: NotRequired[ActionType]

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.

cluster_identifier instance-attribute 

cluster_identifier: NotRequired[String]

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

filters instance-attribute 

filters: NotRequired[NodeConfigurationOptionsFilterList]

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

marker instance-attribute 

marker: NotRequired[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.

max_records instance-attribute 

max_records: NotRequired[IntegerOptional]

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.

owner_account instance-attribute 

owner_account: NotRequired[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.

snapshot_arn instance-attribute 

snapshot_arn: NotRequired[String]

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

snapshot_identifier instance-attribute 

snapshot_identifier: NotRequired[String]

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