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

Class: Aws::ElastiCache::Types::Parameter

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

Overview

Describes an individual setting that controls some aspect of ElastiCache behavior.

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_valuesString

The valid range of values for the parameter.

Returns:

  • (String)


4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4115

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :change_type)
  include Aws::Structure
end

#change_typeString

Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

Returns:

  • (String)


4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4115

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :change_type)
  include Aws::Structure
end

#data_typeString

The valid data type for the parameter.

Returns:

  • (String)


4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4115

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :change_type)
  include Aws::Structure
end

#descriptionString

A description of the parameter.

Returns:

  • (String)


4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4115

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :change_type)
  include Aws::Structure
end

#is_modifiableBoolean

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

Returns:

  • (Boolean)


4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4115

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :change_type)
  include Aws::Structure
end

#minimum_engine_versionString

The earliest cache engine version to which the parameter can apply.

Returns:

  • (String)


4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4115

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :change_type)
  include Aws::Structure
end

#parameter_nameString

The name of the parameter.

Returns:

  • (String)


4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4115

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :change_type)
  include Aws::Structure
end

#parameter_valueString

The value of the parameter.

Returns:

  • (String)


4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4115

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :change_type)
  include Aws::Structure
end

#sourceString

The source of the parameter.

Returns:

  • (String)


4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
# File 'gems/aws-sdk-elasticache/lib/aws-sdk-elasticache/types.rb', line 4115

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :change_type)
  include Aws::Structure
end