OpenSearchDataSource

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

Bases: BackedDataSource

An Appsync datasource backed by OpenSearch.

ExampleMetadata:: infused

Example:

import aws_cdk.aws_opensearchservice as opensearch

# api: appsync.GraphqlApi


user = iam.User(self, "User")
domain = opensearch.Domain(self, "Domain",
    version=opensearch.EngineVersion.OPENSEARCH_2_3,
    removal_policy=RemovalPolicy.DESTROY,
    fine_grained_access_control=opensearch.AdvancedSecurityOptions(master_user_arn=user.user_arn),
    encryption_at_rest=opensearch.EncryptionAtRestOptions(enabled=True),
    node_to_node_encryption=True,
    enforce_https=True
)
ds = api.add_open_search_data_source("ds", domain)

ds.create_resolver("QueryGetTestsResolver",
    type_name="Query",
    field_name="getTests",
    request_mapping_template=appsync.MappingTemplate.from_string(JSON.stringify({
        "version": "2017-02-28",
        "operation": "GET",
        "path": "/id/post/_search",
        "params": {
            "headers": {},
            "query_string": {},
            "body": {"from": 0, "size": 50}
        }
    })),
    response_mapping_template=appsync.MappingTemplate.from_string("""[
            #foreach($entry in $context.result.hits.hits)
            #if( $velocityCount > 1 ) , #end
            $utils.toJson($entry.get("_source"))
            #end
          ]""")
)

Parameters:

scope (Construct)
id (str)
domain (IDomain) – The OpenSearch domain containing the endpoint for the 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
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

Methods

create_function(id, *, name, code=None, description=None, max_batch_size=None, request_mapping_template=None, response_mapping_template=None, runtime=None)

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

Parameters:

id (str)
name (str) – the name of the AppSync Function.
code (Optional[Code]) – The function code. Default: - no code is used
description (Optional[str]) – the description for this AppSync Function. Default: - no description
max_batch_size (Union[int, float, None]) – The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation. Can only be set when using LambdaDataSource. Default: - No max batch size
request_mapping_template (Optional[MappingTemplate]) – the request mapping template for the AppSync Function. Default: - no request mapping template
response_mapping_template (Optional[MappingTemplate]) – the response mapping template for the AppSync Function. Default: - no response mapping template
runtime (Optional[FunctionRuntime]) – The functions runtime. Default: - no function runtime, VTL mapping templates used

Return type:

AppsyncFunction

create_resolver(id, *, field_name, type_name, caching_config=None, code=None, max_batch_size=None, pipeline_config=None, request_mapping_template=None, response_mapping_template=None, runtime=None)

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

Parameters:

id (str)
field_name (str) – name of the GraphQL field in the given type this resolver is attached to.
type_name (str) – name of the GraphQL type this resolver is attached to.
caching_config (Union[CachingConfig, Dict[str, Any], None]) – The caching configuration for this resolver. Default: - No caching configuration
code (Optional[Code]) – The function code. Default: - no code is used
max_batch_size (Union[int, float, None]) – The maximum number of elements per batch, when using batch invoke. Default: - No max batch size
pipeline_config (Optional[Sequence[IAppsyncFunction]]) – configuration of the pipeline resolver. Default: - no pipeline resolver configuration An empty array | undefined sets resolver to be of kind, unit
request_mapping_template (Optional[MappingTemplate]) – The request mapping template for this resolver. Default: - No mapping template
response_mapping_template (Optional[MappingTemplate]) – The response mapping template for this resolver. Default: - No mapping template
runtime (Optional[FunctionRuntime]) – The functions runtime. Default: - no function runtime, VTL mapping templates used

Return type:

Resolver

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

PROPERTY_INJECTION_ID = 'aws-cdk-lib.aws-appsync.OpenSearchDataSource'

ds: the underlying CFN data source resource.

grant_principal: the principal of the data source to be IGrantable.

name: the name of the data source.

node: The tree node.

Static Methods

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.