Describes an AWS AppSync API. You can use Api 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.
Contents
- apiArn
-
The Amazon Resource Name (ARN) for the
Api.Type: String
Required: No
- apiId
-
The
ApiID.Type: String
Required: No
- created
-
The date and time that the
Apiwas created.Type: Timestamp
Required: No
- dns
-
The DNS records for the API. This will include an HTTP and a real-time endpoint.
Type: String to string map
Required: No
- eventConfig
-
The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.
Type: EventConfig object
Required: No
- name
-
The name of the
Api.Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
[A-Za-z0-9_\-\ ]+Required: No
- ownerContact
-
The owner contact information for the
ApiType: String
Length Constraints: Minimum length of 0. Maximum length of 250.
Pattern:
[A-Za-z0-9_\-\ \.]+Required: No
-
A map with keys of
TagKeyobjects and values ofTagValueobjects.Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[ a-zA-Z+-=._:/]+$Value Length Constraints: Maximum length of 256.
Value Pattern:
^[\s\w+-=\.:/@]*$Required: No
- wafWebAclArn
-
The Amazon Resource Name (ARN) of the AWS WAF web access control list (web ACL) associated with this
Api, if one exists.Type: String
Required: No
- xrayEnabled
-
A flag indicating whether to use AWS X-Ray tracing for this
Api.Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
