Class: AWSCDK::Elasticsearch::CfnDomain::SnapshotOptionsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Elasticsearch::CfnDomain::SnapshotOptionsProperty

Defined in:

elasticsearch/cfn_domain.rb

Overview

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 .

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 Also:

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

Instance Attribute Summary

• #automated_snapshot_start_hour ⇒ Numeric^? readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(automated_snapshot_start_hour: nil) ⇒ SnapshotOptionsProperty constructor

  A new instance of SnapshotOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(automated_snapshot_start_hour: nil) ⇒ SnapshotOptionsProperty

Returns a new instance of SnapshotOptionsProperty.

Parameters:

• automated_snapshot_start_hour (Numeric, nil) (defaults to: nil) —

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

# File 'elasticsearch/cfn_domain.rb', line 1442

def initialize(automated_snapshot_start_hour: nil)
  @automated_snapshot_start_hour = automated_snapshot_start_hour
  Jsii::Type.check_type(@automated_snapshot_start_hour, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "automatedSnapshotStartHour") unless @automated_snapshot_start_hour.nil?
end

Instance Attribute Details

#automated_snapshot_start_hour ⇒ Numeric^? (readonly)

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.

Returns:

• (Numeric, nil)

See Also:

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

# File 'elasticsearch/cfn_domain.rb', line 1453

def automated_snapshot_start_hour
  @automated_snapshot_start_hour
end

Class Method Details

.jsii_properties ⇒ Object

# File 'elasticsearch/cfn_domain.rb', line 1455

def self.jsii_properties
  {
    :automated_snapshot_start_hour => "automatedSnapshotStartHour",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'elasticsearch/cfn_domain.rb', line 1461

def to_jsii
  result = {}
  result.merge!({
    "automatedSnapshotStartHour" => @automated_snapshot_start_hour,
  })
  result.compact
end