interface CfnGraphQLApiProps

Language	Type name
.NET	`Amazon.CDK.AWS.AppSync.CfnGraphQLApiProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnGraphQLApiProps`
Java	`software.amazon.awscdk.services.appsync.CfnGraphQLApiProps`
Python	`aws_cdk.aws_appsync.CfnGraphQLApiProps`
TypeScript	`aws-cdk-lib` » `aws_appsync` » `CfnGraphQLApiProps`

Properties for defining a CfnGraphQLApi.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const cfnGraphQLApiProps: appsync.CfnGraphQLApiProps = {
  authenticationType: 'authenticationType',
  name: 'name',

  // the properties below are optional
  additionalAuthenticationProviders: [{
    authenticationType: 'authenticationType',

    // the properties below are optional
    lambdaAuthorizerConfig: {
      authorizerResultTtlInSeconds: 123,
      authorizerUri: 'authorizerUri',
      identityValidationExpression: 'identityValidationExpression',
    },
    openIdConnectConfig: {
      authTtl: 123,
      clientId: 'clientId',
      iatTtl: 123,
      issuer: 'issuer',
    },
    userPoolConfig: {
      appIdClientRegex: 'appIdClientRegex',
      awsRegion: 'awsRegion',
      userPoolId: 'userPoolId',
    },
  }],
  apiType: 'apiType',
  enhancedMetricsConfig: {
    dataSourceLevelMetricsBehavior: 'dataSourceLevelMetricsBehavior',
    operationLevelMetricsConfig: 'operationLevelMetricsConfig',
    resolverLevelMetricsBehavior: 'resolverLevelMetricsBehavior',
  },
  environmentVariables: {
    environmentVariablesKey: 'environmentVariables',
  },
  introspectionConfig: 'introspectionConfig',
  lambdaAuthorizerConfig: {
    authorizerResultTtlInSeconds: 123,
    authorizerUri: 'authorizerUri',
    identityValidationExpression: 'identityValidationExpression',
  },
  logConfig: {
    cloudWatchLogsRoleArn: 'cloudWatchLogsRoleArn',
    excludeVerboseContent: false,
    fieldLogLevel: 'fieldLogLevel',
  },
  mergedApiExecutionRoleArn: 'mergedApiExecutionRoleArn',
  openIdConnectConfig: {
    authTtl: 123,
    clientId: 'clientId',
    iatTtl: 123,
    issuer: 'issuer',
  },
  ownerContact: 'ownerContact',
  queryDepthLimit: 123,
  resolverCountLimit: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  userPoolConfig: {
    appIdClientRegex: 'appIdClientRegex',
    awsRegion: 'awsRegion',
    defaultAction: 'defaultAction',
    userPoolId: 'userPoolId',
  },
  visibility: 'visibility',
  xrayEnabled: false,
};

Properties

Name	Type	Description
authenticationType	`string`	Security configuration for your GraphQL API.
name	`string`	The API name.
additionalAuthenticationProviders?	`IResolvable` `\|` `IResolvable` `\|` `AdditionalAuthenticationProviderProperty[]`	A list of additional authentication providers for the `GraphqlApi` API.
apiType?	`string`	The value that indicates whether the GraphQL API is a standard API ( `GRAPHQL` ) or merged API ( `MERGED` ).
enhancedMetricsConfig?	`IResolvable` `\|` `EnhancedMetricsConfigProperty`	Enables and controls the enhanced metrics feature.
environmentVariables?	`IResolvable` `\| { [string]: string }`	A map containing the list of resources with their properties and environment variables.
introspectionConfig?	`string`	Sets the value of the GraphQL API to enable ( `ENABLED` ) or disable ( `DISABLED` ) introspection.
lambdaAuthorizerConfig?	`IResolvable` `\|` `LambdaAuthorizerConfigProperty`	A `LambdaAuthorizerConfig` holds configuration on how to authorize AWS AppSync API access when using the `AWS_LAMBDA` authorizer mode.
logConfig?	`IResolvable` `\|` `LogConfigProperty`	The Amazon CloudWatch Logs configuration.
mergedApiExecutionRoleArn?	`string`	The AWS Identity and Access Management service role ARN for a merged API.
openIdConnectConfig?	`IResolvable` `\|` `OpenIDConnectConfigProperty`	The OpenID Connect configuration.
ownerContact?	`string`	The owner contact information for an API resource.
queryDepthLimit?	`number`	The maximum depth a query can have in a single request.
resolverCountLimit?	`number`	The maximum number of resolvers that can be invoked in a single request.
tags?	`CfnTag[]`	An arbitrary set of tags (key-value pairs) for this GraphQL API.
userPoolConfig?	`IResolvable` `\|` `UserPoolConfigProperty`	Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
visibility?	`string`	Sets the scope of the GraphQL API to public ( `GLOBAL` ) or private ( `PRIVATE` ).
xrayEnabled?	`boolean \|` `IResolvable`	A flag indicating whether to use AWS X-Ray tracing for this `GraphqlApi` .

authenticationType

Type: string

Security configuration for your GraphQL API.

For allowed values (such as API_KEY , AWS_IAM , AMAZON_COGNITO_USER_POOLS , OPENID_CONNECT , or AWS_LAMBDA ), see Security in the AWS AppSync Developer Guide .

name

Type: string

The API name.

additionalAuthenticationProviders?

Type: IResolvable | IResolvable | AdditionalAuthenticationProviderProperty[] (optional)

A list of additional authentication providers for the GraphqlApi API.

apiType?

Type: string (optional)

The value that indicates whether the GraphQL API is a standard API ( GRAPHQL ) or merged API ( MERGED ).

WARNING : If the ApiType has not been defined, explicitly setting it to GRAPHQL in a template/stack update will result in an API replacement and new DNS values.

The following values are valid:

GRAPHQL | MERGED

enhancedMetricsConfig?

Type: IResolvable | EnhancedMetricsConfigProperty (optional)

Enables and controls the enhanced metrics feature.

Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.

Enhanced metrics can be configured at the resolver, data source, and operation levels. For more information, see Monitoring and logging in the AWS AppSync User Guide .

environmentVariables?

Type: IResolvable | { [string]: string } (optional)

A map containing the list of resources with their properties and environment variables.

For more information, see Environmental variables .

Pattern : ^[A-Za-z]+\\w*$\\

Minimum : 2

Maximum : 64

introspectionConfig?

Type: string (optional)

Sets the value of the GraphQL API to enable ( ENABLED ) or disable ( DISABLED ) introspection.

If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

For more information about introspection, see GraphQL introspection .

lambdaAuthorizerConfig?

Type: IResolvable | LambdaAuthorizerConfigProperty (optional)

A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.

Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.

logConfig?

Type: IResolvable | LogConfigProperty (optional)

The Amazon CloudWatch Logs configuration.

mergedApiExecutionRoleArn?

Type: string (optional)

The AWS Identity and Access Management service role ARN for a merged API.

The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.

openIdConnectConfig?

Type: IResolvable | OpenIDConnectConfigProperty (optional)

The OpenID Connect configuration.

ownerContact?

Type: string (optional)

The owner contact information for an API resource.

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

queryDepthLimit?

Type: number (optional)

The maximum depth a query can have in a single request.

Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds. Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

resolverCountLimit?

Type: number (optional)

The maximum number of resolvers that can be invoked in a single request.

The default value is 0 (or unspecified), which will set the limit to 10000 . When specified, the limit value can be between 1 and 10000 . This field will produce a limit error if the operation falls out of bounds.

tags?

Type: CfnTag[] (optional)

An arbitrary set of tags (key-value pairs) for this GraphQL API.

userPoolConfig?

Type: IResolvable | UserPoolConfigProperty (optional)

Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.

visibility?

Type: string (optional)

Sets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ).

By default, the scope is set to Global if no value is provided.

WARNING : If Visibility has not been defined, explicitly setting it to GLOBAL in a template/stack update will result in an API replacement and new DNS values.

xrayEnabled?

Type: boolean | IResolvable (optional)

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