AppSyncOpenSearchDataSourceProps Struct
Properties for the OpenSearch Data Source.
Example
ts
// 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';
import { aws_appsync as interfaces_appsync } from 'aws-cdk-lib/interfaces';
declare const apiRef: interfaces_appsync.IApiRef;
declare const domain: opensearchservice.Domain;
declare const role: iam.Role;
const appSyncOpenSearchDataSourceProps: appsync.AppSyncOpenSearchDataSourceProps = {
api: apiRef,
domain: domain,
// the properties below are optional
description: 'description',
name: 'name',
serviceRole: role,
};
Properties
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string= None#The description of the data source.
The OpenSearch domain containing the endpoint for the data source.
The name of the data source.
Default: id of data source
The only allowed pattern is: {[_A-Za-z][_0-9A-Za-z]*}. Any invalid characters will be automatically removed.