aws-cdk-lib.aws_appsync.OpenSearchDataSourceProps

interface OpenSearchDataSourceProps

LanguageType name
.NETAmazon.CDK.AWS.AppSync.OpenSearchDataSourceProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#OpenSearchDataSourceProps
Javasoftware.amazon.awscdk.services.appsync.OpenSearchDataSourceProps
Pythonaws_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

NameTypeDescription
apiIGraphqlApiThe API to attach this data source to.
domainIDomainThe OpenSearch domain containing the endpoint for the data source.
description?stringthe description of the data source.
name?stringThe name of the data source.
serviceRole?IRoleThe 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.