interface AppSyncOpenSearchDataSourceProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.AppSync.AppSyncOpenSearchDataSourceProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#AppSyncOpenSearchDataSourceProps |
 Java | software.amazon.awscdk.services.appsync.AppSyncOpenSearchDataSourceProps |
 Python | aws_cdk.aws_appsync.AppSyncOpenSearchDataSourceProps |
 TypeScript (source) | aws-cdk-lib » aws_appsync » AppSyncOpenSearchDataSourceProps |
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 api: appsync.IApi;
declare const domain: opensearchservice.Domain;
declare const role: iam.Role;
const appSyncOpenSearchDataSourceProps: appsync.AppSyncOpenSearchDataSourceProps = {
api: api,
domain: domain,
// the properties below are optional
description: 'description',
name: 'name',
serviceRole: role,
};
Properties
| Name | Type | Description |
|---|---|---|
| api | IApi | 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. |
| service | IRole | The IAM service role to be assumed by AppSync to interact with the data source. |
api
Type:
IApi
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.
The only allowed pattern is: {[_A-Za-z][_0-9A-Za-z]*}. Any invalid characters will be automatically removed.
serviceRole?
Type:
IRole
(optional, default: Create a new role)
The IAM service role to be assumed by AppSync to interact with the data source.