class ElasticsearchDataSource (construct) ⚠️

Language	Type name
.NET	Amazon.CDK.AWS.AppSync.ElasticsearchDataSource
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#ElasticsearchDataSource
Java	software.amazon.awscdk.services.appsync.ElasticsearchDataSource
Python	aws_cdk.aws_appsync.ElasticsearchDataSource
TypeScript (source)	aws-cdk-lib » aws_appsync » ElasticsearchDataSource

⚠️ Deprecated: - use OpenSearchDataSource

Implements IConstruct, IDependable, IGrantable

An Appsync datasource backed by Elasticsearch.

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';
import { aws_appsync as interfaces_appsync } from 'aws-cdk-lib/interfaces';

declare const domain: elasticsearch.Domain;
declare const graphQLApiRef: interfaces_appsync.IGraphQLApiRef;
declare const role: iam.Role;
const elasticsearchDataSource = new appsync.ElasticsearchDataSource(this, 'MyElasticsearchDataSource', {
  api: graphQLApiRef,
  domain: domain,

  // the properties below are optional
  description: 'description',
  metricsConfig: appsync.DataSourceMetricsConfig.ENABLED,
  name: 'name',
  serviceRole: role,
});

Initializer

new ElasticsearchDataSource(scope: Construct, id: string, props: ElasticsearchDataSourceProps)

⚠️ Deprecated: - use OpenSearchDataSource

Parameters

• scope Construct
• id string
• props ElasticsearchDataSourceProps

Construct Props

Name	Type	Description
api⚠️	IGraphQLApiRef	The API to attach this data source to.
domain⚠️	IDomain	The elasticsearch domain containing the endpoint for the data source.
description?⚠️	string	the description of the data source.
metricsConfig?⚠️	DataSourceMetricsConfig	Whether to enable enhanced metrics of the data source Value will be ignored, if enhancedMetricsConfig.dataSourceLevelMetricsBehavior on AppSync GraphqlApi construct is set to FULL_REQUEST_DATA_SOURCE_METRICS.
name?⚠️	string	The name of the data source.
serviceRole?⚠️	IRole	The IAM service role to be assumed by AppSync to interact with the data source.

---

api⚠️

⚠️ Deprecated: - use OpenSearchDataSourceProps with OpenSearchDataSource

Type: IGraphQLApiRef

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.

---

metricsConfig?⚠️

⚠️ Deprecated: - use OpenSearchDataSourceProps with OpenSearchDataSource

Type: DataSourceMetricsConfig (optional, default: no metrics configuration)

Whether to enable enhanced metrics of the data source Value will be ignored, if enhancedMetricsConfig.dataSourceLevelMetricsBehavior on AppSync GraphqlApi construct is set to FULL_REQUEST_DATA_SOURCE_METRICS.

---

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.

Properties

Name	Type	Description
ds⚠️	CfnDataSource	the underlying CFN data source resource.
grantPrincipal⚠️	IPrincipal	the principal of the data source to be IGrantable.
name⚠️	string	the name of the data source.
node⚠️	Node	The tree node.

---

ds⚠️

⚠️ Deprecated: - use OpenSearchDataSource

Type: CfnDataSource

the underlying CFN data source resource.

---

grantPrincipal⚠️

⚠️ Deprecated: - use OpenSearchDataSource

Type: IPrincipal

the principal of the data source to be IGrantable.

---

name⚠️

⚠️ Deprecated: - use OpenSearchDataSource

Type: string

the name of the data source.

---

node⚠️

⚠️ Deprecated: - use OpenSearchDataSource

Type: Node

The tree node.

Methods

Name	Description
createFunction(id, props)⚠️	creates a new appsync function for this datasource and API using the given properties.
createResolver(id, props)⚠️	creates a new resolver for this datasource and API using the given properties.
toString()⚠️	Returns a string representation of this construct.
with(...mixins)⚠️	Applies one or more mixins to this construct.

---

createFunction(id, props)⚠️

public createFunction(id: string, props: BaseAppsyncFunctionProps): AppsyncFunction

⚠️ Deprecated: - use OpenSearchDataSource

Parameters

• id string
• props BaseAppsyncFunctionProps

Returns

• AppsyncFunction

creates a new appsync function for this datasource and API using the given properties.

---

createResolver(id, props)⚠️

public createResolver(id: string, props: BaseResolverProps): Resolver

⚠️ Deprecated: - use OpenSearchDataSource

Parameters

• id string
• props BaseResolverProps

Returns

• Resolver

creates a new resolver for this datasource and API using the given properties.

---

toString()⚠️

public toString(): string

⚠️ Deprecated: - use OpenSearchDataSource

Returns

• string

Returns a string representation of this construct.

---

with(...mixins)⚠️

public with(...mixins: IMixin[]): IConstruct

⚠️ Deprecated: - use OpenSearchDataSource

Parameters

• mixins IMixin — The mixins to apply.

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.