You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Redshift::Types::DescribeClustersMessage

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 DescribeClustersMessage data as a hash:

{
  cluster_identifier: "String",
  max_records: 1,
  marker: "String",
  tag_keys: ["String"],
  tag_values: ["String"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_identifierString

The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

Returns:

  • (String)


2798
2799
2800
2801
2802
2803
2804
2805
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2798

class DescribeClustersMessage < Struct.new(
  :cluster_identifier,
  :max_records,
  :marker,
  :tag_keys,
  :tag_values)
  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 DescribeClusters request exceed the value specified in MaxRecords, AWS 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.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

Returns:

  • (String)


2798
2799
2800
2801
2802
2803
2804
2805
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2798

class DescribeClustersMessage < Struct.new(
  :cluster_identifier,
  :max_records,
  :marker,
  :tag_keys,
  :tag_values)
  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: 100

Constraints: minimum 20, maximum 100.

Returns:

  • (Integer)


2798
2799
2800
2801
2802
2803
2804
2805
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2798

class DescribeClustersMessage < Struct.new(
  :cluster_identifier,
  :max_records,
  :marker,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#tag_keysArray<String>

A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

Returns:

  • (Array<String>)


2798
2799
2800
2801
2802
2803
2804
2805
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2798

class DescribeClustersMessage < Struct.new(
  :cluster_identifier,
  :max_records,
  :marker,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#tag_valuesArray<String>

A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Returns:

  • (Array<String>)


2798
2799
2800
2801
2802
2803
2804
2805
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2798

class DescribeClustersMessage < Struct.new(
  :cluster_identifier,
  :max_records,
  :marker,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end