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

Class: Aws::Redshift::Types::ClusterParameterStatus

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

Overview

Describes the status of a parameter group.

Instance Attribute Summary collapse

Instance Attribute Details

#parameter_apply_error_descriptionString

The error that prevented the parameter from being applied to the database.

Returns:

  • (String)


647
648
649
650
651
652
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 647

class ClusterParameterStatus < Struct.new(
  :parameter_name,
  :parameter_apply_status,
  :parameter_apply_error_description)
  include Aws::Structure
end

#parameter_apply_statusString

The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.

The following are possible statuses and descriptions.

  • in-sync: The parameter value is in sync with the database.

  • pending-reboot: The parameter value will be applied after the cluster reboots.

  • applying: The parameter value is being applied to the database.

  • invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.

  • apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.

  • apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.

  • unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.

Returns:

  • (String)


647
648
649
650
651
652
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 647

class ClusterParameterStatus < Struct.new(
  :parameter_name,
  :parameter_apply_status,
  :parameter_apply_error_description)
  include Aws::Structure
end

#parameter_nameString

The name of the parameter.

Returns:

  • (String)


647
648
649
650
651
652
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 647

class ClusterParameterStatus < Struct.new(
  :parameter_name,
  :parameter_apply_status,
  :parameter_apply_error_description)
  include Aws::Structure
end