Package software.amazon.awscdk.services.opensearchservice

Interface CfnDomain.SnapshotOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomain.SnapshotOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDomain

@Stability(Stable)
public static interface CfnDomain.SnapshotOptionsProperty
extends software.amazon.jsii.JsiiSerializable

DEPRECATED .

This setting is only relevant to domains running legacy Elasticsearch OSS versions earlier than 5.3. It does not apply to OpenSearch domains.

The automated snapshot configuration for the OpenSearch Service domain indexes.

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.*;
 SnapshotOptionsProperty snapshotOptionsProperty = SnapshotOptionsProperty.builder()
         .automatedSnapshotStartHour(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomain.SnapshotOptionsProperty.Builder	A builder for CfnDomain.SnapshotOptionsProperty
static final class	CfnDomain.SnapshotOptionsProperty.Jsii$Proxy	An implementation for CfnDomain.SnapshotOptionsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDomain.SnapshotOptionsProperty.Builder	builder()
default Number	getAutomatedSnapshotStartHour()	The hour in UTC during which the service takes an automated daily snapshot of the indexes in the OpenSearch Service domain.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAutomatedSnapshotStartHour

@Stability(Stable)
@Nullable
default Number getAutomatedSnapshotStartHour()

The hour in UTC during which the service takes an automated daily snapshot of the indexes in the OpenSearch Service domain.

For example, if you specify 0, OpenSearch Service takes an automated snapshot everyday between midnight and 1 am. You can specify a value between 0 and 23.

builder

@Stability(Stable)
static CfnDomain.SnapshotOptionsProperty.Builder builder()

Returns:

a CfnDomain.SnapshotOptionsProperty.Builder of CfnDomain.SnapshotOptionsProperty