Class: Aws::Redshift::Types::Parameter

Inherits:

Struct

• Object
• Struct
• Aws::Redshift::Types::Parameter

Includes:

Structure

Defined in:

lib/aws-sdk-redshift/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",
  data_type: "String",
  allowed_values: "String",
  apply_type: "static", # accepts static, dynamic
  is_modifiable: false,
  minimum_engine_version: "String",
}

Describes a parameter in a cluster parameter group.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #allowed_values ⇒ String

  The valid range of values for the parameter.

• #apply_type ⇒ String

  Specifies how to apply the WLM configuration parameter.

• #data_type ⇒ String

  The data type of the parameter.

• #description ⇒ String

  A description of the parameter.

• #is_modifiable ⇒ Boolean

  If ‘true`, the parameter can be modified.

• #minimum_engine_version ⇒ String

  The earliest engine version to which the parameter can apply.

• #parameter_name ⇒ String

  The name of the parameter.

• #parameter_value ⇒ String

  The value of the parameter.

• #source ⇒ String

  The source of the parameter value, such as “engine-default” or “user”.

Instance Attribute Details

#allowed_values ⇒ String

The valid range of values for the parameter.

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 6231

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

#apply_type ⇒ String

Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to [Amazon Redshift Parameter Groups] in the *Amazon Redshift Cluster Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 6231

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

#data_type ⇒ String

The data type of the parameter.

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 6231

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

#description ⇒ String

A description of the parameter.

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 6231

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

#is_modifiable ⇒ Boolean

If ‘true`, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

Returns:

• (Boolean)

# File 'lib/aws-sdk-redshift/types.rb', line 6231

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

#minimum_engine_version ⇒ String

The earliest engine version to which the parameter can apply.

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 6231

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

#parameter_name ⇒ String

The name of the parameter.

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 6231

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

#parameter_value ⇒ String

The value of the parameter.

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 6231

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

#source ⇒ String

The source of the parameter value, such as “engine-default” or “user”.

Returns:

• (String)

# File 'lib/aws-sdk-redshift/types.rb', line 6231

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