AWS::AppSync::Type

AppSync Type

Represents a GraphQL type in an AWS AppSync GraphQL API.

Properties

3 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
ApiId
string
RequiredCreate-only
Definition
string
Required
Format
string
Required

Return Values

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

AttributeTypeDescription
ArnstringThe Amazon Resource Name (ARN) of the type.
NamestringThe type name.

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

Resources:
  MyResource:
    Type: AWS::AppSync::Type
    Properties:
      ApiId: "my-apiid"
      Definition: "value"
      Format: "SDL"

Required IAM Permissions

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

create

appsync:CreateTypeappsync:GetType

read

appsync:GetType

update

appsync:UpdateTypeappsync:GetType

delete

appsync:DeleteTypeappsync:GetType

list

appsync:ListTypes

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
Properties5
Required3
TaggingNot supported
Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

ApiId

Related Resources

External Links