AWS::OpenSearchService::Domain ServiceSoftwareOptions

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "AutomatedUpdateDate" : String,
  "Cancellable" : Boolean,
  "CurrentVersion" : String,
  "Description" : String,
  "NewVersion" : String,
  "OptionalDeployment" : Boolean,
  "UpdateAvailable" : Boolean,
  "UpdateStatus" : String
}

YAML

  AutomatedUpdateDate: String
  Cancellable: Boolean
  CurrentVersion: String
  Description: String
  NewVersion: String
  OptionalDeployment: Boolean
  UpdateAvailable: Boolean
  UpdateStatus: String

Properties

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.

Required: No

Type: String

Update requires: No interruption

Cancellable

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

Required: No

Type: Boolean

Update requires: No interruption

CurrentVersion

The current service software version present on the domain.

Required: No

Type: String

Update requires: No interruption

Description

A description of the service software update status.

Required: No

Type: String

Update requires: No interruption

NewVersion

The new service software version, if one is available.

Required: No

Type: String

Update requires: No interruption

OptionalDeployment

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

Required: No

Type: Boolean

Update requires: No interruption

UpdateAvailable

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

Required: No

Type: Boolean

Update requires: No interruption

UpdateStatus

The status of your service software update.

Required: No

Type: String

Allowed values: PENDING_UPDATE | IN_PROGRESS | COMPLETED | NOT_ELIGIBLE | ELIGIBLE

Update requires: No interruption