Skip to content

ModifyingProperties

Source code in docs_src/capo_opensearch/types/modifying_properties.py 
12
13
14
15
16
17
18
19
20
21
22
class ModifyingProperties(TypedDict, closed=True):
    name: NotRequired["capo_opensearch.types.string.String"]
    """<p>The name of the property that is currently being modified.</p>"""
    active_value: NotRequired["capo_opensearch.types.string.String"]
    """<p>The current value of the domain property that is being modified.</p>"""
    pending_value: NotRequired["capo_opensearch.types.string.String"]
    """<p>The value that the property that is currently being modified will eventually have.</p>"""
    value_type: NotRequired[
        "capo_opensearch.types.property_value_type.PropertyValueType"
    ]
    """<p>The type of value that is currently being modified. Properties can have two types:</p> <ul> <li> <p> <code>PLAIN_TEXT</code>: Contain direct values such as "1", "True", or "c5.large.search".</p> </li> <li> <p> <code>STRINGIFIED_JSON</code>: Contain content in JSON format, such as {"Enabled":"True"}".</p> </li> </ul>"""

active_value instance-attribute 

active_value: NotRequired[String]

The current value of the domain property that is being modified.

name instance-attribute 

name: NotRequired[String]

The name of the property that is currently being modified.

pending_value instance-attribute 

pending_value: NotRequired[String]

The value that the property that is currently being modified will eventually have.

value_type instance-attribute 

value_type: NotRequired[PropertyValueType]

The type of value that is currently being modified. Properties can have two types:

  • PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search".

  • STRINGIFIED_JSON: Contain content in JSON format, such as {"Enabled":"True"}".