Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

2.181.1

enum AppSyncAuthorizationType

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

enum with all possible values for AppSync authorization type.

Example

import * as logs from 'aws-cdk-lib/aws-logs';

const apiKeyProvider: appsync.AppSyncAuthProvider = {
  authorizationType: appsync.AppSyncAuthorizationType.API_KEY,
};

const api = new appsync.EventApi(this, 'api', {
  apiName: 'Api',
  ownerContact: 'OwnerContact',
  authorizationConfig: {
    authProviders: [
      apiKeyProvider,
    ],
    connectionAuthModeTypes: [
      appsync.AppSyncAuthorizationType.API_KEY,
    ],
    defaultPublishAuthModeTypes: [
      appsync.AppSyncAuthorizationType.API_KEY,
    ],
    defaultSubscribeAuthModeTypes: [
      appsync.AppSyncAuthorizationType.API_KEY,
    ],
  },
  logConfig: {
    fieldLogLevel: appsync.AppSyncFieldLogLevel.INFO,
    retention: logs.RetentionDays.ONE_WEEK,
  },
});

Members

NameDescription
API_KEYAPI Key authorization type.
IAMAWS IAM authorization type.
USER_POOLCognito User Pool authorization type.
OIDCOpenID Connect authorization type.
LAMBDALambda authorization type.

API_KEY

API Key authorization type.

IAM

AWS IAM authorization type.

Can be used with Cognito Identity Pool federated credentials

USER_POOL

Cognito User Pool authorization type.

OIDC

OpenID Connect authorization type.

LAMBDA

Lambda authorization type.

← PreviousNext →