software.amazon.awscdk.services.elasticsearch

Interface CfnDomain.SnapshotOptionsProperty

All Known Implementing Classes:

CfnDomain.SnapshotOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDomain

public static interface CfnDomain.SnapshotOptionsProperty

> The `AWS::Elasticsearch::Domain` resource is being replaced by the [AWS::OpenSearchService::Domain](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchservice-domain.html) resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see [New resource types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/rename.html#rename-resource) in the *Amazon OpenSearch Service Developer Guide* .

DEPRECATED . For domains running Elasticsearch 5.3 and later, OpenSearch Service takes hourly automated snapshots, making this setting irrelevant. For domains running earlier versions of Elasticsearch, OpenSearch Service takes daily automated snapshots.

The automated snapshot configuration for the OpenSearch Service domain indices.

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getAutomatedSnapshotStartHour

default java.lang.Number getAutomatedSnapshotStartHour()

The hour in UTC during which the service takes an automated daily snapshot of the indices 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

static CfnDomain.SnapshotOptionsProperty.Builder builder()

Returns:

a CfnDomain.SnapshotOptionsProperty.Builder of CfnDomain.SnapshotOptionsProperty