interface ColdStorageOptionsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Elasticsearch.CfnDomain.ColdStorageOptionsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awselasticsearch#CfnDomain_ColdStorageOptionsProperty`
Java	`software.amazon.awscdk.services.elasticsearch.CfnDomain.ColdStorageOptionsProperty`
Python	`aws_cdk.aws_elasticsearch.CfnDomain.ColdStorageOptionsProperty`
TypeScript	`aws-cdk-lib` » `aws_elasticsearch` » `CfnDomain` » `ColdStorageOptionsProperty`

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 .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticsearch as elasticsearch } from 'aws-cdk-lib';
const coldStorageOptionsProperty: elasticsearch.CfnDomain.ColdStorageOptionsProperty = {
  enabled: false,
};

Properties

Name	Type	Description
enabled?	`boolean \|` `IResolvable`	Whether to enable or disable cold storage on the domain.

enabled?

Type: boolean | IResolvable (optional)

Whether to enable or disable cold storage on the domain.

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