Skip to content

ServiceSoftwareOptions

Source code in docs_src/capo_elasticsearch_service/types/service_software_options.py
class ServiceSoftwareOptions(TypedDict, closed=True):
    current_version: NotRequired["capo_elasticsearch_service.types.string.String"]
    """<p>The current service software version that is present on the domain.</p>"""
    new_version: NotRequired["capo_elasticsearch_service.types.string.String"]
    """<p>The new service software version if one is available.</p>"""
    update_available: NotRequired["capo_elasticsearch_service.types.boolean.Boolean"]
    """<p><code>True</code> if you are able to update you service software version. <code>False</code> if you are not able to update your service software version. </p>"""
    cancellable: NotRequired["capo_elasticsearch_service.types.boolean.Boolean"]
    """<p><code>True</code> if you are able to cancel your service software version update. <code>False</code> if you are not able to cancel your service software version. </p>"""
    update_status: NotRequired[
        "capo_elasticsearch_service.types.deployment_status.DeploymentStatus"
    ]
    """<p>The status of your service software update. This field can take the following values: <code>ELIGIBLE</code>, <code>PENDING_UPDATE</code>, <code>IN_PROGRESS</code>, <code>COMPLETED</code>, and <code>NOT_ELIGIBLE</code>.</p>"""
    description: NotRequired["capo_elasticsearch_service.types.string.String"]
    """<p>The description of the <code>UpdateStatus</code>.</p>"""
    automated_update_date: NotRequired[
        "capo_elasticsearch_service.types.deployment_close_date_time_stamp.DeploymentCloseDateTimeStamp"
    ]
    """<p>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_elasticsearch_service.types.boolean.Boolean"]
    """<p><code>True</code> if a service software is never automatically updated. <code>False</code> if a service software is automatically updated after <code>AutomatedUpdateDate</code>. </p>"""

automated_update_date instance-attribute

automated_update_date: NotRequired[DeploymentCloseDateTimeStamp]

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 are able to cancel your service software version update. False if you are not able to cancel your service software version.

current_version instance-attribute

current_version: NotRequired[String]

The current service software version that is present on the domain.

description instance-attribute

description: NotRequired[String]

The description of the UpdateStatus.

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 AutomatedUpdateDate.

update_available instance-attribute

update_available: NotRequired[Boolean]

True if you are able to update you service software version. False if you are not able to update your service software version.

update_status instance-attribute

update_status: NotRequired[DeploymentStatus]

The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.