Package software.amazon.awscdk.services.opensearchservice

Interface CfnDomain.ColdStorageOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomain.ColdStorageOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDomain

@Stability(Stable)
public static interface CfnDomain.ColdStorageOptionsProperty
extends software.amazon.jsii.JsiiSerializable

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

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opensearchservice.*;
 ColdStorageOptionsProperty coldStorageOptionsProperty = ColdStorageOptionsProperty.builder()
         .enabled(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomain.ColdStorageOptionsProperty.Builder	A builder for CfnDomain.ColdStorageOptionsProperty
static final class	CfnDomain.ColdStorageOptionsProperty.Jsii$Proxy	An implementation for CfnDomain.ColdStorageOptionsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDomain.ColdStorageOptionsProperty.Builder	builder()
default Object	getEnabled()	Whether to enable or disable cold storage on the domain.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

Whether to enable or disable cold storage on the domain.

You must enable UltraWarm storage to enable cold storage.

Returns union: either Boolean or IResolvable

See Also:

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

builder

@Stability(Stable)
static CfnDomain.ColdStorageOptionsProperty.Builder builder()

Returns:

a CfnDomain.ColdStorageOptionsProperty.Builder of CfnDomain.ColdStorageOptionsProperty