aws-cdk-lib.aws_appsync.ElasticsearchDataSourceProps

interface ElasticsearchDataSourceProps ⚠️

LanguageType name
.NETAmazon.CDK.AWS.AppSync.ElasticsearchDataSourceProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#ElasticsearchDataSourceProps
Javasoftware.amazon.awscdk.services.appsync.ElasticsearchDataSourceProps
Pythonaws_cdk.aws_appsync.ElasticsearchDataSourceProps
TypeScript (source)aws-cdk-lib » aws_appsync » ElasticsearchDataSourceProps

⚠️ Deprecated: - use OpenSearchDataSourceProps with OpenSearchDataSource

Properties for the Elasticsearch 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_elasticsearch as elasticsearch } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';

declare const domain: elasticsearch.Domain;
declare const graphqlApi: appsync.GraphqlApi;
declare const role: iam.Role;
const elasticsearchDataSourceProps: appsync.ElasticsearchDataSourceProps = {
  api: graphqlApi,
  domain: domain,

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

Properties

NameTypeDescription
api⚠️IGraphqlApiThe API to attach this data source to.
domain⚠️IDomainThe elasticsearch 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⚠️

⚠️ Deprecated: - use OpenSearchDataSourceProps with OpenSearchDataSource

Type: IGraphqlApi

The API to attach this data source to.


domain⚠️

⚠️ Deprecated: - use OpenSearchDataSourceProps with OpenSearchDataSource

Type: IDomain

The elasticsearch domain containing the endpoint for the data source.


description?⚠️

⚠️ Deprecated: - use OpenSearchDataSourceProps with OpenSearchDataSource

Type: string (optional, default: None)

the description of the data source.


name?⚠️

⚠️ Deprecated: - use OpenSearchDataSourceProps with OpenSearchDataSource

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

The name of the data source.


serviceRole?⚠️

⚠️ Deprecated: - use OpenSearchDataSourceProps with OpenSearchDataSource

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

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