Skip to content

ServiceSoftwareOptions

Source code in docs_src/capo_opensearch/types/service_software_options.py
class ServiceSoftwareOptions(TypedDict, closed=True):
    current_version: NotRequired["capo_opensearch.types.string.String"]
    """<p>The current service software version present on the domain.</p>"""
    new_version: NotRequired["capo_opensearch.types.string.String"]
    """<p>The new service software version, if one is available.</p>"""
    update_available: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>True if you're able to update your service software version. False if you can't update your service software version.</p>"""
    cancellable: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p> True if you're able to cancel your service software version update. False if you can't cancel your service software update.</p>"""
    update_status: NotRequired[
        "capo_opensearch.types.deployment_status.DeploymentStatus"
    ]
    """<p>The status of your service software update.</p>"""
    description: NotRequired["capo_opensearch.types.string.String"]
    """<p>A description of the service software update status.</p>"""
    automated_update_date: NotRequired[
        "capo_opensearch.types.deployment_close_date_time_stamp.DeploymentCloseDateTimeStamp"
    ]
    """<p>The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.</p>"""
    optional_deployment: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.</p>"""

automated_update_date instance-attribute

automated_update_date: NotRequired[DeploymentCloseDateTimeStamp]

The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

cancellable instance-attribute

cancellable: NotRequired[Boolean]

True if you're able to cancel your service software version update. False if you can't cancel your service software update.

current_version instance-attribute

current_version: NotRequired[String]

The current service software version present on the domain.

description instance-attribute

description: NotRequired[String]

A description of the service software update status.

new_version instance-attribute

new_version: NotRequired[String]

The new service software version, if one is available.

optional_deployment instance-attribute

optional_deployment: NotRequired[Boolean]

True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

update_available instance-attribute

update_available: NotRequired[Boolean]

True if you're able to update your service software version. False if you can't update your service software version.

update_status instance-attribute

update_status: NotRequired[DeploymentStatus]

The status of your service software update.