

This is the new *Amazon CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [Amazon CloudFormation User Guide](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::OpenSearchService::Domain ColdStorageOptions
<a name="aws-properties-opensearchservice-domain-coldstorageoptions"></a>

Container for the parameters required to enable cold storage for an OpenSearch Service domain. For more information, see [Cold storage for Amazon OpenSearch Service](https://docs.amazonaws.cn/opensearch-service/latest/developerguide/cold-storage.html).

## Syntax
<a name="aws-properties-opensearchservice-domain-coldstorageoptions-syntax"></a>

To declare this entity in your Amazon CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-opensearchservice-domain-coldstorageoptions-syntax.json"></a>

```
{
  "[Enabled](#cfn-opensearchservice-domain-coldstorageoptions-enabled)" : {{Boolean}}
}
```

### YAML
<a name="aws-properties-opensearchservice-domain-coldstorageoptions-syntax.yaml"></a>

```
  [Enabled](#cfn-opensearchservice-domain-coldstorageoptions-enabled): {{Boolean}}
```

## Properties
<a name="aws-properties-opensearchservice-domain-coldstorageoptions-properties"></a>

`Enabled`  <a name="cfn-opensearchservice-domain-coldstorageoptions-enabled"></a>
Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)