Class: Aws::RDS::Parameter

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-rds/parameter.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ Parameter #initialize(options = {}) ⇒ Parameter

Returns a new instance of Parameter.

Overloads:

  • #initialize(name, options = {}) ⇒ Parameter

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Parameter

    Options Hash (options):

    • :name (required, String)
    • :client (Client) 


19
20
21
22
23
24
 
# File 'lib/aws-sdk-rds/parameter.rb', line 19

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @name = extract_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#allowed_values ⇒ String

Specifies the valid range of values for the parameter.

Returns:

  • (String) 


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.

Returns:

  • (String) 


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.

Returns:

  • (String) 


54
55
56
 
# File 'lib/aws-sdk-rds/parameter.rb', line 54

def apply_type
  data.apply_type
end

#client ⇒ Client

Returns:



93
94
95
 
# File 'lib/aws-sdk-rds/parameter.rb', line 93

def client
  @client
end

#data ⇒ Types::Parameter

Returns the data for this Aws::RDS::Parameter.

Returns:

Raises:

  • (NotImplementedError) —

    Raises when #data_loaded? is ‘false`.



108
109
110
111
 
# File 'lib/aws-sdk-rds/parameter.rb', line 108

def data
  load unless @data
  @data
end

#data_loaded? ⇒ Boolean

Returns ‘true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean) —

    Returns ‘true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



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.

Returns:

  • (String) 


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.

Returns:

  • (String) 


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.

Deprecated. 


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.

Returns:

  • (Boolean) 


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.

Raises:

  • (NotImplementedError) 


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.

Returns:

  • (String) 


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

Returns:

  • (String) 


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.

Returns:

  • (String) 


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.

Returns:

  • (String) 


48
49
50
 
# File 'lib/aws-sdk-rds/parameter.rb', line 48

def source
  data.source
end