AWS::AppSync::SourceApiAssociation

AppSync SourceApiAssociation

Resource Type definition for AWS::AppSync::SourceApiAssociation

Properties

4 configurable properties. Click a row to see details.

Filter:

Property	Type	Flags
`Description`	`string`
`MergedApiIdentifier`	`string`	Create-onlyWrite-only
`SourceApiAssociationConfig`	`SourceApiAssociationConfig`
`SourceApiIdentifier`	`string`	Create-onlyWrite-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`AssociationArn`	`string`	ARN of the SourceApiAssociation.
`AssociationId`	`string`	Id of the SourceApiAssociation.
`LastSuccessfulMergeDate`	`string`	Date of last schema successful merge.
`MergedApiArn`	`string`	ARN of the Merged API in the association.
`MergedApiId`	`string`	GraphQLApiId of the Merged API in the association.
`SourceApiArn`	`string`	ARN of the source API in the association.
`SourceApiAssociationStatus`	`string`	Current status of SourceApiAssociation.
`SourceApiAssociationStatusDetail`	`string`	Current SourceApiAssociation status details.
`SourceApiId`	`string`	GraphQLApiId of the source API in the association.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::AppSync::SourceApiAssociation

Resources:
  MyResource:
    Type: AWS::AppSync::SourceApiAssociation
    Properties:
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

appsync:AssociateSourceGraphqlApiappsync:AssociateMergedGraphqlApiappsync:GetSourceApiAssociation

read

appsync:GetSourceApiAssociationappsync:ListSourceApiAssociations

update

appsync:GetSourceApiAssociationappsync:UpdateSourceApiAssociationappsync:GetSourceApiAssociation

delete

appsync:GetSourceApiAssociationappsync:DisassociateSourceGraphqlApiappsync:DisassociateMergedGraphqlApiappsync:ListSourceApiAssociations

list

appsync:ListSourceApiAssociations

Get the AppSync Cheat Sheet

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

Download Free Infographic

Quick Facts

ServiceAppSync

Properties13

Required0

TaggingNot supported

Primary IDAssociationArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

SourceApiIdentifierMergedApiIdentifier

Related Resources

External Links

AWS Documentation