BaseDataSource¶

class aws_cdk.aws_appsync.BaseDataSource(scope, id, props, *, dynamo_db_config=None, elasticsearch_config=None, http_config=None, lambda_config=None, relational_database_config=None, type)¶

Bases: aws_cdk.core.Construct

(experimental) Abstract AppSync datasource implementation.

Do not use directly but use subclasses for concrete datasources

Stability: experimental

Example:

# api is of type GraphqlApi
# dummy_request is of type MappingTemplate
# dummy_response is of type MappingTemplate

info = appsync.ObjectType("Info",
    definition={
        "node": appsync.ResolvableField(
            return_type=appsync.GraphqlType.string(),
            args={
                "id": appsync.GraphqlType.string()
            },
            data_source=api.add_none_data_source("none"),
            request_mapping_template=dummy_request,
            response_mapping_template=dummy_response
        )
    }
)

Parameters

scope (Construct) –
id (str) –
props (BackedDataSourceProps) –
dynamo_db_config (Union[IResolvable, DynamoDBConfigProperty, None]) – (experimental) configuration for DynamoDB Datasource. Default: - No config
elasticsearch_config (Union[IResolvable, ElasticsearchConfigProperty, None]) – (experimental) configuration for Elasticsearch Datasource. Default: - No config
http_config (Union[IResolvable, HttpConfigProperty, None]) – (experimental) configuration for HTTP Datasource. Default: - No config
lambda_config (Union[IResolvable, LambdaConfigProperty, None]) – (experimental) configuration for Lambda Datasource. Default: - No config
relational_database_config (Union[IResolvable, RelationalDatabaseConfigProperty, None]) – (experimental) configuration for RDS Datasource. Default: - No config
type (str) – (experimental) the type of the AppSync datasource.

Stability

experimental

Methods

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

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

Parameters

description (Optional[str]) – (experimental) the description for this AppSync Function. Default: - no description
name (str) – (experimental) the name of the AppSync Function.
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, pipeline_config=None, request_mapping_template=None, response_mapping_template=None, type_name)¶

(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.
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
type_name (str) – (experimental) name of the GraphQL type this resolver is attached to.

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
Return type: CfnDataSource

name¶

(experimental) the name of the data source.

Stability: experimental
Return type: str

node¶

The construct tree node associated with this construct.

Return type: ConstructNode

Static Methods

classmethod is_construct(x)¶

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool