View a markdown version of this page

RetentionOptions - Amazon OpenSearch Service

RetentionOptions

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

Contents

Important

This data type is a UNION, so only one of the following members can be specified when used or returned.

RetentionAction

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

Type: String

Valid Values: RollbackToPrimaryCluster | DeletePrimaryCluster

Required: No

RetentionInHours

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.

Type: Integer

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: