Skip to content

Parameter

Source code in docs_src/capo_docdb/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_docdb.types.string.String"]
    """<p>Specifies the name of the parameter.</p>"""
    parameter_value: NotRequired["capo_docdb.types.string.String"]
    """<p>Specifies the value of the parameter. Must be one or more of the cluster parameter's <code>AllowedValues</code> in CSV format:</p> <p>Valid values are:</p> <ul> <li> <p> <code>enabled</code>: The cluster accepts secure connections using TLS version 1.0 through 1.3. </p> </li> <li> <p> <code>disabled</code>: The cluster does not accept secure connections using TLS. </p> </li> <li> <p> <code>fips-140-3</code>: The cluster only accepts secure connections per the requirements of the Federal Information Processing Standards (FIPS) publication 140-3. Only supported starting with Amazon DocumentDB 5.0 (engine version 3.0.3727) clusters in these regions: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1.</p> </li> <li> <p> <code>tls1.2+</code>: The cluster accepts secure connections using TLS version 1.2 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).</p> </li> <li> <p> <code>tls1.3+</code>: The cluster accepts secure connections using TLS version 1.3 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).</p> </li> </ul>"""
    description: NotRequired["capo_docdb.types.string.String"]
    """<p>Provides a description of the parameter.</p>"""
    source: NotRequired["capo_docdb.types.string.String"]
    """<p>Indicates the source of the parameter value.</p>"""
    apply_type: NotRequired["capo_docdb.types.string.String"]
    """<p>Specifies the engine-specific parameters type.</p>"""
    data_type: NotRequired["capo_docdb.types.string.String"]
    """<p>Specifies the valid data type for the parameter.</p>"""
    allowed_values: NotRequired["capo_docdb.types.string.String"]
    """<p>Specifies the valid range of values for the parameter.</p>"""
    is_modifiable: NotRequired["capo_docdb.types.boolean.Boolean"]
    """<p> Indicates whether (<code>true</code>) or not (<code>false</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_docdb.types.string.String"]
    """<p>The earliest engine version to which the parameter can apply.</p>"""
    apply_method: NotRequired["capo_docdb.types.apply_method.ApplyMethod"]
    """<p>Indicates when to apply parameter updates.</p>"""

allowed_values instance-attribute 

allowed_values: NotRequired[String]

Specifies the valid range of values for the parameter.

apply_method instance-attribute 

apply_method: NotRequired[ApplyMethod]

Indicates when to apply parameter updates.

apply_type instance-attribute 

apply_type: NotRequired[String]

Specifies the engine-specific parameters type.

data_type instance-attribute 

data_type: NotRequired[String]

Specifies the valid data type for the parameter.

description instance-attribute 

description: NotRequired[String]

Provides a description of the parameter.

is_modifiable instance-attribute 

is_modifiable: NotRequired[Boolean]

Indicates whether (true) or not (false) 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]

Specifies the name of the parameter.

parameter_value instance-attribute 

parameter_value: NotRequired[String]

Specifies the value of the parameter. Must be one or more of the cluster parameter's AllowedValues in CSV format:

Valid values are:

  • enabled: The cluster accepts secure connections using TLS version 1.0 through 1.3.

  • disabled: The cluster does not accept secure connections using TLS.

  • fips-140-3: The cluster only accepts secure connections per the requirements of the Federal Information Processing Standards (FIPS) publication 140-3. Only supported starting with Amazon DocumentDB 5.0 (engine version 3.0.3727) clusters in these regions: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1.

  • tls1.2+: The cluster accepts secure connections using TLS version 1.2 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).

  • tls1.3+: The cluster accepts secure connections using TLS version 1.3 and above. Only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).

source instance-attribute 

source: NotRequired[String]

Indicates the source of the parameter value.