Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace GraphqlApi

Describes a GraphQL API.

Index

Properties

Optional additionalAuthenticationProviders

additionalAuthenticationProviders: AdditionalAuthenticationProvider[]

A list of additional authentication providers for the GraphqlApi API.

Optional apiId

apiId: undefined | string

The API ID.

Optional arn

arn: undefined | string

The Amazon Resource Name (ARN).

Optional authenticationType

authenticationType: AuthenticationType | string

The authentication type.

Optional lambdaAuthorizerConfig

lambdaAuthorizerConfig: LambdaAuthorizerConfig

Configuration for Lambda function authorization.

Optional logConfig

logConfig: LogConfig

The Amazon CloudWatch Logs configuration.

Optional name

name: undefined | string

The API name.

Optional openIDConnectConfig

openIDConnectConfig: OpenIDConnectConfig

The OpenID Connect configuration.

Optional tags

tags: Record<string, string>

The tags.

Optional uris

uris: Record<string, string>

The URIs.

Optional userPoolConfig

userPoolConfig: UserPoolConfig

The Amazon Cognito user pool configuration.

Optional wafWebAclArn

wafWebAclArn: undefined | string

The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.

Optional xrayEnabled

xrayEnabled: undefined | false | true

A flag indicating whether to use X-Ray tracing for this GraphqlApi.