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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshift/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.

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_valuesString

The valid range of values for the parameter.

Returns:

  • (String)


5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5057

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_typeString

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.

Returns:

  • (String)


5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5057

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_typeString

The data type of the parameter.

Returns:

  • (String)


5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5057

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

#descriptionString

A description of the parameter.

Returns:

  • (String)


5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5057

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_modifiableBoolean

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

Returns:

  • (Boolean)


5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5057

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_versionString

The earliest engine version to which the parameter can apply.

Returns:

  • (String)


5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5057

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_nameString

The name of the parameter.

Returns:

  • (String)


5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5057

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_valueString

The value of the parameter.

Returns:

  • (String)


5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5057

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

#sourceString

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

Returns:

  • (String)


5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 5057

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