AWS::AppSync::Api

The AWS::AppSync::Api resource creates an AWS AppSync API that you can use for an AWS AppSync API with your preferred configuration, such as an Event API that provides real-time message publishing and message subscriptions over WebSockets.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::AppSync::Api",
  "Properties" : {
      "EventConfig" : EventConfig,
      "Name" : String,
      "OwnerContact" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::AppSync::Api
Properties:
  EventConfig: 
    EventConfig
  Name: String
  OwnerContact: String
  Tags: 
    - Tag

Properties

EventConfig

Describes the authorization configuration for connections, message publishing, message subscriptions, and logging for an Event API.

Required: No

Type: EventConfig

Update requires: No interruption

Name

The name of the Api.

Required: Yes

Type: String

Pattern: [A-Za-z0-9_\-\ ]+

Minimum: 1

Maximum: 50

Update requires: No interruption

OwnerContact

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

Required: No

Type: String

Pattern: [A-Za-z0-9_\-\ \.]+

Minimum: 1

Maximum: 250

Update requires: No interruption

Tags

A set of tags (key-value pairs) for this API.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns The Amazon Resource Name (ARN) of the AWS AppSync Api. For example:

arn:aws:appsync:us-east-1:123456789012:apis/eventapiId

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

ApiArn

The Amazon Resource Name (ARN) of the AWS AppSync Api.

ApiId

The unique identifier for the AWS AppSync Api generated by the service.

Dns.Http

The domain name of the Api's HTTP endpoint.

Dns.Realtime

The domain name of the Api's real-time endpoint.