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

Class: Aws::DAX::Types::Parameter

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

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_valuesString

A range of values within which the parameter can be set.

Returns:

  • (String)


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 1121

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

#change_typeString

The conditions under which changes to this parameter can be applied. For example, requires-reboot indicates that a new value for this parameter will only take effect if a node is rebooted.

Returns:

  • (String)


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 1121

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

#data_typeString

The data type of the parameter. For example, integer:

Returns:

  • (String)


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 1121

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

#descriptionString

A description of the parameter

Returns:

  • (String)


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 1121

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

#is_modifiableString

Whether the customer is allowed to modify the parameter.

Returns:

  • (String)


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 1121

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

#node_type_specific_valuesArray<Types::NodeTypeSpecificValue>

A list of node types, and specific parameter values for each node.

Returns:



1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 1121

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

#parameter_nameString

The name of the parameter.

Returns:

  • (String)


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 1121

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

#parameter_typeString

Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.

Returns:

  • (String)


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 1121

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

#parameter_valueString

The value for the parameter.

Returns:

  • (String)


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 1121

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

#sourceString

How the parameter is defined. For example, system denotes a system-defined parameter.

Returns:

  • (String)


1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
# File 'gems/aws-sdk-dax/lib/aws-sdk-dax/types.rb', line 1121

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