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

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

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

Overview

Note:

When passing Parameter as input to an Aws::Client method, you can use a vanilla 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
}

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)

    Specifies the valid range of values for the parameter.

#apply_methodString

Indicates when to apply parameter updates.

Possible values:

  • immediate
  • pending-reboot

Returns:

  • (String)

    Indicates when to apply parameter updates.

#apply_typeString

Specifies the engine specific parameters type.

Returns:

  • (String)

    Specifies the engine specific parameters type.

#data_typeString

Specifies the valid data type for the parameter.

Returns:

  • (String)

    Specifies the valid data type for the parameter.

#descriptionString

Provides a description of the parameter.

Returns:

  • (String)

    Provides a description of the parameter.

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

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

#minimum_engine_versionString

The earliest engine version to which the parameter can apply.

Returns:

  • (String)

    The earliest engine version to which the parameter can apply.

#parameter_nameString

Specifies the name of the parameter.

Returns:

  • (String)

    Specifies the name of the parameter.

#parameter_valueString

Specifies the value of the parameter.

Returns:

  • (String)

    Specifies the value of the parameter.

#sourceString

Indicates the source of the parameter value.

Returns:

  • (String)

    Indicates the source of the parameter value.