Package software.amazon.awscdk.services.opensearchservice

Interface CfnDomain.ServiceSoftwareOptionsProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDomain.ServiceSoftwareOptionsProperty.Jsii$Proxy
Enclosing class:
CfnDomain
@Stability(Stable) public static interface CfnDomain.ServiceSoftwareOptionsProperty extends software.amazon.jsii.JsiiSerializable
The current status of the service software for an Amazon OpenSearch Service domain.

For more information, see Service software updates in Amazon OpenSearch Service .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opensearchservice.*;
 ServiceSoftwareOptionsProperty serviceSoftwareOptionsProperty = ServiceSoftwareOptionsProperty.builder()
         .automatedUpdateDate("automatedUpdateDate")
         .cancellable(false)
         .currentVersion("currentVersion")
         .description("description")
         .newVersion("newVersion")
         .optionalDeployment(false)
         .updateAvailable(false)
         .updateStatus("updateStatus")
         .build();

  • Method Details

    • getAutomatedUpdateDate

      @Stability(Stable) @Nullable default String getAutomatedUpdateDate()
      The timestamp, in Epoch time, until which you can manually request a service software update.

      After this date, we automatically update your service software.

    • getCancellable

      @Stability(Stable) @Nullable default Object getCancellable()
      True if you're able to cancel your service software version update.

      False if you can't cancel your service software update.

    • getCurrentVersion

      @Stability(Stable) @Nullable default String getCurrentVersion()
      The current service software version present on the domain.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      A description of the service software update status.

    • getNewVersion

      @Stability(Stable) @Nullable default String getNewVersion()
      The new service software version, if one is available.

    • getOptionalDeployment

      @Stability(Stable) @Nullable default Object getOptionalDeployment()
      True if a service software is never automatically updated.

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

    • getUpdateAvailable

      @Stability(Stable) @Nullable default Object getUpdateAvailable()
      True if you're able to update your service software version.

      False if you can't update your service software version.

    • getUpdateStatus

      @Stability(Stable) @Nullable default String getUpdateStatus()
      The status of your service software update.

    • builder

      @Stability(Stable) static CfnDomain.ServiceSoftwareOptionsProperty.Builder builder()
      Returns:
      a CfnDomain.ServiceSoftwareOptionsProperty.Builder of CfnDomain.ServiceSoftwareOptionsProperty