Class: Aws::ElastiCache::Types::DescribeCacheEngineVersionsMessage

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

Overview

Note:

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

{
  engine: "String",
  engine_version: "String",
  cache_parameter_group_family: "String",
  max_records: 1,
  marker: "String",
  default_only: false,
}

Represents the input of a DescribeCacheEngineVersions operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cache_parameter_group_familyString

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

Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |

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)


3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 3499

class DescribeCacheEngineVersionsMessage < Struct.new(
  :engine,
  :engine_version,
  :cache_parameter_group_family,
  :max_records,
  :marker,
  :default_only)
  SENSITIVE = []
  include Aws::Structure
end

#default_onlyBoolean

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

Returns:

  • (Boolean)


3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 3499

class DescribeCacheEngineVersionsMessage < Struct.new(
  :engine,
  :engine_version,
  :cache_parameter_group_family,
  :max_records,
  :marker,
  :default_only)
  SENSITIVE = []
  include Aws::Structure
end

#engineString

The cache engine to return. Valid values: memcached | redis

Returns:

  • (String)


3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 3499

class DescribeCacheEngineVersionsMessage < Struct.new(
  :engine,
  :engine_version,
  :cache_parameter_group_family,
  :max_records,
  :marker,
  :default_only)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

The cache engine version to return.

Example: 1.4.14

Returns:

  • (String)


3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 3499

class DescribeCacheEngineVersionsMessage < Struct.new(
  :engine,
  :engine_version,
  :cache_parameter_group_family,
  :max_records,
  :marker,
  :default_only)
  SENSITIVE = []
  include Aws::Structure
end

#markerString

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

  • (String)


3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 3499

class DescribeCacheEngineVersionsMessage < Struct.new(
  :engine,
  :engine_version,
  :cache_parameter_group_family,
  :max_records,
  :marker,
  :default_only)
  SENSITIVE = []
  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 marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

Returns:

  • (Integer)


3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 3499

class DescribeCacheEngineVersionsMessage < Struct.new(
  :engine,
  :engine_version,
  :cache_parameter_group_family,
  :max_records,
  :marker,
  :default_only)
  SENSITIVE = []
  include Aws::Structure
end