AWS::AppSync::GraphQLApi

AppSync GraphQLApi

Resource Type definition for AWS::AppSync::GraphQLApi

Properties

18 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`AuthenticationType`	`string`	Required
`Name`	`string`	Required
`AdditionalAuthenticationProviders`	`Array<AdditionalAuthenticationProvider>`
`ApiType`	`string`
`EnhancedMetricsConfig`	`EnhancedMetricsConfig`
`EnvironmentVariables`	`object`
`IntrospectionConfig`	`string`
`LambdaAuthorizerConfig`	`LambdaAuthorizerConfig`
`LogConfig`	`LogConfig`
`MergedApiExecutionRoleArn`	`string`
`OpenIDConnectConfig`	`OpenIDConnectConfig`
`OwnerContact`	`string`
`QueryDepthLimit`	`integer`
`ResolverCountLimit`	`integer`
`Tags`	`Array<Tag>`
`UserPoolConfig`	`UserPoolConfig`
`Visibility`	`string`
`XrayEnabled`	`boolean`

Return Values

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

Attribute	Type	Description
`ApiId`	`string`	Unique AWS AppSync GraphQL API identifier.
`Arn`	`string`	The Amazon Resource Name (ARN) of the API key
`GraphQLDns`	`string`	The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.
`GraphQLEndpointArn`	`string`	The GraphQL endpoint ARN.
`GraphQLUrl`	`string`	The Endpoint URL of your GraphQL API.
`RealtimeDns`	`string`	The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API.
`RealtimeUrl`	`string`	The GraphQL API real-time endpoint URL.

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

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

Required IAM Permissions

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

create

appsync:CreateGraphqlApiappsync:TagResource

read

appsync:GetGraphqlApiappsync:GetGraphqlApiEnvironmentVariablesappsync:ListTagsForResource

update

appsync:GetGraphqlApiappsync:UpdateGraphqlApiappsync:TagResourceappsync:UntagResource

delete

appsync:DeleteGraphqlApi

list

appsync:ListGraphqlApis

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

Properties25

Required2

TaggingSupported

Primary IDApiId

Supported Operations

CreateReadUpdateDeleteList

Related Resources

External Links

AWS Documentation