You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RDS::Parameter

Inherits:
Aws::Resources::Resource show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Aws::Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Aws::Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Aws::Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

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

Overloads:

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

    Parameters:

    • name (String)

    Options Hash (options):

    • :client (Client) —

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

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

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#allowed_values ⇒ String (readonly)

Specifies the valid range of values for the parameter.

Returns:

  • (String) —

    Specifies the valid range of values for the parameter.

#apply_method ⇒ String (readonly)

Indicates when to apply parameter updates.

Possible values:

  • immediate
  • pending-reboot

Returns:

  • (String) —

    Indicates when to apply parameter updates.

#apply_type ⇒ String (readonly)

Specifies the engine specific parameters type.

Returns:

  • (String) —

    Specifies the engine specific parameters type.

#data_type ⇒ String (readonly)

Specifies the valid data type for the parameter.

Returns:

  • (String) —

    Specifies the valid data type for the parameter.

#description ⇒ String (readonly)

Provides a description of the parameter.

Returns:

  • (String) —

    Provides a description of the parameter.

#is_modifiable ⇒ Boolean (readonly)

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) —

    Indicates whether (true) or not (false) the parameter can be modified.

#minimum_engine_version ⇒ String (readonly)

The earliest engine version to which the parameter can apply.

Returns:

  • (String) —

    The earliest engine version to which the parameter can apply.

#name ⇒ String (readonly)

Returns:

  • (String)

#parameter_name ⇒ String (readonly)

Specifies the name of the parameter.

Returns:

  • (String) —

    Specifies the name of the parameter.

#parameter_value ⇒ String (readonly)

Specifies the value of the parameter.

Returns:

  • (String) —

    Specifies the value of the parameter.

#source ⇒ String (readonly)

Indicates the source of the parameter value.

Returns:

  • (String) —

    Indicates the source of the parameter value.

#supported_engine_modes ⇒ Array<String> (readonly)

The valid DB engine modes.

Returns:

  • (Array<String>) —

    The valid DB engine modes.