Class: Aws::DocDB::Types::Parameter
- Inherits:
-
Struct
- Object
- Struct
- Aws::DocDB::Types::Parameter
- Defined in:
- gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb
Overview
When making an API call, you may pass Parameter data as a hash:
{
parameter_name: "String",
parameter_value: "String",
description: "String",
source: "String",
apply_type: "String",
data_type: "String",
allowed_values: "String",
is_modifiable: false,
minimum_engine_version: "String",
apply_method: "immediate", # accepts immediate, pending-reboot
}
Detailed information about an individual parameter.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#allowed_values ⇒ String
Specifies the valid range of values for the parameter.
-
#apply_method ⇒ String
Indicates when to apply parameter updates.
-
#apply_type ⇒ String
Specifies the engine-specific parameters type.
-
#data_type ⇒ String
Specifies the valid data type for the parameter.
-
#description ⇒ String
Provides 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 engine version to which the parameter can apply.
-
#parameter_name ⇒ String
Specifies the name of the parameter.
-
#parameter_value ⇒ String
Specifies the value of the parameter.
-
#source ⇒ String
Indicates the source of the parameter value.
Instance Attribute Details
#allowed_values ⇒ String
Specifies the valid range of values for the parameter.
5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 |
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 5147 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method) SENSITIVE = [] include Aws::Structure end |
#apply_method ⇒ String
Indicates when to apply parameter updates.
5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 |
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 5147 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method) SENSITIVE = [] include Aws::Structure end |
#apply_type ⇒ String
Specifies the engine-specific parameters type.
5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 |
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 5147 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method) SENSITIVE = [] include Aws::Structure end |
#data_type ⇒ String
Specifies the valid data type for the parameter.
5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 |
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 5147 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
Provides a description of the parameter.
5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 |
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 5147 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method) 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.
5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 |
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 5147 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method) SENSITIVE = [] include Aws::Structure end |
#minimum_engine_version ⇒ String
The earliest engine version to which the parameter can apply.
5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 |
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 5147 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method) SENSITIVE = [] include Aws::Structure end |
#parameter_name ⇒ String
Specifies the name of the parameter.
5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 |
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 5147 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method) SENSITIVE = [] include Aws::Structure end |
#parameter_value ⇒ String
Specifies the value of the parameter.
5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 |
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 5147 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method) SENSITIVE = [] include Aws::Structure end |
#source ⇒ String
Indicates the source of the parameter value.
5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 |
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 5147 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method) SENSITIVE = [] include Aws::Structure end |