AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::AppSync::SourceApiAssociation

CfnSourceApiAssociation

Describes the configuration of a source API. A source API is a GraphQL API that is linked to a merged API. There can be multiple source APIs attached to each merged API. When linked to a merged API, the source API's schema, data sources, and resolvers will be combined with other linked source API data to form a new, singular API. Source APIs can originate from your account or from other accounts via Resource Access Manager.

Import

import { CfnSourceApiAssociation } from 'aws-cdk-lib/aws-appsync';

Or use the module namespace:

import * as appsync from 'aws-cdk-lib/aws-appsync';
// appsync.CfnSourceApiAssociation

Properties

Configuration passed to the constructor as CfnSourceApiAssociationProps.

descriptionOptional
string

The description field of the association configuration.

mergedApiIdentifierOptional
string

The identifier of the AppSync Merged API. This is generated by the AppSync service. In most cases, Merged APIs (especially in your account) only require the API ID value or ARN of the merged API. However, Merged APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the merged API.

sourceApiAssociationConfigOptional
IResolvable | SourceApiAssociationConfigProperty

The `SourceApiAssociationConfig` object data.

sourceApiIdentifierOptional
string

The identifier of the AppSync Source API. This is generated by the AppSync service. In most cases, source APIs (especially in your account) only require the API ID value or ARN of the source API. However, source APIs from other accounts (cross-account use cases) strictly require the full resource ARN of the source API.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::AppSync::SourceApiAssociationView in CloudFormation Explorer

Get the AWS AppSync Cheat Sheet

Everything you need to know about AWS AppSync on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-appsync
CFN TypeAWS::AppSync::SourceApiAssociation
Properties4

Related Constructs

Explore This Service

External Links