You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::DocDB::Types::Parameter
- Inherits:
-
Struct
- Object
- Struct
- Aws::DocDB::Types::Parameter
- Defined in:
- (unknown)
Overview
When passing Parameter as input to an Aws::Client method, you can use a vanilla 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.
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.
#apply_method ⇒ String
Indicates when to apply parameter updates.
Possible values:
- immediate
- pending-reboot
#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. Some parameters have security or operational implications that
prevent them from being changed.
#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.