Class: Aws::OpenSearchService::Types::RetentionOptions

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb

Overview

Note:

RetentionOptions is a union - when making an API calls you must set exactly one of the members.

Note:

RetentionOptions is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RetentionOptions corresponding to the set member.

Controls how long the cluster that you cut over from is kept after cutover completes. Specify exactly one of RetentionInHours or RetentionAction.

See Also:

Defined Under Namespace

Classes: RetentionAction, RetentionInHours, Unknown

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#retention_action ⇒ String

Ends the retention period now. Valid only after cutover completes.

Returns:

  • (String) 


8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 8917

class RetentionOptions < Struct.new(
  :retention_in_hours,
  :retention_action,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class RetentionInHours < RetentionOptions; end
  class RetentionAction < RetentionOptions; end
  class Unknown < RetentionOptions; end
end

#retention_in_hours ⇒ Integer

The number of hours to keep the cluster that you cut over from. The retention period starts when cutover completes. The minimum is 1 hour. In an UpdateClone response after cutover completes, this value is the number of hours remaining in the retention period, rounded up.

Returns:

  • (Integer) 


8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 8917

class RetentionOptions < Struct.new(
  :retention_in_hours,
  :retention_action,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class RetentionInHours < RetentionOptions; end
  class RetentionAction < RetentionOptions; end
  class Unknown < RetentionOptions; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



8917
8918
8919
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 8917

def unknown
  @unknown
end