Class: Aws::RDS::Types::Parameter

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 Parameter data as a hash:

{
  parameter_name: "String",
  parameter_value: "String",
  description: "String",
  source: "String",
  apply_type: "String",
  data_type: "String",
  allowed_values: "String",
  is_modifiable: false,
  minimum_engine_version: "String",
  apply_method: "immediate", # accepts immediate, pending-reboot
  supported_engine_modes: ["String"],
}

This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_valuesString

Specifies the valid range of values for the parameter.

Returns:

  • (String)


14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14797

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :apply_method,
  :supported_engine_modes)
  include Aws::Structure
end

#apply_methodString

Indicates when to apply parameter updates.

Returns:

  • (String)


14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14797

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :apply_method,
  :supported_engine_modes)
  include Aws::Structure
end

#apply_typeString

Specifies the engine specific parameters type.

Returns:

  • (String)


14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14797

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :apply_method,
  :supported_engine_modes)
  include Aws::Structure
end

#data_typeString

Specifies the valid data type for the parameter.

Returns:

  • (String)


14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14797

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :apply_method,
  :supported_engine_modes)
  include Aws::Structure
end

#descriptionString

Provides a description of the parameter.

Returns:

  • (String)


14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14797

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :apply_method,
  :supported_engine_modes)
  include Aws::Structure
end

#is_modifiableBoolean

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)


14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14797

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :apply_method,
  :supported_engine_modes)
  include Aws::Structure
end

#minimum_engine_versionString

The earliest engine version to which the parameter can apply.

Returns:

  • (String)


14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14797

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :apply_method,
  :supported_engine_modes)
  include Aws::Structure
end

#parameter_nameString

Specifies the name of the parameter.

Returns:

  • (String)


14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14797

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :apply_method,
  :supported_engine_modes)
  include Aws::Structure
end

#parameter_valueString

Specifies the value of the parameter.

Returns:

  • (String)


14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14797

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :apply_method,
  :supported_engine_modes)
  include Aws::Structure
end

#sourceString

Indicates the source of the parameter value.

Returns:

  • (String)


14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14797

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :apply_method,
  :supported_engine_modes)
  include Aws::Structure
end

#supported_engine_modesArray<String>

The valid DB engine modes.

Returns:

  • (Array<String>)


14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 14797

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :apply_method,
  :supported_engine_modes)
  include Aws::Structure
end