Class: AWSCDK::OpenSearchService::CfnDomain::ColdStorageOptionsProperty

Inherits:

Jsii::Struct

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

Defined in:

open_search_service/cfn_domain.rb

Overview

Container for the parameters required to enable cold storage for an OpenSearch Service domain.

For more information, see Cold storage for Amazon OpenSearch Service .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-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 'open_search_service/cfn_domain.rb', line 1396

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 to enable cold storage.

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

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

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

def enabled
  @enabled
end

Class Method Details

.jsii_properties ⇒ Object

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

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

Instance Method Details

#to_jsii ⇒ Object

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

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