aws-cdk-lib.aws_appsync.ElasticsearchDataSource

class ElasticsearchDataSource (construct) ⚠️

LanguageType name
.NETAmazon.CDK.AWS.AppSync.ElasticsearchDataSource
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#ElasticsearchDataSource
Javasoftware.amazon.awscdk.services.appsync.ElasticsearchDataSource
Pythonaws_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';

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

  // the properties below are optional
  description: 'description',
  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

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.

Properties

NameTypeDescription
ds⚠️CfnDataSourcethe underlying CFN data source resource.
grantPrincipal⚠️IPrincipalthe principal of the data source to be IGrantable.
name⚠️stringthe name of the data source.
node⚠️NodeThe 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

NameDescription
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.

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.