Class: Aws::RDS::Parameter
- Inherits:
-
Object
- Object
- Aws::RDS::Parameter
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-rds/parameter.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes 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.
- #name ⇒ String (also: #parameter_name)
-
#parameter_value ⇒ String
Specifies the value of the parameter.
-
#source ⇒ String
Indicates the source of the parameter value.
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::Parameter
Returns the data for this Parameter.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
- #identifiers ⇒ Object deprecated private Deprecated.
-
#initialize(*args) ⇒ Parameter
constructor
A new instance of Parameter.
- #load ⇒ Object (also: #reload) private
Constructor Details
#initialize(name, options = {}) ⇒ Parameter #initialize(options = {}) ⇒ Parameter
Returns a new instance of Parameter.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-rds/parameter.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @name = extract_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#allowed_values ⇒ String
Specifies the valid range of values for the parameter.
66 67 68 |
# File 'lib/aws-sdk-rds/parameter.rb', line 66 def allowed_values data.allowed_values end |
#apply_method ⇒ String
Indicates when to apply parameter updates.
86 87 88 |
# File 'lib/aws-sdk-rds/parameter.rb', line 86 def apply_method data.apply_method end |
#apply_type ⇒ String
Specifies the engine specific parameters type.
54 55 56 |
# File 'lib/aws-sdk-rds/parameter.rb', line 54 def apply_type data.apply_type end |
#data ⇒ Types::Parameter
Returns the data for this Aws::RDS::Parameter.
108 109 110 111 |
# File 'lib/aws-sdk-rds/parameter.rb', line 108 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
116 117 118 |
# File 'lib/aws-sdk-rds/parameter.rb', line 116 def data_loaded? !!@data end |
#data_type ⇒ String
Specifies the valid data type for the parameter.
60 61 62 |
# File 'lib/aws-sdk-rds/parameter.rb', line 60 def data_type data.data_type end |
#description ⇒ String
Provides a description of the parameter.
42 43 44 |
# File 'lib/aws-sdk-rds/parameter.rb', line 42 def description data.description end |
#identifiers ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
122 123 124 |
# File 'lib/aws-sdk-rds/parameter.rb', line 122 def identifiers { name: @name } 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.
74 75 76 |
# File 'lib/aws-sdk-rds/parameter.rb', line 74 def is_modifiable data.is_modifiable end |
#load ⇒ Object Also known as: reload
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
99 100 101 102 |
# File 'lib/aws-sdk-rds/parameter.rb', line 99 def load msg = "#load is not implemented, data only available via enumeration" raise NotImplementedError, msg end |
#minimum_engine_version ⇒ String
The earliest engine version to which the parameter can apply.
80 81 82 |
# File 'lib/aws-sdk-rds/parameter.rb', line 80 def minimum_engine_version data.minimum_engine_version end |
#name ⇒ String Also known as: parameter_name
29 30 31 |
# File 'lib/aws-sdk-rds/parameter.rb', line 29 def name @name end |
#parameter_value ⇒ String
Specifies the value of the parameter.
36 37 38 |
# File 'lib/aws-sdk-rds/parameter.rb', line 36 def parameter_value data.parameter_value end |
#source ⇒ String
Indicates the source of the parameter value.
48 49 50 |
# File 'lib/aws-sdk-rds/parameter.rb', line 48 def source data.source end |