GraphqlApi
Describes a GraphQL API.
Contents
- additionalAuthenticationProviders
-
A list of additional authentication providers for the
GraphqlApiAPI.Type: Array of AdditionalAuthenticationProvider objects
Required: No
- apiId
-
The API ID.
Type: String
Required: No
- arn
-
The Amazon Resource Name (ARN).
Type: String
Required: No
- authenticationType
-
The authentication type.
Type: String
Valid Values:
API_KEY | AWS_IAM | AMAZON_COGNITO_USER_POOLS | OPENID_CONNECT | AWS_LAMBDARequired: No
- lambdaAuthorizerConfig
-
Configuration for Lambda function authorization.
Type: LambdaAuthorizerConfig object
Required: No
- logConfig
-
The Amazon CloudWatch Logs configuration.
Type: LogConfig object
Required: No
- name
-
The API name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 65536.
Pattern:
[_A-Za-z][_0-9A-Za-z]*Required: No
- openIDConnectConfig
-
The OpenID Connect configuration.
Type: OpenIDConnectConfig object
Required: No
- tags
-
The tags.
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
- uris
-
The URIs.
Type: String to string map
Required: No
- userPoolConfig
-
The Amazon Cognito user pool configuration.
Type: UserPoolConfig object
Required: No
- wafWebAclArn
-
The ARN of the AWS WAF access control list (ACL) associated with this
GraphqlApi, if one exists.Type: String
Required: No
- xrayEnabled
-
A flag indicating whether to use AWS X-Ray tracing for this
GraphqlApi.Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
