class NoneDataSource (construct)

Language	Type name
.NET	Amazon.CDK.AWS.AppSync.NoneDataSource
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#NoneDataSource
Java	software.amazon.awscdk.services.appsync.NoneDataSource
Python	aws_cdk.aws_appsync.NoneDataSource
TypeScript (source)	aws-cdk-lib » aws_appsync » NoneDataSource

Implements IConstruct, IDependable

An AppSync dummy datasource.

Example

const schema = new appsync.SchemaFile({ filePath: 'mySchemaFile' })
const api = new appsync.GraphqlApi(this, 'api', {
  name: 'myApi',
  definition: appsync.Definition.fromSchema(schema),
  enhancedMetricsConfig: {
    dataSourceLevelMetricsBehavior: appsync.DataSourceLevelMetricsBehavior.PER_DATA_SOURCE_METRICS,
    operationLevelMetricsConfig: appsync.OperationLevelMetricsConfig.ENABLED,
    resolverLevelMetricsBehavior: appsync.ResolverLevelMetricsBehavior.PER_RESOLVER_METRICS,
  },
});

const noneDS = api.addNoneDataSource('none', {
  metricsConfig: appsync.DataSourceMetricsConfig.ENABLED,
});

noneDS.createResolver('noneResolver', {
  typeName: 'Mutation',
  fieldName: 'addDemoMetricsConfig',
  metricsConfig: appsync.ResolverMetricsConfig.ENABLED,
});

Initializer

new NoneDataSource(scope: Construct, id: string, props: NoneDataSourceProps)

Parameters

• scope Construct
• id string
• props NoneDataSourceProps

Construct Props

Name	Type	Description
api	IGraphQLApiRef	The API to attach this data source to.
description?	string	the description of the data source.
metricsConfig?	DataSourceMetricsConfig	Whether to enable enhanced metrics of the data source Value will be ignored, if enhancedMetricsConfig.dataSourceLevelMetricsBehavior on AppSync GraphqlApi construct is set to FULL_REQUEST_DATA_SOURCE_METRICS.
name?	string	The name of the data source.

---

api

Type: IGraphQLApiRef

The API to attach this data source to.

---

description?

Type: string (optional, default: None)

the description of the data source.

---

metricsConfig?

Type: DataSourceMetricsConfig (optional, default: no metrics configuration)

Whether to enable enhanced metrics of the data source Value will be ignored, if enhancedMetricsConfig.dataSourceLevelMetricsBehavior on AppSync GraphqlApi construct is set to FULL_REQUEST_DATA_SOURCE_METRICS.

---

name?

Type: string (optional, default: id of data source)

The name of the data source.

Properties

Name	Type	Description
ds	CfnDataSource	the underlying CFN data source resource.
name	string	the name of the data source.
node	Node	The tree node.

---

ds

Type: CfnDataSource

the underlying CFN data source resource.

---

name

Type: string

the name of the data source.

---

node

Type: Node

The tree node.

Methods

Name	Description
createFunction(id, props)	creates a new appsync function for this datasource and API using the given properties.
createResolver(id, props)	creates a new resolver for this datasource and API using the given properties.
toString()	Returns a string representation of this construct.
with(...mixins)	Applies one or more mixins to this construct.

---

createFunction(id, props)

public createFunction(id: string, props: BaseAppsyncFunctionProps): AppsyncFunction

Parameters

• id string
• props BaseAppsyncFunctionProps

Returns

• AppsyncFunction

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

---

createResolver(id, props)

public createResolver(id: string, props: BaseResolverProps): Resolver

Parameters

• id string
• props BaseResolverProps

Returns

• Resolver

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

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

with(...mixins)

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin — The mixins to apply.

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.