aws-cdk-lib.aws_appsync.AppSyncAuthProvider

AppSyncAuthProvider Struct

Auth provider settings for AppSync Event APIs.

Source

aws-appsync/lib/auth-config.ts

Type last changed

v2.178.0 · 6 Feb 2025

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,
  },
});

api.addChannelNamespace('default');

Properties

apiKeyConfig?optionalAppSyncApiKeyConfigapi_key_config?optionalAppSyncApiKeyConfigapiKeyConfig?optionalAppSyncApiKeyConfigApiKeyConfig?optionalAppSyncApiKeyConfigApiKeyConfig?optionalAppSyncApiKeyConfig#

If authorizationType is `AuthorizationType.API_KEY`, this option can be configured.

Default: name: 'DefaultAPIKey'

authorizationTypeAppSyncAuthorizationTypeauthorization_typeAppSyncAuthorizationTypeauthorizationTypeAppSyncAuthorizationTypeAuthorizationTypeAppSyncAuthorizationTypeAuthorizationTypeAppSyncAuthorizationType= `AuthorizationType.API_KEY`required#

One of possible authorization types AppSync supports.

cognitoConfig?optionalAppSyncCognitoConfigcognito_config?optionalAppSyncCognitoConfigcognitoConfig?optionalAppSyncCognitoConfigCognitoConfig?optionalAppSyncCognitoConfigCognitoConfig?optionalAppSyncCognitoConfig= none#

If authorizationType is `AuthorizationType.USER_POOL`, this option is required.

lambdaAuthorizerConfig?optionalAppSyncLambdaAuthorizerConfiglambda_authorizer_config?optionalAppSyncLambdaAuthorizerConfiglambdaAuthorizerConfig?optionalAppSyncLambdaAuthorizerConfigLambdaAuthorizerConfig?optionalAppSyncLambdaAuthorizerConfigLambdaAuthorizerConfig?optionalAppSyncLambdaAuthorizerConfig= none#

If authorizationType is `AuthorizationType.LAMBDA`, this option is required.

openIdConnectConfig?optionalAppSyncOpenIdConnectConfigopen_id_connect_config?optionalAppSyncOpenIdConnectConfigopenIdConnectConfig?optionalAppSyncOpenIdConnectConfigOpenIdConnectConfig?optionalAppSyncOpenIdConnectConfigOpenIdConnectConfig?optionalAppSyncOpenIdConnectConfig= none#

If authorizationType is `AuthorizationType.OIDC`, this option is required.