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

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

Overview

Detailed information about an individual parameter.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_valuesString

Specifies the valid range of values for the parameter.

Returns:

  • (String)


4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4527

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

#apply_methodString

Indicates when to apply parameter updates.

Returns:

  • (String)


4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4527

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

#apply_typeString

Specifies the engine-specific parameters type.

Returns:

  • (String)


4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4527

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

#data_typeString

Specifies the valid data type for the parameter.

Returns:

  • (String)


4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4527

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

#descriptionString

Provides a description of the parameter.

Returns:

  • (String)


4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4527

class Parameter < Struct.new(
  :parameter_name,
  :parameter_value,
  :description,
  :source,
  :apply_type,
  :data_type,
  :allowed_values,
  :is_modifiable,
  :minimum_engine_version,
  :apply_method)
  SENSITIVE = []
  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)


4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4527

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

#minimum_engine_versionString

The earliest engine version to which the parameter can apply.

Returns:

  • (String)


4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4527

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

#parameter_nameString

Specifies the name of the parameter.

Returns:

  • (String)


4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4527

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

#parameter_valueString

Specifies the value of the parameter.

Returns:

  • (String)


4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4527

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

#sourceString

Indicates the source of the parameter value.

Returns:

  • (String)


4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4527

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