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

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::OptionSetting

Includes:

Structure

Defined in:

lib/aws-sdk-rds/types.rb

Overview

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:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allowed_values ⇒ String

  The allowed values of the option setting.

• #apply_type ⇒ String

  The DB engine specific parameter type.

• #data_type ⇒ String

  The data type of the option setting.

• #default_value ⇒ String

  The default value of the option setting.

• #description ⇒ String

  The description of the option setting.

• #is_collection ⇒ 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.

• #name ⇒ String

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

• #value ⇒ String

  The current value of the option setting.

Instance Attribute Details

#allowed_values ⇒ String

The allowed values of the option setting.

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 18008

class OptionSetting < Struct.new(
  :name,
  :value,
  :default_value,
  :description,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :is_collection)
  SENSITIVE = []
  include Aws::Structure
end

#apply_type ⇒ String

The DB engine specific parameter type.

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 18008

class OptionSetting < Struct.new(
  :name,
  :value,
  :default_value,
  :description,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :is_collection)
  SENSITIVE = []
  include Aws::Structure
end

#data_type ⇒ String

The data type of the option setting.

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 18008

class OptionSetting < Struct.new(
  :name,
  :value,
  :default_value,
  :description,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :is_collection)
  SENSITIVE = []
  include Aws::Structure
end

#default_value ⇒ String

The default value of the option setting.

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 18008

class OptionSetting < Struct.new(
  :name,
  :value,
  :default_value,
  :description,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :is_collection)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the option setting.

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 18008

class OptionSetting < Struct.new(
  :name,
  :value,
  :default_value,
  :description,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :is_collection)
  SENSITIVE = []
  include Aws::Structure
end

#is_collection ⇒ Boolean

Indicates if the option setting is part of a collection.

Returns:

• (Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 18008

class OptionSetting < Struct.new(
  :name,
  :value,
  :default_value,
  :description,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :is_collection)
  SENSITIVE = []
  include Aws::Structure
end

#is_modifiable ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 18008

class OptionSetting < Struct.new(
  :name,
  :value,
  :default_value,
  :description,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :is_collection)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 18008

class OptionSetting < Struct.new(
  :name,
  :value,
  :default_value,
  :description,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :is_collection)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ String

The current value of the option setting.

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 18008

class OptionSetting < Struct.new(
  :name,
  :value,
  :default_value,
  :description,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :is_collection)
  SENSITIVE = []
  include Aws::Structure
end