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

Detailed information about an individual parameter.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

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 5084

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_method ⇒ String

Indicates when to apply parameter updates.

Returns:

• (String)

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

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_type ⇒ String

Specifies the engine-specific parameters type.

Returns:

• (String)

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

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_type ⇒ String

Specifies the valid data type for the parameter.

Returns:

• (String)

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

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

#description ⇒ String

Provides a description of the parameter.

Returns:

• (String)

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

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_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 5084

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_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 5084

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_name ⇒ String

Specifies the name of the parameter.

Returns:

• (String)

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

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_value ⇒ String

Specifies the value of the parameter. Must be one or more of the cluster parameter's AllowedValues in CSV format:

Valid values are:

• enabled: The cluster accepts secure connections using TLS version 1.0 through 1.3.

• disabled: The cluster does not accept secure connections using TLS.

• fips-140-3: The cluster only accepts secure connections per the requirements of the Federal Information Processing Standards (FIPS) publication 140-3. Only supported starting with Amazon DocumentDB 5.0 (engine version 3.0.3727) clusters in these regions: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1.

• tls1.2+: The cluster accepts secure connections using TLS version 1.2 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).

• tls1.3+: The cluster accepts secure connections using TLS version 1.3 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).

Returns:

• (String)

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

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

#source ⇒ String

Indicates the source of the parameter value.

Returns:

• (String)

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

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