aws-cdk-lib.aws_appsync.AuthorizationConfig

interface AuthorizationConfig

LanguageType name
.NETAmazon.CDK.AWS.AppSync.AuthorizationConfig
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappsync#AuthorizationConfig
Javasoftware.amazon.awscdk.services.appsync.AuthorizationConfig
Pythonaws_cdk.aws_appsync.AuthorizationConfig
TypeScript (source)aws-cdk-lib » aws_appsync » AuthorizationConfig

Configuration of the API authorization modes.

Example

import * as lambda from 'aws-cdk-lib/aws-lambda';
declare const authFunction: lambda.Function;

new appsync.GraphqlApi(this, 'api', {
  name: 'api',
  schema: appsync.SchemaFile.fromAsset(path.join(__dirname, 'appsync.test.graphql')),
  authorizationConfig: {
    defaultAuthorization: {
      authorizationType: appsync.AuthorizationType.LAMBDA,
      lambdaAuthorizerConfig: {
        handler: authFunction,
        // can also specify `resultsCacheTtl` and `validationRegex`.
      },
    },
  },
});

Properties

NameTypeDescription
additionalAuthorizationModes?AuthorizationMode[]Additional authorization modes.
defaultAuthorization?AuthorizationModeOptional authorization configuration.

additionalAuthorizationModes?

Type: AuthorizationMode[] (optional, default: No other modes)

Additional authorization modes.


defaultAuthorization?

Type: AuthorizationMode (optional, default: API Key authorization)

Optional authorization configuration.