Skip to content

/AWS1/CL_OSRSVCSOFTWAREOPTIONS

The current status of the service software for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_currentversion TYPE /AWS1/OSRSTRING /AWS1/OSRSTRING

The current service software version present on the domain.

iv_newversion TYPE /AWS1/OSRSTRING /AWS1/OSRSTRING

The new service software version, if one is available.

iv_updateavailable TYPE /AWS1/OSRBOOLEAN /AWS1/OSRBOOLEAN

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

iv_cancellable TYPE /AWS1/OSRBOOLEAN /AWS1/OSRBOOLEAN

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

iv_updatestatus TYPE /AWS1/OSRDEPLOYMENTSTATUS /AWS1/OSRDEPLOYMENTSTATUS

The status of your service software update.

iv_description TYPE /AWS1/OSRSTRING /AWS1/OSRSTRING

A description of the service software update status.

iv_automatedupdatedate TYPE /AWS1/OSRDEPLOYMENTCLOSEDATETS /AWS1/OSRDEPLOYMENTCLOSEDATETS

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

iv_optionaldeployment TYPE /AWS1/OSRBOOLEAN /AWS1/OSRBOOLEAN

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


Queryable Attributes

CurrentVersion

The current service software version present on the domain.

Accessible with the following methods

Method Description
GET_CURRENTVERSION() Getter for CURRENTVERSION, with configurable default
ASK_CURRENTVERSION() Getter for CURRENTVERSION w/ exceptions if field has no valu
HAS_CURRENTVERSION() Determine if CURRENTVERSION has a value

NewVersion

The new service software version, if one is available.

Accessible with the following methods

Method Description
GET_NEWVERSION() Getter for NEWVERSION, with configurable default
ASK_NEWVERSION() Getter for NEWVERSION w/ exceptions if field has no value
HAS_NEWVERSION() Determine if NEWVERSION has a value

UpdateAvailable

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

Accessible with the following methods

Method Description
GET_UPDATEAVAILABLE() Getter for UPDATEAVAILABLE, with configurable default
ASK_UPDATEAVAILABLE() Getter for UPDATEAVAILABLE w/ exceptions if field has no val
HAS_UPDATEAVAILABLE() Determine if UPDATEAVAILABLE has a value

Cancellable

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

Accessible with the following methods

Method Description
GET_CANCELLABLE() Getter for CANCELLABLE, with configurable default
ASK_CANCELLABLE() Getter for CANCELLABLE w/ exceptions if field has no value
HAS_CANCELLABLE() Determine if CANCELLABLE has a value

UpdateStatus

The status of your service software update.

Accessible with the following methods

Method Description
GET_UPDATESTATUS() Getter for UPDATESTATUS, with configurable default
ASK_UPDATESTATUS() Getter for UPDATESTATUS w/ exceptions if field has no value
HAS_UPDATESTATUS() Determine if UPDATESTATUS has a value

Description

A description of the service software update status.

Accessible with the following methods

Method Description
GET_DESCRIPTION() Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION() Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION() Determine if DESCRIPTION has a value

AutomatedUpdateDate

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

Accessible with the following methods

Method Description
GET_AUTOMATEDUPDATEDATE() Getter for AUTOMATEDUPDATEDATE, with configurable default
ASK_AUTOMATEDUPDATEDATE() Getter for AUTOMATEDUPDATEDATE w/ exceptions if field has no
HAS_AUTOMATEDUPDATEDATE() Determine if AUTOMATEDUPDATEDATE has a value

OptionalDeployment

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

Accessible with the following methods

Method Description
GET_OPTIONALDEPLOYMENT() Getter for OPTIONALDEPLOYMENT, with configurable default
ASK_OPTIONALDEPLOYMENT() Getter for OPTIONALDEPLOYMENT w/ exceptions if field has no
HAS_OPTIONALDEPLOYMENT() Determine if OPTIONALDEPLOYMENT has a value