Skip to main content

@swamp/aws/appsync

v2026.04.23.3

AWS APPSYNC infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

awsappsynccloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/appsync

@swamp/aws/appsync/apiv2026.04.23.2api.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
NamestringThe name of the AppSync API.
OwnerContact?stringThe owner contact information for an API resource.
EventConfig?objectThe configuration for an Event Api
Tags?arrayAn arbitrary set of tags (key-value pairs) for this AppSync API.
createCreate a AppSync Api
getGet a AppSync Api
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync Api
updateUpdate a AppSync Api
deleteDelete a AppSync Api
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync Api
syncSync AppSync Api state from AWS

Resources

state(infinite)— AppSync Api resource state
@swamp/aws/appsync/channel-namespacev2026.04.23.2channel_namespace.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ApiIdstringAppSync Api Id that this Channel Namespace belongs to.
NamestringNamespace indentifier.
SubscribeAuthModes?arrayList of AuthModes supported for Subscribe operations.
PublishAuthModes?arrayList of AuthModes supported for Publish operations.
CodeHandlers?stringString of APPSYNC_JS code to be used by the handlers.
CodeS3Location?stringThe Amazon S3 endpoint where the code is located.
Tags?arrayAn arbitrary set of tags (key-value pairs) for this AppSync API.
HandlerConfigs?object
createCreate a AppSync ChannelNamespace
getGet a AppSync ChannelNamespace
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync ChannelNamespace
updateUpdate a AppSync ChannelNamespace
deleteDelete a AppSync ChannelNamespace
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync ChannelNamespace
syncSync AppSync ChannelNamespace state from AWS

Resources

state(infinite)— AppSync ChannelNamespace resource state
@swamp/aws/appsync/data-sourcev2026.04.23.2data_source.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ApiIdstringUnique AWS AppSync GraphQL API identifier where this data source will be created.
Description?stringThe description of the data source.
DynamoDBConfig?objectAWS Region and TableName for an Amazon DynamoDB table in your account.
ElasticsearchConfig?objectAWS Region and Endpoints for an Amazon OpenSearch Service domain in your account. As of September 2021, Amazon Elasticsearch Service is Amazon OpenSearch Service. This property is deprecated. For new data sources, use OpenSearchServiceConfig to specify an OpenSearch Service data source.
EventBridgeConfig?objectARN for the EventBridge bus.
HttpConfig?objectEndpoints for an HTTP data source.
LambdaConfig?objectAn 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.
NamestringFriendly name for you to identify your AppSync data source after creation.
OpenSearchServiceConfig?objectAWS Region and Endpoints for an Amazon OpenSearch Service domain in your account.
RelationalDatabaseConfig?objectRelational Database configuration of the relational database data source.
ServiceRoleArn?stringThe AWS Identity and Access Management service role ARN for the data source. The system assumes this role when accessing the data source.
TypestringThe type of the data source.
MetricsConfig?enum
createCreate a AppSync DataSource
getGet a AppSync DataSource
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync DataSource
updateUpdate a AppSync DataSource
deleteDelete a AppSync DataSource
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync DataSource
syncSync AppSync DataSource state from AWS

Resources

state(infinite)— AppSync DataSource resource state
@swamp/aws/appsync/domain-namev2026.04.23.2domain_name.ts

Global Arguments

ArgumentTypeDescription
DomainNamestring
Description?string
CertificateArnstring
Tags?arrayAn arbitrary set of tags (key-value pairs) for this Domain Name.
createCreate a AppSync DomainName
getGet a AppSync DomainName
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync DomainName
updateUpdate a AppSync DomainName
deleteDelete a AppSync DomainName
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync DomainName
syncSync AppSync DomainName state from AWS

Resources

state(infinite)— AppSync DomainName resource state
@swamp/aws/appsync/domain-name-api-associationv2026.04.23.2domain_name_api_association.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
DomainNamestring
ApiIdstring
createCreate a AppSync DomainNameApiAssociation
getGet a AppSync DomainNameApiAssociation
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync DomainNameApiAssociation
updateUpdate a AppSync DomainNameApiAssociation
deleteDelete a AppSync DomainNameApiAssociation
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync DomainNameApiAssociation
syncSync AppSync DomainNameApiAssociation state from AWS

Resources

state(infinite)— AppSync DomainNameApiAssociation resource state
@swamp/aws/appsync/function-configurationv2026.04.23.2function_configuration.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ApiIdstringThe AWS AppSync GraphQL API that you want to attach using this function.
Code?stringThe resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
CodeS3Location?stringThe Amazon S3 endpoint (where the code is located??).
DataSourceNamestringThe name of data source this function will attach.
Description?stringThe function description.
FunctionVersion?stringThe version of the request mapping template. Currently, only the 2018-05-29 version of the template is supported.
MaxBatchSize?numberThe maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.
NamestringThe name of the function.
RequestMappingTemplate?stringThe Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
RequestMappingTemplateS3Location?stringDescribes a Sync configuration for a resolver. Contains information on which Conflict Detection, as well as Resolution strategy, should be performed when the resolver is invoked.
ResponseMappingTemplate?stringThe Function response mapping template.
ResponseMappingTemplateS3Location?stringThe location of a response mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.
Runtime?objectDescribes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
SyncConfig?objectDescribes a Sync configuration for a resolver. Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
createCreate a AppSync FunctionConfiguration
getGet a AppSync FunctionConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync FunctionConfiguration
updateUpdate a AppSync FunctionConfiguration
deleteDelete a AppSync FunctionConfiguration
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync FunctionConfiguration
syncSync AppSync FunctionConfiguration state from AWS

Resources

state(infinite)— AppSync FunctionConfiguration resource state
@swamp/aws/appsync/graph-qlapiv2026.04.23.2graph_qlapi.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AdditionalAuthenticationProviders?arrayA list of additional authentication providers for the GraphqlApi API.
ApiType?stringThe value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).
AuthenticationTypestringSecurity configuration for your GraphQL API
EnhancedMetricsConfig?objectEnables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.
EnvironmentVariables?recordA map containing the list of resources with their properties and environment variables.
IntrospectionConfig?stringSets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.
LambdaAuthorizerConfig?objectA LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.
LogConfig?objectThe Amazon CloudWatch Logs configuration.
MergedApiExecutionRoleArn?stringThe AWS Identity and Access Management service role ARN for a merged API.
NamestringThe API name
OpenIDConnectConfig?objectThe OpenID Connect configuration.
OwnerContact?stringThe owner contact information for an API resource.
QueryDepthLimit?numberThe maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query.
ResolverCountLimit?numberThe maximum number of resolvers that can be invoked in a single request.
Tags?arrayAn arbitrary set of tags (key-value pairs) for this GraphQL API.
UserPoolConfig?objectOptional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
Visibility?stringSets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE). By default, the scope is set to Global if no value is provided.
XrayEnabled?booleanA flag indicating whether to use AWS X-Ray tracing for this GraphqlApi.
createCreate a AppSync GraphQLApi
getGet a AppSync GraphQLApi
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync GraphQLApi
updateUpdate a AppSync GraphQLApi
deleteDelete a AppSync GraphQLApi
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync GraphQLApi
syncSync AppSync GraphQLApi state from AWS

Resources

state(infinite)— AppSync GraphQLApi resource state
@swamp/aws/appsync/resolverv2026.04.23.2resolver.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ApiIdstringThe APSYlong GraphQL API to which you want to attach this resolver.
CachingConfig?objectThe caching configuration for the resolver.
Code?stringThe resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
CodeS3Location?stringThe Amazon S3 endpoint.
DataSourceName?stringThe resolver data source name.
FieldNamestringThe GraphQL field on a type that invokes the resolver.
Kind?stringThe resolver type. *UNIT*: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source. *PIPELINE*: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
MaxBatchSize?numberThe maximum number of resolver request inputs that will be sent to a single LAMlong function in a BatchInvoke operation.
PipelineConfig?objectFunctions linked with the pipeline resolver.
RequestMappingTemplate?stringThe request mapping template. Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.
RequestMappingTemplateS3Location?stringThe location of a request mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.
ResponseMappingTemplate?stringThe response mapping template.
ResponseMappingTemplateS3Location?stringThe location of a response mapping template in an S3 bucket. Use this if you want to provision with a template file in S3 rather than embedding it in your CFNshort template.
Runtime?objectDescribes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
SyncConfig?objectThe SyncConfig for a resolver attached to a versioned data source.
TypeNamestringThe GraphQL type that invokes this resolver.
MetricsConfig?enumEnables or disables enhanced resolver metrics for specified resolvers. Note that MetricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, MetricsConfig will be ignored. However, you can still set its value.
createCreate a AppSync Resolver
getGet a AppSync Resolver
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync Resolver
updateUpdate a AppSync Resolver
deleteDelete a AppSync Resolver
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync Resolver
syncSync AppSync Resolver state from AWS

Resources

state(infinite)— AppSync Resolver resource state
@swamp/aws/appsync/source-api-associationv2026.04.23.2source_api_association.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
SourceApiIdentifier?stringIdentifier of the Source GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
MergedApiIdentifier?stringIdentifier of the Merged GraphQLApi to associate. It could be either GraphQLApi ApiId or ARN
Description?stringDescription of the SourceApiAssociation.
createCreate a AppSync SourceApiAssociation
getGet a AppSync SourceApiAssociation
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync SourceApiAssociation
updateUpdate a AppSync SourceApiAssociation
deleteDelete a AppSync SourceApiAssociation
ArgumentTypeDescription
identifierstringThe primary identifier of the AppSync SourceApiAssociation
syncSync AppSync SourceApiAssociation state from AWS

Resources

state(infinite)— AppSync SourceApiAssociation resource state