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

Class: Aws::RDS::Types::DescribeOptionGroupsMessage

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

Overview

Note:

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

{
  option_group_name: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  marker: "String",
  max_records: 1,
  engine_name: "String",
  major_engine_version: "String",
}

Instance Attribute Summary collapse

Instance Attribute Details

#engine_nameString

Filters the list of option groups to only include groups associated with a specific database engine.

Returns:

  • (String)


6981
6982
6983
6984
6985
6986
6987
6988
6989
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6981

class DescribeOptionGroupsMessage < Struct.new(
  :option_group_name,
  :filters,
  :marker,
  :max_records,
  :engine_name,
  :major_engine_version)
  include Aws::Structure
end

#filtersArray<Types::Filter>

This parameter is not currently supported.

Returns:



6981
6982
6983
6984
6985
6986
6987
6988
6989
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6981

class DescribeOptionGroupsMessage < Struct.new(
  :option_group_name,
  :filters,
  :marker,
  :max_records,
  :engine_name,
  :major_engine_version)
  include Aws::Structure
end

#major_engine_versionString

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

Returns:

  • (String)


6981
6982
6983
6984
6985
6986
6987
6988
6989
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6981

class DescribeOptionGroupsMessage < Struct.new(
  :option_group_name,
  :filters,
  :marker,
  :max_records,
  :engine_name,
  :major_engine_version)
  include Aws::Structure
end

#markerString

An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

  • (String)


6981
6982
6983
6984
6985
6986
6987
6988
6989
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6981

class DescribeOptionGroupsMessage < Struct.new(
  :option_group_name,
  :filters,
  :marker,
  :max_records,
  :engine_name,
  :major_engine_version)
  include Aws::Structure
end

#max_recordsInteger

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer)


6981
6982
6983
6984
6985
6986
6987
6988
6989
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6981

class DescribeOptionGroupsMessage < Struct.new(
  :option_group_name,
  :filters,
  :marker,
  :max_records,
  :engine_name,
  :major_engine_version)
  include Aws::Structure
end

#option_group_nameString

The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.

Returns:

  • (String)


6981
6982
6983
6984
6985
6986
6987
6988
6989
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6981

class DescribeOptionGroupsMessage < Struct.new(
  :option_group_name,
  :filters,
  :marker,
  :max_records,
  :engine_name,
  :major_engine_version)
  include Aws::Structure
end