An AppSync datasource backed by a DynamoDB table.

AppSyncDynamoDbDataSource

The DynamoDB table backing this data source.

table

Specify whether this Data Source is read only or has read and write permissions to the DynamoDB table.

readOnlyAccess

Use credentials of caller to access DynamoDB.

useCallerCredentials

The IAM service role to be assumed by AppSync to interact with the data source.

serviceRole

description

The name of the data source.

The only allowed pattern is: {[_A-Za-z][_0-9A-Za-z]*}.
Any invalid characters will be automatically removed.

name

An AppSync datasource backed by EventBridge.

AppSyncEventBridgeDataSource

eventBus

AppSync Functions are local functions that perform certain operations onto a backend data source.

Developers can compose operations (Functions)
and execute them in sequence with Pipeline Resolvers.

AppsyncFunction

the GraphQL Api linked to this AppSync Function.

the data source linked to this AppSync Function.

dataSource

code

the description for this AppSync Function.

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.

maxBatchSize

the request mapping template for the AppSync Function.

requestMappingTemplate

the response mapping template for the AppSync Function.

responseMappingTemplate

runtime

An AppSync datasource backed by a http endpoint.

AppSyncHttpDataSource

endpoint

The authorization config in case the HTTP endpoint requires authorization.

authorizationConfig

An AppSync datasource backed by a Lambda function.

AppSyncLambdaDataSource

The Lambda function to call to interact with this data source.

lambdaFunction

An Appsync datasource backed by OpenSearch.

AppSyncOpenSearchDataSource

The OpenSearch domain containing the endpoint for the data source.

domain

AppSyncRdsDataSource

The secret containing the credentials for the database.

secretStore

The serverless cluster to call to interact with this data source.

serverlessCluster

The name of the database to use within the cluster.

databaseName

Adds an IAM policy statement for EventPublish access to this channel namespace to an IAM principal's policy.

[disable-awslint:no-grants]

grantPublish

Adds an IAM policy statement for EventPublish and EventSubscribe access to this channel namespace to an IAM principal's policy.

[disable-awslint:no-grants]

grantPublishAndSubscribe

Adds an IAM policy statement for EventSubscribe access to this channel namespace to an IAM principal's policy.

[disable-awslint:no-grants]

grantSubscribe

ChannelNamespace

The API this channel namespace is associated with.

Authorization config for channel namespace.

channelNamespaceName

publishHandlerConfig

subscribeHandlerConfig

DynamoDbDataSource

Specify whether this DS is read only or has read and write permissions to the DynamoDB table.

use credentials of caller to access DynamoDB.

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`.

metricsConfig

An Appsync datasource backed by Elasticsearch.

ElasticsearchDataSource

The elasticsearch domain containing the endpoint for the data source.

EventApi

apiName

The domain name configuration for the Event API.

The Route 53 hosted zone and CName DNS record must be configured in addition to this setting to
enable custom domain URL

domainName

logConfig

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

ownerContact

EventBridgeDataSource

Add an environment variable to the construct.

addEnvironmentVariable

Add schema dependency to a given construct.

addSchemaDependency

GraphqlApi

Definition (schema file or source APIs) for this GraphQL Api.

definition

The domain name configuration for the GraphQL API.

The Route 53 hosted zone and CName DNS record must be configured in addition to this setting to
enable custom domain URL

Enables and controls the enhanced metrics feature.

enhancedMetricsConfig

A map containing the list of resources with their properties and environment variables.

There are a few rules you must follow when creating keys and values:
  - Keys must begin with a letter.
  - Keys must be between 2 and 64 characters long.
  - Keys can only contain letters, numbers, and the underscore character (_).
  - Values can be up to 512 characters long.
  - You can configure up to 50 key-value pairs in a GraphQL API.

environmentVariables

A value indicating whether the API to enable (ENABLED) or disable (DISABLED) introspection.

introspectionConfig

A number indicating the maximum depth resolvers should be accepted when handling queries.

Value must be withing range of 0 to 75

queryDepthLimit

A number indicating the maximum number of resolvers that should be accepted when handling queries.

Value must be withing range of 0 to 10000

resolverCountLimit

GraphQL schema definition. Specify how you want to define your schema.

SchemaFile.fromAsset(filePath: string) allows schema definition through schema.graphql file

schema

A value indicating whether the API is accessible from anywhere (GLOBAL) or can only be access from a VPC (PRIVATE).

visibility

A flag indicating whether or not X-Ray tracing is enabled for the GraphQL API.

xrayEnabled

HttpDataSource

LambdaDataSource

NoneDataSource

OpenSearchDataSource

RdsDataSource

Resolver

name of the GraphQL field in the given type this resolver is attached to.

fieldName

name of the GraphQL type this resolver is attached to.

typeName

The caching configuration for this resolver.

cachingConfig

The maximum number of elements per batch, when using batch invoke.

Whether to enable enhanced metrics Value will be ignored, if `enhancedMetricsConfig.resolverLevelMetricsBehavior` on AppSync GraphqlApi construct is set to `FULL_REQUEST_RESOLVER_METRICS`.

pipelineConfig

The request mapping template for this resolver.

The response mapping template for this resolver.

AppSync SourceApiAssociation which associates an AppSync source API to an AppSync Merged API.

The initial creation of the SourceApiAssociation merges the source API into the Merged API schema.

SourceApiAssociation

mergedApi

The merged api execution role for adding the access policy for the source api.

mergedApiExecutionRole

sourceApi

The description of the source api association.

mergeType

The `AWS::AppSync::Api` resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

CfnApi

Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.

eventConfig

A set of tags (key-value pairs) for this API.

CfnApiCache

Caching behavior.

- *FULL_REQUEST_CACHING* : All requests from the same user are cached. Individual resolvers are automatically cached. All API calls will try to return responses from the cache.
- *PER_RESOLVER_CACHING* : Individual resolvers that you specify are cached.
- *OPERATION_LEVEL_CACHING* : Full requests are cached together and returned without executing resolvers.

apiCachingBehavior

apiId

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

The cache instance type. Valid values are.

- `SMALL`
- `MEDIUM`
- `LARGE`
- `XLARGE`
- `LARGE_2X`
- `LARGE_4X`
- `LARGE_8X` (not available in all regions)
- `LARGE_12X`

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are available, but their use is discouraged:

- *T2_SMALL* : A t2.small instance type.
- *T2_MEDIUM* : A t2.medium instance type.
- *R4_LARGE* : A r4.large instance type.
- *R4_XLARGE* : A r4.xlarge instance type.
- *R4_2XLARGE* : A r4.2xlarge instance type.
- *R4_4XLARGE* : A r4.4xlarge instance type.
- *R4_8XLARGE* : A r4.8xlarge instance type.

type

*This parameter has been deprecated* .

At-rest encryption flag for cache. You cannot update this setting after creation.

atRestEncryptionEnabled

Controls how cache health metrics will be emitted to CloudWatch. Cache health metrics include:.

- *NetworkBandwidthOutAllowanceExceeded* : The network packets dropped because the throughput exceeded the aggregated bandwidth limit. This is useful for diagnosing bottlenecks in a cache configuration.
- *EngineCPUUtilization* : The CPU utilization (percentage) allocated to the Redis process. This is useful for diagnosing bottlenecks in a cache configuration.

Metrics will be recorded by API ID. You can set the value to `ENABLED` or `DISABLED` .

healthMetricsConfig

*This parameter has been deprecated* .

Transit encryption flag when connecting to cache. You cannot update this setting after creation.

transitEncryptionEnabled

The `AWS::AppSync::ApiKey` resource creates a unique key that you can distribute to clients who are executing GraphQL operations with AWS AppSync that require an API key.

CfnApiKey

Unique AWS AppSync GraphQL API ID for this API key.

The time after which the API key expires.

The date is represented as seconds since the epoch, rounded down to the nearest hour.

expires

The `AWS::AppSync::ChannelNamespace` resource creates a channel namespace associated with an `Api` .

The `ChannelNamespace` contains the definitions for code handlers for the `Api` .

CfnChannelNamespace

The name of the channel namespace.

This name must be unique within the `Api` .

The event handler functions that run custom business logic to process published events and subscribe requests.

codeHandlers

The Amazon S3 endpoint where the code is located.

codeS3Location

The configuration for the `OnPublish` and `OnSubscribe` handlers.

handlerConfigs

The authorization mode to use for publishing messages on the channel namespace.

This configuration overrides the default `Api` authorization configuration.

publishAuthModes

The authorization mode to use for subscribing to messages on the channel namespace.

This configuration overrides the default `Api` authorization configuration.

subscribeAuthModes

A set of tags (key-value pairs) for this channel namespace.

The `AWS::AppSync::DataSource` resource creates data sources for resolvers in AWS AppSync to connect to, such as Amazon DynamoDB , AWS Lambda , and Amazon OpenSearch Service .

Resolvers use these data sources to fetch data when clients make GraphQL calls.

CfnDataSource

Unique AWS AppSync GraphQL API identifier where this data source will be created.

Friendly name for you to identify your AppSync data source after creation.

The type of the data source.

- *AWS_LAMBDA* : The data source is an AWS Lambda function.
- *AMAZON_DYNAMODB* : The data source is an Amazon DynamoDB table.
- *AMAZON_ELASTICSEARCH* : The data source is an Amazon OpenSearch Service domain.
- *AMAZON_EVENTBRIDGE* : The data source is an Amazon EventBridge event bus.
- *AMAZON_OPENSEARCH_SERVICE* : The data source is an Amazon OpenSearch Service domain.
- *AMAZON_BEDROCK_RUNTIME* : The data source is the Amazon Bedrock runtime.
- *NONE* : There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.
- *HTTP* : The data source is an HTTP endpoint.
- *RELATIONAL_DATABASE* : The data source is a relational database.

AWS Region and TableName for an Amazon DynamoDB table in your account.

dynamoDbConfig

elasticsearchConfig

An EventBridge configuration that contains a valid ARN of an event bus.

eventBridgeConfig

httpConfig

An ARN of a Lambda function in valid ARN format.

This can be the ARN of a Lambda function that exists in the current account or in another account.

lambdaConfig

Enables or disables enhanced data source metrics for specified data sources.

Note that `MetricsConfig` won't be used unless the `dataSourceLevelMetricsBehavior` value is set to `PER_DATA_SOURCE_METRICS` . If the `dataSourceLevelMetricsBehavior` is set to `FULL_REQUEST_DATA_SOURCE_METRICS` instead, `MetricsConfig` will be ignored. However, you can still set its value.

`MetricsConfig` can be `ENABLED` or `DISABLED` .

AWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.

openSearchServiceConfig

Relational Database configuration of the relational database data source.

relationalDatabaseConfig

The AWS Identity and Access Management service role ARN for the data source.

The system assumes this role when accessing the data source.

Required if `Type` is specified as `AWS_LAMBDA` , `AMAZON_DYNAMODB` , `AMAZON_ELASTICSEARCH` , `AMAZON_EVENTBRIDGE` , `AMAZON_OPENSEARCH_SERVICE` , `RELATIONAL_DATABASE` , or `AMAZON_BEDROCK_RUNTIME` .

serviceRoleArn

The `AWS::AppSync::DomainName` resource creates a `DomainNameConfig` object to configure a custom domain.

CfnDomainName

The Amazon Resource Name (ARN) of the certificate.

This will be an Certificate Manager certificate.

certificateArn

A set of tags (key-value pairs) for this domain name.

The `AWS::AppSync::DomainNameApiAssociation` resource represents the mapping of your custom domain name to the assigned API URL.

CfnDomainNameApiAssociation

The `AWS::AppSync::FunctionConfiguration` resource defines the functions in GraphQL APIs to perform certain operations.

You can use pipeline resolvers to attach functions. For more information, see [Pipeline Resolvers](https://docs.aws.amazon.com/appsync/latest/devguide/pipeline-resolvers.html) in the *AWS AppSync Developer Guide* .

> When you submit an update, AWS CloudFormation updates resources based on differences between what you submit and the stack's current template. To cause this resource to be updated you must change a property value for this resource in the CloudFormation template. Changing the Amazon S3 file content without changing a property value will not result in an update operation.
>
> See [Update Behaviors of Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html) in the *AWS CloudFormation User Guide* .

CfnFunctionConfiguration

The AWS AppSync GraphQL API that you want to attach using this function.

The name of data source this function will attach.

dataSourceName

The `resolver` code that contains the request and response functions.

When code is used, the `runtime` is required. The runtime value must be `APPSYNC_JS` .

The version of the request mapping template.

Currently, only the 2018-05-29 version of the template is supported.

AWS AppSync

L2 Constructs20