# AWS::OpenSearch Construct Library

---

![cfn-resources: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)

> All classes with the `Cfn` prefix in this module ([CFN Resources]) are always stable and safe to use.
>
> [CFN Resources]: https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib

---

This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.

```ts
import * as opensearch from 'aws-cdk-lib/aws-opensearch';
```

There are no official hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet. Here are some suggestions on how to proceed:

- Search [Construct Hub for OpenSearch construct libraries](https://constructs.dev/search?q=opensearch)
- Use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, in the same way you would use [the CloudFormation AWS::OpenSearch resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_OpenSearch.html) directly.

There are no hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet.
However, you can still use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the [CloudFormation documentation for AWS::OpenSearch](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_OpenSearch.html).

(Read the [CDK Contributing Guide](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and submit an RFC if you are interested in contributing to this construct library.)

## Types

| Name | Kind | Summary |
| --- | --- | --- |
| [`CfnDataSource`](/v2/docs/aws-cdk-lib.aws_opensearch.CfnDataSource) | Construct (L1) | Creates a data source for an Amazon OpenSearch Service domain. |
| [`CfnDataSource.DataSourceTypeProperty`](/v2/docs/aws-cdk-lib.aws_opensearch.CfnDataSource.DataSourceTypeProperty) | Struct | The type of data source. |
| [`CfnDataSource.S3GlueDataCatalogProperty`](/v2/docs/aws-cdk-lib.aws_opensearch.CfnDataSource.S3GlueDataCatalogProperty) | Struct | Configuration for an S3 Glue Data Catalog data source. |
| [`CfnDataSourceProps`](/v2/docs/aws-cdk-lib.aws_opensearch.CfnDataSourceProps) | Struct | Properties for defining a `CfnDataSource`. |