LambdaDataSource

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

Bases: BackedDataSource

(experimental) An AppSync datasource backed by a Lambda function.

Stability:: experimental
ExampleMetadata:: fixture=_generated

Example:

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

# function_: lambda.Function
# graphql_api: appsync.GraphqlApi
# role: iam.Role

lambda_data_source = appsync.LambdaDataSource(self, "MyLambdaDataSource",
    api=graphql_api,
    lambda_function=function_,

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

Parameters:

scope (Construct)
id (str)
lambda_function (IFunction) – (experimental) The Lambda function to call to interact with this data source.
service_role (Optional[IRole]) – (experimental) The IAM service role to be assumed by AppSync to interact with the data source. Default: - Create a new role
api (IGraphqlApi) – (experimental) The API to attach this data source to.
description (Optional[str]) – (experimental) the description of the data source. Default: - None
name (Optional[str]) – (experimental) The name of the data source. Default: - id of data source

Stability:

experimental

Methods

create_function(*, name, description=None, request_mapping_template=None, response_mapping_template=None)

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

Parameters:

name (str) – (experimental) the name of the AppSync Function.
description (Optional[str]) – (experimental) the description for this AppSync Function. Default: - no description
request_mapping_template (Optional[MappingTemplate]) – (experimental) the request mapping template for the AppSync Function. Default: - no request mapping template
response_mapping_template (Optional[MappingTemplate]) – (experimental) the response mapping template for the AppSync Function. Default: - no response mapping template

Stability:

experimental

Return type:

AppsyncFunction

create_resolver(*, field_name, type_name, caching_config=None, pipeline_config=None, request_mapping_template=None, response_mapping_template=None)

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

Parameters:

field_name (str) – (experimental) name of the GraphQL field in the given type this resolver is attached to.
type_name (str) – (experimental) name of the GraphQL type this resolver is attached to.
caching_config (Union[CachingConfig, Dict[str, Any], None]) – (experimental) The caching configuration for this resolver. Default: - No caching configuration
pipeline_config (Optional[Sequence[IAppsyncFunction]]) – (experimental) 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]) – (experimental) The request mapping template for this resolver. Default: - No mapping template
response_mapping_template (Optional[MappingTemplate]) – (experimental) The response mapping template for this resolver. Default: - No mapping template

Stability:

experimental

Return type:

Resolver

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

ds

(experimental) the underlying CFN data source resource.

Stability:: experimental

grant_principal

(experimental) the principal of the data source to be IGrantable.

Stability:: experimental

name

(experimental) the name of the data source.

Stability:: experimental

node: The construct tree node associated with this construct.

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:: x (Any)
Return type:: bool