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

Class: Aws::RDS::Types::OptionSetting

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing OptionSetting as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "String",
  value: "String",
  default_value: "String",
  description: "String",
  apply_type: "String",
  data_type: "String",
  allowed_values: "String",
  is_modifiable: false,
  is_collection: false,
}

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_values ⇒ String

The allowed values of the option setting.

Returns:

  • (String) —

    The allowed values of the option setting.

#apply_type ⇒ String

The DB engine specific parameter type.

Returns:

  • (String) —

    The DB engine specific parameter type.

#data_type ⇒ String

The data type of the option setting.

Returns:

  • (String) —

    The data type of the option setting.

#default_value ⇒ String

The default value of the option setting.

Returns:

  • (String) —

    The default value of the option setting.

#description ⇒ String

The description of the option setting.

Returns:

  • (String) —

    The description of the option setting.

#is_collection ⇒ Boolean

Indicates if the option setting is part of a collection.

Returns:

  • (Boolean) —

    Indicates if the option setting is part of a collection.

#is_modifiable ⇒ Boolean

A Boolean value that, when true, indicates the option setting can be modified from the default.

Returns:

  • (Boolean) —

    A Boolean value that, when true, indicates the option setting can be modified from the default.

#name ⇒ String

The name of the option that has settings that you can set.

Returns:

  • (String) —

    The name of the option that has settings that you can set.

#value ⇒ String

The current value of the option setting.

Returns:

  • (String) —

    The current value of the option setting.