interface OpenSearchDataSourceProps

Language	Type name
.NET	Amazon.CDK.AWS.AppSync.OpenSearchDataSourceProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#OpenSearchDataSourceProps
Java	software.amazon.awscdk.services.appsync.OpenSearchDataSourceProps
Python	aws_cdk.aws_appsync.OpenSearchDataSourceProps
TypeScript (source)	aws-cdk-lib » aws_appsync » OpenSearchDataSourceProps

Properties for the OpenSearch Data Source.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_opensearchservice as opensearchservice } from 'aws-cdk-lib';

declare const domain: opensearchservice.Domain;
declare const graphqlApi: appsync.GraphqlApi;
declare const role: iam.Role;
const openSearchDataSourceProps: appsync.OpenSearchDataSourceProps = {
  api: graphqlApi,
  domain: domain,

  // the properties below are optional
  description: 'description',
  name: 'name',
  serviceRole: role,
};

Properties

Name	Type	Description
api	IGraphqlApi	The API to attach this data source to.
domain	IDomain	The OpenSearch domain containing the endpoint for the data source.
description?	string	the description of the data source.
name?	string	The name of the data source.
serviceRole?	IRole	The IAM service role to be assumed by AppSync to interact with the data source.

---

api

Type: IGraphqlApi

The API to attach this data source to.

---

domain

Type: IDomain

The OpenSearch domain containing the endpoint for the data source.

---

description?

Type: string (optional, default: None)

the description of the data source.

---

name?

Type: string (optional, default: id of data source)

The name of the data source.

---

serviceRole?

Type: IRole (optional, default: Create a new role)

The IAM service role to be assumed by AppSync to interact with the data source.