AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

AppSyncOpenSearchDataSource

An Appsync datasource backed by OpenSearch.

Import

import { AppSyncOpenSearchDataSource } from 'aws-cdk-lib/aws-appsync';

Or use the module namespace:

import * as appsync from 'aws-cdk-lib/aws-appsync';
// appsync.AppSyncOpenSearchDataSource

Properties

Configuration passed to the constructor as AppSyncOpenSearchDataSourceProps.

domainRequired
IDomain

The OpenSearch domain containing the endpoint for the data source.

1 property inherited from AppSyncBackedDataSourceProps
serviceRoleOptionalinherited from AppSyncBackedDataSourceProps
IRole

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

Default: - Create a new role

3 properties inherited from AppSyncBaseDataSourceProps
apiRequiredinherited from AppSyncBaseDataSourceProps
IApiRef

The API to attach this data source to.

descriptionOptionalinherited from AppSyncBaseDataSourceProps
string

The description of the data source.

Default: - None

nameOptionalinherited from AppSyncBaseDataSourceProps
string

The name of the data source. The only allowed pattern is: {[_A-Za-z][_0-9A-Za-z]*}. Any invalid characters will be automatically removed.

Default: - id of data source

Get the AWS AppSync Cheat Sheet

Everything you need to know about AWS AppSync on one page. HD quality, print-friendly.

Download Free Infographic