Show / Hide Table of Contents

Class BaseDataSource

Abstract AppSync datasource implementation.

Inheritance
object
BaseDataSource
BackedDataSource
NoneDataSource
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public abstract class BaseDataSource : Construct
Syntax (vb)
Public MustInherit Class BaseDataSource Inherits Construct
Remarks

Do not use directly but use subclasses for concrete datasources

ExampleMetadata: infused

Examples
GraphqlApi api;
             AppsyncFunction appsyncFunction;


             var pipelineResolver = new Resolver(this, "pipeline", new ResolverProps {
                 Api = api,
                 DataSource = api.AddNoneDataSource("none"),
                 TypeName = "typeName",
                 FieldName = "fieldName",
                 RequestMappingTemplate = MappingTemplate.FromFile("beforeRequest.vtl"),
                 PipelineConfig = new [] { appsyncFunction },
                 ResponseMappingTemplate = MappingTemplate.FromFile("afterResponse.vtl")
             });

Synopsis

Constructors

BaseDataSource(Construct, string, IBackedDataSourceProps, IExtendedDataSourceProps)

Abstract AppSync datasource implementation.

Properties

Api

The API this data source is attached to Set the API this data source is attached to.

Ds

the underlying CFN data source resource.

Name

the name of the data source.

ServiceRole

Abstract AppSync datasource implementation.

Methods

CreateFunction(string, IBaseAppsyncFunctionProps)

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

CreateResolver(string, IBaseResolverProps)

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

Constructors

BaseDataSource(Construct, string, IBackedDataSourceProps, IExtendedDataSourceProps)

Abstract AppSync datasource implementation.

protected BaseDataSource(Construct scope, string id, IBackedDataSourceProps props, IExtendedDataSourceProps extended)
Parameters
scope Construct
id string
props IBackedDataSourceProps
extended IExtendedDataSourceProps
Remarks

Do not use directly but use subclasses for concrete datasources

ExampleMetadata: infused

Examples
GraphqlApi api;
             AppsyncFunction appsyncFunction;


             var pipelineResolver = new Resolver(this, "pipeline", new ResolverProps {
                 Api = api,
                 DataSource = api.AddNoneDataSource("none"),
                 TypeName = "typeName",
                 FieldName = "fieldName",
                 RequestMappingTemplate = MappingTemplate.FromFile("beforeRequest.vtl"),
                 PipelineConfig = new [] { appsyncFunction },
                 ResponseMappingTemplate = MappingTemplate.FromFile("afterResponse.vtl")
             });

Properties

Api

The API this data source is attached to Set the API this data source is attached to.

protected virtual IGraphqlApi Api { get; set; }
Property Value

IGraphqlApi

Remarks

Do not use directly but use subclasses for concrete datasources

ExampleMetadata: infused

Ds

the underlying CFN data source resource.

public virtual CfnDataSource Ds { get; }
Property Value

CfnDataSource

Remarks

Do not use directly but use subclasses for concrete datasources

ExampleMetadata: infused

Name

the name of the data source.

public virtual string Name { get; }
Property Value

string

Remarks

Do not use directly but use subclasses for concrete datasources

ExampleMetadata: infused

ServiceRole

Abstract AppSync datasource implementation.

protected virtual IRole? ServiceRole { get; set; }
Property Value

IRole

Remarks

Do not use directly but use subclasses for concrete datasources

ExampleMetadata: infused

Examples
GraphqlApi api;
             AppsyncFunction appsyncFunction;


             var pipelineResolver = new Resolver(this, "pipeline", new ResolverProps {
                 Api = api,
                 DataSource = api.AddNoneDataSource("none"),
                 TypeName = "typeName",
                 FieldName = "fieldName",
                 RequestMappingTemplate = MappingTemplate.FromFile("beforeRequest.vtl"),
                 PipelineConfig = new [] { appsyncFunction },
                 ResponseMappingTemplate = MappingTemplate.FromFile("afterResponse.vtl")
             });

Methods

CreateFunction(string, IBaseAppsyncFunctionProps)

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

public virtual AppsyncFunction CreateFunction(string id, IBaseAppsyncFunctionProps props)
Parameters
id string
props IBaseAppsyncFunctionProps
Returns

AppsyncFunction

Remarks

Do not use directly but use subclasses for concrete datasources

ExampleMetadata: infused

CreateResolver(string, IBaseResolverProps)

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

public virtual Resolver CreateResolver(string id, IBaseResolverProps props)
Parameters
id string
props IBaseResolverProps
Returns

Resolver

Remarks

Do not use directly but use subclasses for concrete datasources

ExampleMetadata: infused

Back to top Generated by DocFX