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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass OptionSetting data as a 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.

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_valuesString

The allowed values of the option setting.

Returns:

  • (String)


9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9962

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

#apply_typeString

The DB engine specific parameter type.

Returns:

  • (String)


9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9962

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

#data_typeString

The data type of the option setting.

Returns:

  • (String)


9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9962

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

#default_valueString

The default value of the option setting.

Returns:

  • (String)


9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9962

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

#descriptionString

The description of the option setting.

Returns:

  • (String)


9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9962

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

#is_collectionBoolean

Indicates if the option setting is part of a collection.

Returns:

  • (Boolean)


9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9962

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

#is_modifiableBoolean

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

Returns:

  • (Boolean)


9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9962

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

#nameString

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

Returns:

  • (String)


9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9962

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

#valueString

The current value of the option setting.

Returns:

  • (String)


9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 9962

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