Show / Hide Table of Contents

Class CfnDomain.SnapshotOptionsProperty

The AWS::Elasticsearch::Domain resource is being replaced by the AWS::OpenSearchService::Domain 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 in the Amazon OpenSearch Service Developer Guide .

Inheritance
object
CfnDomain.SnapshotOptionsProperty
Implements
CfnDomain.ISnapshotOptionsProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.Elasticsearch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDomain.SnapshotOptionsProperty : CfnDomain.ISnapshotOptionsProperty
Syntax (vb)
Public Class CfnDomain.SnapshotOptionsProperty Implements CfnDomain.ISnapshotOptionsProperty
Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-snapshotoptions.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Elasticsearch;

             var snapshotOptionsProperty = new SnapshotOptionsProperty {
                 AutomatedSnapshotStartHour = 123
             };

Synopsis

Constructors

SnapshotOptionsProperty()

The AWS::Elasticsearch::Domain resource is being replaced by the AWS::OpenSearchService::Domain 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 in the Amazon OpenSearch Service Developer Guide .

Properties

AutomatedSnapshotStartHour

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

Constructors

SnapshotOptionsProperty()

The AWS::Elasticsearch::Domain resource is being replaced by the AWS::OpenSearchService::Domain 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 in the Amazon OpenSearch Service Developer Guide .

public SnapshotOptionsProperty()
Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-snapshotoptions.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Elasticsearch;

             var snapshotOptionsProperty = new SnapshotOptionsProperty {
                 AutomatedSnapshotStartHour = 123
             };

Properties

AutomatedSnapshotStartHour

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

public double? AutomatedSnapshotStartHour { get; set; }
Property Value

double?

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticsearch-domain-snapshotoptions.html#cfn-elasticsearch-domain-snapshotoptions-automatedsnapshotstarthour

Implements

CfnDomain.ISnapshotOptionsProperty
Back to top Generated by DocFX