Class: AWSCDK::OpenSearchService::CfnDomain::SnapshotOptionsProperty

Inherits:

Jsii::Struct

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

Defined in:

open_search_service/cfn_domain.rb

Overview

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-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 indexes 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 indexes in the OpenSearch Service domain.

# File 'open_search_service/cfn_domain.rb', line 2504

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 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.

Returns:

• (Numeric, nil)

See Also:

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

# File 'open_search_service/cfn_domain.rb', line 2515

def automated_snapshot_start_hour
  @automated_snapshot_start_hour
end

Class Method Details

.jsii_properties ⇒ Object

# File 'open_search_service/cfn_domain.rb', line 2517

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

Instance Method Details

#to_jsii ⇒ Object

# File 'open_search_service/cfn_domain.rb', line 2523

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