AWS::AppSync::Api

AppSync Api

Resource schema for AppSync Api

Properties

4 configurable properties. 1 required. Click a row to see details.

Filter:

Property	Type	Flags
`Name`	`string`	Required
`EventConfig`	`EventConfig`
`OwnerContact`	`string`
`Tags`	`array`

Return Values

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

Attribute	Type	Description
`ApiArn`	`string`	The Amazon Resource Name (ARN) of the AppSync Api
`ApiId`	`string`	The unique identifier for the AppSync Api generated by the service
`Dns`	`DnsMap`	-

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::Api

Resources:
  MyResource:
    Type: AWS::AppSync::Api
    Properties:
      Name: "my-name"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

appsync:CreateApiappsync:TagResourceappsync:GetApiiam:PassRole

read

appsync:GetApiappsync:ListTagsForResource

update

appsync:UpdateApiappsync:TagResourceappsync:UntagResourceappsync:GetApiiam:PassRole

delete

appsync:DeleteApiappsync:UntagResource

list

appsync:ListApis

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

Properties7

Required1

TaggingSupported

Primary IDApiArn

Supported Operations

CreateReadUpdateDeleteList

Related Resources

External Links

AWS Documentation