ElasticsearchDataSourceProps

class aws_cdk.aws_appsync.ElasticsearchDataSourceProps(*, api, description=None, name=None, service_role=None, domain)

Bases: BackedDataSourceProps

(deprecated) Properties for the Elasticsearch Data Source.

Parameters:

api (IGraphqlApi) – The API to attach this data source to.
description (Optional[str]) – the description of the data source. Default: - None
name (Optional[str]) – The name of the data source. Default: - id of data source
service_role (Optional[IRole]) – The IAM service role to be assumed by AppSync to interact with the data source. Default: - Create a new role
domain (IDomain) – (deprecated) The elasticsearch domain containing the endpoint for the data source.

Deprecated:

use OpenSearchDataSourceProps with OpenSearchDataSource

Stability:

deprecated

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appsync as appsync
from aws_cdk import aws_elasticsearch as elasticsearch
from aws_cdk import aws_iam as iam

# domain: elasticsearch.Domain
# graphql_api: appsync.GraphqlApi
# role: iam.Role

elasticsearch_data_source_props = appsync.ElasticsearchDataSourceProps(
    api=graphql_api,
    domain=domain,

    # the properties below are optional
    description="description",
    name="name",
    service_role=role
)

Attributes

api: The API to attach this data source to.

description

the description of the data source.

Default:

None

domain

(deprecated) The elasticsearch domain containing the endpoint for the data source.

Stability:: deprecated

name

The name of the data source.

Default:

id of data source

service_role

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

Default:

Create a new role