Class: Aws::Redshift::Types::DescribeNodeConfigurationOptionsMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb

Overview

Note:

When making an API call, you may pass DescribeNodeConfigurationOptionsMessage data as a hash:

{
  action_type: "restore-cluster", # required, accepts restore-cluster, recommend-node-config, resize-cluster
  cluster_identifier: "String",
  snapshot_identifier: "String",
  owner_account: "String",
  filters: [
    {
      name: "NodeType", # accepts NodeType, NumberOfNodes, EstimatedDiskUtilizationPercent, Mode
      operator: "eq", # accepts eq, lt, gt, le, ge, in, between
      values: ["String"],
    },
  ],
  marker: "String",
  max_records: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action_typeString

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.

Returns:

  • (String)


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5378

class DescribeNodeConfigurationOptionsMessage < Struct.new(
  :action_type,
  :cluster_identifier,
  :snapshot_identifier,
  :owner_account,
  :filters,
  :marker,
  :max_records)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_identifierString

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

Returns:

  • (String)


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5378

class DescribeNodeConfigurationOptionsMessage < Struct.new(
  :action_type,
  :cluster_identifier,
  :snapshot_identifier,
  :owner_account,
  :filters,
  :marker,
  :max_records)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::NodeConfigurationOptionsFilter>

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



5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5378

class DescribeNodeConfigurationOptionsMessage < Struct.new(
  :action_type,
  :cluster_identifier,
  :snapshot_identifier,
  :owner_account,
  :filters,
  :marker,
  :max_records)
  SENSITIVE = []
  include Aws::Structure
end

#markerString

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.

Returns:

  • (String)


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5378

class DescribeNodeConfigurationOptionsMessage < Struct.new(
  :action_type,
  :cluster_identifier,
  :snapshot_identifier,
  :owner_account,
  :filters,
  :marker,
  :max_records)
  SENSITIVE = []
  include Aws::Structure
end

#max_recordsInteger

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.

Returns:

  • (Integer)


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5378

class DescribeNodeConfigurationOptionsMessage < Struct.new(
  :action_type,
  :cluster_identifier,
  :snapshot_identifier,
  :owner_account,
  :filters,
  :marker,
  :max_records)
  SENSITIVE = []
  include Aws::Structure
end

#owner_accountString

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.

Returns:

  • (String)


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5378

class DescribeNodeConfigurationOptionsMessage < Struct.new(
  :action_type,
  :cluster_identifier,
  :snapshot_identifier,
  :owner_account,
  :filters,
  :marker,
  :max_records)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_identifierString

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

Returns:

  • (String)


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5378

class DescribeNodeConfigurationOptionsMessage < Struct.new(
  :action_type,
  :cluster_identifier,
  :snapshot_identifier,
  :owner_account,
  :filters,
  :marker,
  :max_records)
  SENSITIVE = []
  include Aws::Structure
end