Class: AWSCDK::Elasticsearch::CfnDomain::ColdStorageOptionsProperty

Inherits:

Jsii::Struct

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

Defined in:

elasticsearch/cfn_domain.rb

Overview

Specifies options for cold storage. For more information, see Cold storage for Amazon Elasticsearch Service .

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 .

See Also:

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

Instance Attribute Summary

• #enabled ⇒ Boolean, ... readonly

  Whether to enable or disable cold storage on the domain.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(enabled: nil) ⇒ ColdStorageOptionsProperty constructor

  A new instance of ColdStorageOptionsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(enabled: nil) ⇒ ColdStorageOptionsProperty

Returns a new instance of ColdStorageOptionsProperty.

Parameters:

• enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

  Whether to enable or disable cold storage on the domain.

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

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

Instance Attribute Details

#enabled ⇒ Boolean, ... (readonly)

Whether to enable or disable cold storage on the domain.

You must enable UltraWarm storage in order to enable cold storage.

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

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

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

def enabled
  @enabled
end

Class Method Details

.jsii_properties ⇒ Object

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

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

Instance Method Details

#to_jsii ⇒ Object

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

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