Class: Aws::RDS::Types::Parameter
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDS::Types::Parameter
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-rds/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
supported_engine_modes: ["String"],
}
This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
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.
-
#supported_engine_modes ⇒ Array<String>
The valid DB engine modes.
Instance Attribute Details
#allowed_values ⇒ String
Specifies the valid range of values for the parameter.
11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 |
# File 'lib/aws-sdk-rds/types.rb', line 11925 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method, :supported_engine_modes) include Aws::Structure end |
#apply_method ⇒ String
Indicates when to apply parameter updates.
11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 |
# File 'lib/aws-sdk-rds/types.rb', line 11925 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method, :supported_engine_modes) include Aws::Structure end |
#apply_type ⇒ String
Specifies the engine specific parameters type.
11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 |
# File 'lib/aws-sdk-rds/types.rb', line 11925 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method, :supported_engine_modes) include Aws::Structure end |
#data_type ⇒ String
Specifies the valid data type for the parameter.
11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 |
# File 'lib/aws-sdk-rds/types.rb', line 11925 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method, :supported_engine_modes) include Aws::Structure end |
#description ⇒ String
Provides a description of the parameter.
11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 |
# File 'lib/aws-sdk-rds/types.rb', line 11925 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method, :supported_engine_modes) 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.
11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 |
# File 'lib/aws-sdk-rds/types.rb', line 11925 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method, :supported_engine_modes) include Aws::Structure end |
#minimum_engine_version ⇒ String
The earliest engine version to which the parameter can apply.
11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 |
# File 'lib/aws-sdk-rds/types.rb', line 11925 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method, :supported_engine_modes) include Aws::Structure end |
#parameter_name ⇒ String
Specifies the name of the parameter.
11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 |
# File 'lib/aws-sdk-rds/types.rb', line 11925 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method, :supported_engine_modes) include Aws::Structure end |
#parameter_value ⇒ String
Specifies the value of the parameter.
11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 |
# File 'lib/aws-sdk-rds/types.rb', line 11925 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method, :supported_engine_modes) include Aws::Structure end |
#source ⇒ String
Indicates the source of the parameter value.
11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 |
# File 'lib/aws-sdk-rds/types.rb', line 11925 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method, :supported_engine_modes) include Aws::Structure end |
#supported_engine_modes ⇒ Array<String>
The valid DB engine modes.
11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 |
# File 'lib/aws-sdk-rds/types.rb', line 11925 class Parameter < Struct.new( :parameter_name, :parameter_value, :description, :source, :apply_type, :data_type, :allowed_values, :is_modifiable, :minimum_engine_version, :apply_method, :supported_engine_modes) include Aws::Structure end |