Skip to content

Parameter

Source code in docs_src/capo_redshift/types/parameter.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class Parameter(TypedDict, closed=True):
    parameter_name: NotRequired["capo_redshift.types.string.String"]
    """<p>The name of the parameter.</p>"""
    parameter_value: NotRequired["capo_redshift.types.string.String"]
    """<p>The value of the parameter. If <code>ParameterName</code> is <code>wlm_json_configuration</code>, then the maximum size of <code>ParameterValue</code> is 8000 characters.</p>"""
    description: NotRequired["capo_redshift.types.string.String"]
    """<p>A description of the parameter.</p>"""
    source: NotRequired["capo_redshift.types.string.String"]
    """<p>The source of the parameter value, such as "engine-default" or "user".</p>"""
    data_type: NotRequired["capo_redshift.types.string.String"]
    """<p>The data type of the parameter.</p>"""
    allowed_values: NotRequired["capo_redshift.types.string.String"]
    """<p>The valid range of values for the parameter.</p>"""
    apply_type: NotRequired[
        "capo_redshift.types.parameter_apply_type.ParameterApplyType"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>"""
    is_modifiable: NotRequired["capo_redshift.types.boolean.Boolean"]
    """<p>If <code>true</code>, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. </p>"""
    minimum_engine_version: NotRequired["capo_redshift.types.string.String"]
    """<p>The earliest engine version to which the parameter can apply.</p>"""

allowed_values instance-attribute 

allowed_values: NotRequired[String]

The valid range of values for the parameter.

apply_type instance-attribute 

apply_type: NotRequired[ParameterApplyType]

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.

data_type instance-attribute 

data_type: NotRequired[String]

The data type of the parameter.

description instance-attribute 

description: NotRequired[String]

A description of the parameter.

is_modifiable instance-attribute 

is_modifiable: NotRequired[Boolean]

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

minimum_engine_version instance-attribute 

minimum_engine_version: NotRequired[String]

The earliest engine version to which the parameter can apply.

parameter_name instance-attribute 

parameter_name: NotRequired[String]

The name of the parameter.

parameter_value instance-attribute 

parameter_value: NotRequired[String]

The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

source instance-attribute 

source: NotRequired[String]

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