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

Inherits:

Struct

• Object
• Struct
• Aws::ElastiCache::Types::Parameter

Includes:

Structure

Defined in:

lib/aws-sdk-elasticache/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allowed_values ⇒ String

  The valid range of values for the parameter.

• #change_type ⇒ String

  Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied.

• #data_type ⇒ String

  The valid data type for the parameter.

• #description ⇒ String

  A description of the parameter.

• #is_modifiable ⇒ Boolean

  Indicates whether (‘true`) or not (`false`) the parameter can be modified.

• #minimum_engine_version ⇒ String

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

• #parameter_name ⇒ String

  The name of the parameter.

• #parameter_value ⇒ String

  The value of the parameter.

• #source ⇒ String

  The source of the parameter.

Instance Attribute Details

#allowed_values ⇒ String

The valid range of values for the parameter.

Returns:

• (String)

# File 'lib/aws-sdk-elasticache/types.rb', line 7232

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

#change_type ⇒ String

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].

[1]: docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Rebooting.html

Returns:

• (String)

# File 'lib/aws-sdk-elasticache/types.rb', line 7232

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

#data_type ⇒ String

The valid data type for the parameter.

Returns:

• (String)

# File 'lib/aws-sdk-elasticache/types.rb', line 7232

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

#description ⇒ String

A description of the parameter.

Returns:

• (String)

# File 'lib/aws-sdk-elasticache/types.rb', line 7232

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

#is_modifiable ⇒ Boolean

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)

# File 'lib/aws-sdk-elasticache/types.rb', line 7232

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

#minimum_engine_version ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-elasticache/types.rb', line 7232

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

#parameter_name ⇒ String

The name of the parameter.

Returns:

• (String)

# File 'lib/aws-sdk-elasticache/types.rb', line 7232

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

#parameter_value ⇒ String

The value of the parameter.

Returns:

• (String)

# File 'lib/aws-sdk-elasticache/types.rb', line 7232

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

#source ⇒ String

The source of the parameter.

Returns:

• (String)

# File 'lib/aws-sdk-elasticache/types.rb', line 7232

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