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

Class: Aws::DocDB::Types::Parameter

Inherits:

Struct

• Object
• Struct
• Aws::DocDB::Types::Parameter

Defined in:

gems/aws-sdk-docdb/lib/aws-sdk-docdb/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
}

Detailed information about an individual parameter.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #allowed_values ⇒ String

  Specifies the valid range of values for the parameter.

• #apply_method ⇒ String

  Indicates when to apply parameter updates.

• #apply_type ⇒ String

  Specifies the engine-specific parameters type.

• #data_type ⇒ String

  Specifies the valid data type for the parameter.

• #description ⇒ String

  Provides a description of the parameter.

• #is_modifiable ⇒ Boolean

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

• #minimum_engine_version ⇒ String

  The earliest engine version to which the parameter can apply.

• #parameter_name ⇒ String

  Specifies the name of the parameter.

• #parameter_value ⇒ String

  Specifies the value of the parameter.

• #source ⇒ String

  Indicates the source of the parameter value.

Instance Attribute Details

#allowed_values ⇒ String

Specifies the valid range of values for the parameter.

Returns:

• (String)

# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3932

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

#apply_method ⇒ String

Indicates when to apply parameter updates.

Returns:

• (String)

# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3932

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

#apply_type ⇒ String

Specifies the engine-specific parameters type.

Returns:

• (String)

# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3932

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

#data_type ⇒ String

Specifies the valid data type for the parameter.

Returns:

• (String)

# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3932

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

#description ⇒ String

Provides a description of the parameter.

Returns:

• (String)

# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3932

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

#is_modifiable ⇒ Boolean

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)

# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3932

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

#minimum_engine_version ⇒ String

The earliest engine version to which the parameter can apply.

Returns:

• (String)

# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3932

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

#parameter_name ⇒ String

Specifies the name of the parameter.

Returns:

• (String)

# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3932

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

#parameter_value ⇒ String

Specifies the value of the parameter.

Returns:

• (String)

# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3932

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

#source ⇒ String

Indicates the source of the parameter value.

Returns:

• (String)

# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 3932

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