Class: Aws::OpenSearchService::Types::ServiceSoftwareOptions

Inherits:

Struct

• Object
• Struct
• Aws::OpenSearchService::Types::ServiceSoftwareOptions

Defined in:

gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb

Overview

The current options of an domain service software options.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #automated_update_date ⇒ Time

  The timestamp, in Epoch time, until which you can manually request a service software update.

• #cancellable ⇒ Boolean

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

• #current_version ⇒ String

  The current service software version present on the domain.

• #description ⇒ String

  The description of the UpdateStatus.

• #new_version ⇒ String

  The new service software version if one is available.

• #optional_deployment ⇒ Boolean

  True if a service software is never automatically updated.

• #update_available ⇒ Boolean

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

• #update_status ⇒ String

  The status of your service software update.

Instance Attribute Details

#automated_update_date ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4454

class ServiceSoftwareOptions < Struct.new(
  :current_version,
  :new_version,
  :update_available,
  :cancellable,
  :update_status,
  :description,
  :automated_update_date,
  :optional_deployment)
  SENSITIVE = []
  include Aws::Structure
end

#cancellable ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4454

class ServiceSoftwareOptions < Struct.new(
  :current_version,
  :new_version,
  :update_available,
  :cancellable,
  :update_status,
  :description,
  :automated_update_date,
  :optional_deployment)
  SENSITIVE = []
  include Aws::Structure
end

#current_version ⇒ String

The current service software version present on the domain.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4454

class ServiceSoftwareOptions < Struct.new(
  :current_version,
  :new_version,
  :update_available,
  :cancellable,
  :update_status,
  :description,
  :automated_update_date,
  :optional_deployment)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the UpdateStatus.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4454

class ServiceSoftwareOptions < Struct.new(
  :current_version,
  :new_version,
  :update_available,
  :cancellable,
  :update_status,
  :description,
  :automated_update_date,
  :optional_deployment)
  SENSITIVE = []
  include Aws::Structure
end

#new_version ⇒ String

The new service software version if one is available.

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4454

class ServiceSoftwareOptions < Struct.new(
  :current_version,
  :new_version,
  :update_available,
  :cancellable,
  :update_status,
  :description,
  :automated_update_date,
  :optional_deployment)
  SENSITIVE = []
  include Aws::Structure
end

#optional_deployment ⇒ Boolean

True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.

Returns:

• (Boolean)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4454

class ServiceSoftwareOptions < Struct.new(
  :current_version,
  :new_version,
  :update_available,
  :cancellable,
  :update_status,
  :description,
  :automated_update_date,
  :optional_deployment)
  SENSITIVE = []
  include Aws::Structure
end

#update_available ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4454

class ServiceSoftwareOptions < Struct.new(
  :current_version,
  :new_version,
  :update_available,
  :cancellable,
  :update_status,
  :description,
  :automated_update_date,
  :optional_deployment)
  SENSITIVE = []
  include Aws::Structure
end

#update_status ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4454

class ServiceSoftwareOptions < Struct.new(
  :current_version,
  :new_version,
  :update_available,
  :cancellable,
  :update_status,
  :description,
  :automated_update_date,
  :optional_deployment)
  SENSITIVE = []
  include Aws::Structure
end