Skip to content

ClusterParameterStatus

Source code in docs_src/capo_redshift/types/cluster_parameter_status.py 
13
14
15
16
17
18
19
class ClusterParameterStatus(TypedDict, closed=True):
    parameter_name: NotRequired["capo_redshift.types.string.String"]
    """<p>The name of the parameter.</p>"""
    parameter_apply_status: NotRequired["capo_redshift.types.string.String"]
    """<p>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.</p> <p>The following are possible statuses and descriptions.</p> <ul> <li> <p> <code>in-sync</code>: The parameter value is in sync with the database.</p> </li> <li> <p> <code>pending-reboot</code>: The parameter value will be applied after the cluster reboots.</p> </li> <li> <p> <code>applying</code>: The parameter value is being applied to the database.</p> </li> <li> <p> <code>invalid-parameter</code>: Cannot apply the parameter value because it has an invalid value or syntax.</p> </li> <li> <p> <code>apply-deferred</code>: The parameter contains static property changes. The changes are deferred until the cluster reboots.</p> </li> <li> <p> <code>apply-error</code>: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.</p> </li> <li> <p> <code>unknown-error</code>: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.</p> </li> </ul>"""
    parameter_apply_error_description: NotRequired["capo_redshift.types.string.String"]
    """<p>The error that prevented the parameter from being applied to the database.</p>"""

parameter_apply_error_description instance-attribute 

parameter_apply_error_description: NotRequired[String]

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

parameter_apply_status instance-attribute 

parameter_apply_status: NotRequired[String]

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.

parameter_name instance-attribute 

parameter_name: NotRequired[String]

The name of the parameter.