AwsAppSyncGraphQlApiDetails
Provides details about an AWS AppSync Graph QL API, which lets you query multiple databases, microservices, and APIs from a single GraphQL endpoint.
Contents
- AdditionalAuthenticationProviders
-
A list of additional authentication providers for the GraphQL API.
Type: Array of AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails objects
Required: No
- ApiId
-
The unique identifier for the API.
Type: String
Pattern:
.*\S.*Required: No
- Arn
-
The Amazon Resource Name (ARN) of the API.
Type: String
Pattern:
.*\S.*Required: No
- AuthenticationType
-
The type of security configuration for your GraphQL API: API key, AWS Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or AWS Lambda.
Type: String
Pattern:
.*\S.*Required: No
- Id
-
The unique identifier for the API.
Type: String
Pattern:
.*\S.*Required: No
- LambdaAuthorizerConfig
-
Specifies the configuration for AWS Lambda function authorization.
Type: AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails object
Required: No
- LogConfig
-
The Amazon CloudWatch Logs configuration.
Type: AwsAppSyncGraphQlApiLogConfigDetails object
Required: No
- Name
-
The API name.
Type: String
Pattern:
.*\S.*Required: No
- OpenIdConnectConfig
-
Specifies the authorization configuration for using an OpenID Connect compliant service with an AWS AppSync GraphQL API endpoint.
Type: AwsAppSyncGraphQlApiOpenIdConnectConfigDetails object
Required: No
- UserPoolConfig
-
The Amazon Cognito user pools configuration.
Type: AwsAppSyncGraphQlApiUserPoolConfigDetails object
Required: No
- WafWebAclArn
-
The Amazon Resource Name (ARN) of the AWS WAF web access control list (web ACL) associated with this GraphQL API, if one exists.
Type: String
Pattern:
.*\S.*Required: No
- XrayEnabled
-
Indicates whether to use AWS X-Ray tracing for the GraphQL 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: