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

Class: Aws::Redshift::Types::DescribeClusterVersionsMessage

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

{
  cluster_version: "String",
  cluster_parameter_group_family: "String",
  max_records: 1,
  marker: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_parameter_group_familyString

The name of a specific cluster parameter group family to return details for.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Returns:

  • (String)


2728
2729
2730
2731
2732
2733
2734
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2728

class DescribeClusterVersionsMessage < Struct.new(
  :cluster_version,
  :cluster_parameter_group_family,
  :max_records,
  :marker)
  include Aws::Structure
end

#cluster_versionString

The specific cluster version to return.

Example: 1.0

Returns:

  • (String)


2728
2729
2730
2731
2732
2733
2734
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2728

class DescribeClusterVersionsMessage < Struct.new(
  :cluster_version,
  :cluster_parameter_group_family,
  :max_records,
  :marker)
  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 DescribeClusterVersions 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.

Returns:

  • (String)


2728
2729
2730
2731
2732
2733
2734
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2728

class DescribeClusterVersionsMessage < Struct.new(
  :cluster_version,
  :cluster_parameter_group_family,
  :max_records,
  :marker)
  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)


2728
2729
2730
2731
2732
2733
2734
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2728

class DescribeClusterVersionsMessage < Struct.new(
  :cluster_version,
  :cluster_parameter_group_family,
  :max_records,
  :marker)
  include Aws::Structure
end